OverviewExamples
table Paragraph.GetProperties ( |
Returns a table containing the properties of a paragraph object.
(string) The name of the paragraph object.
(table) A table containing the paragraph object's properties, indexed by the following keys:
KEY |
TYPE |
DESCRIPTION |
|||||||||||||||||||||||||||||||||||||||||||||
Text |
string |
The text displayed in the paragraph object. |
|||||||||||||||||||||||||||||||||||||||||||||
ObjectName |
string |
The name of the paragraph object. |
|||||||||||||||||||||||||||||||||||||||||||||
FontName |
string |
The font name. |
|||||||||||||||||||||||||||||||||||||||||||||
FontSize |
number |
The font size (in points). |
|||||||||||||||||||||||||||||||||||||||||||||
FontStrikeout |
boolean |
True if the font is set to strikeout, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
FontUnderline |
boolean |
True if the font is set to underline, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
FontAntiAlias |
boolean |
True if the font is set to anti alias, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
FontItalic |
boolean |
True if the font is set to italic, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
FontWeight |
number |
The weight of the font (how 'dark' the text will appear):
|
|||||||||||||||||||||||||||||||||||||||||||||
FontScript |
number |
The character set in use by the paragraph object:
|
|||||||||||||||||||||||||||||||||||||||||||||
BGStyle |
number |
The style of the paragraph object's background:
|
|||||||||||||||||||||||||||||||||||||||||||||
BGColor |
number |
The color of the paragraph object's background, if BGStyle is set to BG_SOLID. |
|||||||||||||||||||||||||||||||||||||||||||||
BorderStyle |
number |
The style of the paragraph object's border:
|
|||||||||||||||||||||||||||||||||||||||||||||
BorderColor |
number |
The color of the paragraph object's border, if BorderStyle is set to BORDER_SOLID. |
|||||||||||||||||||||||||||||||||||||||||||||
ScrollStyle |
number |
The style of scrollbars used by the paragraph object:
|
|||||||||||||||||||||||||||||||||||||||||||||
SkinFile |
string |
Path to the image file used for custom scrollbars if ScrollStyle is set to SCROLL_CUSTOM. |
|||||||||||||||||||||||||||||||||||||||||||||
ScrollHorizontal |
number |
How the horizontal scroll option will function:
|
|||||||||||||||||||||||||||||||||||||||||||||
ScrollVertical |
number |
How the vertical scroll option will function:
|
|||||||||||||||||||||||||||||||||||||||||||||
Alignment |
number |
The text alignment:
|
|||||||||||||||||||||||||||||||||||||||||||||
ColorNormal |
number |
The 'normal' color of the paragraph object's text. |
|||||||||||||||||||||||||||||||||||||||||||||
ColorHighlight |
number |
The 'highlight' color of the paragraph object's text. |
|||||||||||||||||||||||||||||||||||||||||||||
ColorDisabled |
number |
The 'disabled' color of the paragraph object's text. |
|||||||||||||||||||||||||||||||||||||||||||||
ColorDown |
number |
The 'down' color of the paragraph object's text. |
|||||||||||||||||||||||||||||||||||||||||||||
Enabled |
boolean |
True if the paragraph object is enabled, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
Visible |
boolean |
True if the paragraph object is visible, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
X |
number |
The horizontal position (in pixels) of the top left corner of the paragraph object in relation to the current page or dialog. Note: The top left corner of the current page or dialog has an X value of 0 |
|||||||||||||||||||||||||||||||||||||||||||||
Y |
number |
The vertical position (in pixels) of the top left corner of the paragraph object in relation to the current page or dialog. Note: The top left corner of the current page or dialog has a Y value of 0 |
|||||||||||||||||||||||||||||||||||||||||||||
Width |
number |
The width (in pixels) of the paragraph object. |
|||||||||||||||||||||||||||||||||||||||||||||
Height |
number |
The height (in pixels) of the paragraph object. |
|||||||||||||||||||||||||||||||||||||||||||||
TooltipText |
string |
The mouseover tooltip of the paragraph object. |
|||||||||||||||||||||||||||||||||||||||||||||
Cursor |
number |
The mouse cursor that will be displayed when the mouse is over the paragraph object:
|
|||||||||||||||||||||||||||||||||||||||||||||
ResizeLeft |
boolean |
True if the left side of the object will move when the application is resized, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
ResizeRight |
boolean |
True if the right side of the object will move when the application is resized, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
ResizeTop |
boolean |
True if the top of the object will move when the application is resized, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
ResizeBottom |
boolean |
True if the bottom of the object will move when the application is resized, false if it is not. |
|||||||||||||||||||||||||||||||||||||||||||||
HighlightSound |
number |
The type of sound that will be played when the mouse moves over the paragraph object.
|
|||||||||||||||||||||||||||||||||||||||||||||
HighlightSoundFile |
string |
The path to the paragraph object's custom highlight sound file. If the paragraph object does not use a custom sound, this value will be an empty string (""). |
|||||||||||||||||||||||||||||||||||||||||||||
ClickSound |
number |
The type of sound that will be played when the mouse clicks the paragraph object.
|
|||||||||||||||||||||||||||||||||||||||||||||
ClickSoundFile |
string |
The path to the paragraph object's custom click sound file. If the paragraph object does not use a custom sound, this value will be an empty string (""). |
If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.
When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.
See also: Related Actions