OverviewExamples
RichText.SetProperties ( |
Sets the properties of a richtext object on the page or dialog.
(string) The name of the richtext object.
(table) A table containing the properties you want to modify in the richtext object, indexed by the following items.
KEY |
TYPE |
DESCRIPTION |
|||||||||
Text |
string |
The text to display in the richtext object. Note: This value will be overridden by any value defined in the RawRTF table item. |
|||||||||
RawRTF |
string |
The raw RTF text to set in the richtext object (this includes the internal formatting.) Note: This value will override any value defined in the Text table item. |
|||||||||
VScrollbar |
boolean |
True if vertical scrollbars should be enabled, false if they should not. |
|||||||||
HScrollbar |
boolean |
True if horizontal scrollbars should be enabled, false if they should not. |
|||||||||
Transparent |
boolean |
True if the background should be transparent, false if it should not. |
|||||||||
BackgroundColor |
number |
The color to set the richtext object background. |
|||||||||
Border |
number |
The type of border surrounding the richtext object to use:
|
|||||||||
ReadOrder |
number |
How text should be displayed in the richtext object:
|
|||||||||
ReadOnly |
boolean |
True if the richtext object should be read-only, false if it should not. |
|||||||||
AutoDetectURL |
boolean |
True if URLs should be automatically detected in the object, false if they should not. |
|||||||||
ShowContextMenu |
boolean |
True if a right-click context menu should be shown, false if it should not. |
|||||||||
Enabled |
boolean |
True if the richtext object should be enabled, false if it should not. |
|||||||||
Visible |
boolean |
True if the richtext object should be visible, false if it should 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) to set for the richtext object. |
|||||||||
Height |
number |
The height (in pixels) to set for the richtext object. |
|||||||||
TooltipText |
string |
The mouseover tooltip to set for the richtext object. |
|||||||||
ResizeLeft |
boolean |
True if the left side of the object should move when the application is resized, false if it should not. |
|||||||||
ResizeRight |
boolean |
True if the right side of the object should move when the application is resized, false if it should not. |
|||||||||
ResizeTop |
boolean |
True if the top of the object should move when the application is resized, false if it should not. |
|||||||||
ResizeBottom |
boolean |
True if the bottom of the object should move when the application is resized, false if it should not. |
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions