OverviewExamples
table RichText.GetProperties ( |
Returns a table containing the properties of a richtext object.
(string) The name of the richtext object.
(table) A table containing the richtext object's properties, indexed by the following keys:
KEY |
TYPE |
DESCRIPTION |
|||||||||
ObjectName |
string |
The name of the richtext object. |
|||||||||
Text |
string |
The text displayed in the richtext object. |
|||||||||
RawRTF |
string |
The raw RTF text of the richtext object (this includes the internal formatting.) |
|||||||||
VScrollbar |
boolean |
True if vertical scrollbars are enabled, false if they are not. |
|||||||||
HScrollbar |
boolean |
True if horizontal scrollbars are enabled, false if they are not. |
|||||||||
Transparent |
boolean |
True if the background is transparent, false if it is not. |
|||||||||
BackgroundColor |
number |
The color of the richtext object background. |
|||||||||
Border |
number |
The type of border surrounding the richtext object:
|
|||||||||
ReadOrder |
number |
How text will be displayed in the richtext object:
|
|||||||||
ReadOnly |
boolean |
True if the richtext object is read-only, false if it is not. |
|||||||||
AutoDetectURL |
boolean |
True if URLs are set to be automatically detected in the object, false if they are not. |
|||||||||
ShowContextMenu |
boolean |
True if a right-click context menu is set to show, false if it is not. |
|||||||||
Enabled |
boolean |
True if the richtext object is enabled, false if it is not. |
|||||||||
Visible |
boolean |
True if the richtext object is visible, false if it is not. |
|||||||||
X |
number |
The horizontal position (in pixels) of the top left corner of the richtext 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 richtext 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 richtext object. |
|||||||||
Height |
number |
The height (in pixels) of the richtext object. |
|||||||||
TooltipText |
string |
The mouseover tooltip of the richtext 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. |
|||||||||
WindowHandle |
number |
The integer value that represents the object's window. (Commonly referred to as an hWnd.) |
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