ResultVariable
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
Paragraph.GetProperties
OverviewExamples
table Paragraph.GetProperties ( string ObjectName )
De s cr ip t ion
Returns a table containing the properties of a paragraph object.
P arame t er s
ObjectName
(string) The name of the paragraph object.
Re t u r n s
CONSTANT |
VALUE DESCRIPTION |
|
FW_DONTCARE |
0 |
Font weight not specified. |
FW_THIN |
100 |
Font weight 'thin'. |
FW_EXTRALIGHT |
200 |
Font weight 'extra-light'. |
FW_LIGHT |
300 |
Font weight 'light'. |
FW_NORMAL |
400 |
Font weight 'normal'. |
FW_MEDIUM |
500 |
Font weight 'medium'. |
FW_SEMIBOLD |
600 |
Font weight 'semi-bold'. |
FW_BOLD |
700 |
Font weight 'bold'. |
(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): |
FW_EXTRABOLD |
800 |
Font weight 'extra bold'. |
FW_HEAVY |
900 |
Font weight 'heavy'. |
FontScript |
number |
The character set in use by the paragraph object: |
||||
CONSTANT |
VALUE DESCRIPTION |
|||||
ANSI_CHARSET |
0 |
ANSI character set. |
||||
BALTIC_CHARSET |
186 |
Baltic character set. |
||||
CHINESEBIG5_CHARSET |
136 |
Chinese character set. |
||||
DEFAULT_CHARSET |
1 |
Default character set. |
||||
EASTEUROPE_CHARSET |
238 |
Eastern European character set. |
||||
GB2312_CHARSET |
134 |
GB2312 character set. |
||||
GREEK_CHARSET |
161 |
Greek character set. |
||||
HANGUL_CHARSET |
129 |
Hangul character set. |
||||
MAC_CHARSET |
77 |
MAC character set. |
||||
OEM_CHARSET |
255 |
OEM character set. |
||||
RUSSIAN_CHARSET |
204 |
Russian character set. |
||||
SHIFTJIS_CHARSET |
128 |
Shiftjis character |
||||
set. |
||||||
SYMBOL_CHARSET |
2 |
Symbol character set. |
||||
TURKISH_CHARSET |
162 |
Turkish character |
CONSTANT |
VALUE DESCRIPTION |
|
SCROLL_STANDARD |
0 |
Standard scrollbars. |
SCROLL_CUSTOM |
1 |
Custom scrollbars. |
CONSTANT |
VALUE DESCRIPTION |
|
BORDER_NONE |
0 |
No border. |
BORDER_SOLID |
1 |
Solid border. |
CONSTANT |
VALUE DESCRIPTION |
|
BG_SOLID |
0 |
Solid background. |
BG_TRANSPARENT |
1 |
Transparent Background. |
TURKISH_CHARSET 162 Turkish character set. |
||||||
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: |
||||
CONSTANT |
VALUE DESCRIPTION |
|||||
SCROLL_AUTO |
0 |
Scrollbars will enable automatically if more text |
||||
exists than can be displayed. |
||||||
SCROLL_ON |
1 |
Scrollbars are enabled regardless of the amount of 8 text within the object. |
CONSTANT |
VALUE DESCRIPTION |
|
ALIGN_LEFT |
0 |
Text is left aligned. |
ALIGN_CENTER |
1 |
Text is center aligned. |
ALIGN_RIGHT |
2 |
Text is right aligned. |
CONSTANT |
VALUE DESCRIPTION |
|
SCROLL_AUTO |
0 |
Scrollbars will enable automatically if more text exists than can be displayed. |
SCROLL_ON |
1 |
Scrollbars are enabled regardless of the amount of text within the object. |
SCROLL_OFF |
2 |
Scrollbars are not enabled, regardless of the amount of text within the object. |
SCROLL_ON |
1 |
Scrollbars are enabled regardless of the amount of text within the object. |
SCROLL_OFF |
2 |
Scrollbars are not enabled, regardless of the amount of text within the object. |
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. |
CONSTANT |
VALUE DESCRIPTION |
|
CURSOR_ARROW |
0 |
Standard mouse arrow cursor. |
CURSOR_HAND |
1 |
Hand cursor. |
CURSOR_BLACK_ARROW |
2 |
Black arrow cursor. |
CURSOR_CROSSHAIR |
3 |
Crosshair cursor. |
CURSOR_EXPLORE |
4 |
Explore cursor. |
CURSOR_HELP |
5 |
Help cursor. |
CURSOR_MAGNIFY |
6 |
Magnify cursor. |
CURSOR_MEDIA |
7 |
Media cursor. |
CURSOR_MONEY |
8 |
Money cursor. |
CURSOR_NOTEPAD |
9 |
Notepad cursor. |
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: |
CONSTANT |
VALUE DESCRIPTION |
|
SND_NONE |
0 |
No highlight sound. |
SND_STANDARD |
1 |
Standard highlight sound. |
SND_CUSTOM |
2 |
Custom highlight sound. |
CURSOR_PENCIL |
10 |
Pencil cursor. |
CURSOR_PRINTER |
11 |
Printer cursor. |
CURSOR_SPEAKER |
12 |
Speaker cursor. |
CURSOR_UP_ARROW |
13 |
Up arrow cursor. |
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. |
||||
CONSTANT |
VALUE DESCRIPTION |
|||||
SND_NONE |
0 |
No click sound. |
||||
SND_STANDARD |
1 |
Standard click sound. |
||||
SND_CUSTOM |
2 |
Custom click sound. |
SND_CUSTOM 2 Custom click sound. |
||
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.