RichTextEdit control
A RichTextEdit control contains a document that it
displays as formatted text. It can include input fields that are
linked to a DataWindow control. When a DataWindow’s data
is shared with the RichTextEdit control, there is one instance of
the document in the control that can be displayed multiple times with
different occurrences of row data. Input fields whose names match columns
in the DataWindow are filled with data from the current row.
Using with animation features
RichTextEdit controls may not paint correctly when you use
animation features.
Properties
|
RichTextEdit property |
Datatype |
Description |
|---|---|---|
|
Integer |
Specifies the ASCII value of the accelerator |
|
|
String |
A description of the control and/or |
|
|
String |
A label that briefly describes the control, |
|
|
AccessibleRole (enumerated) |
Describes what kind of user interface |
|
|
Long |
Specifies the numeric value of the background |
|
|
Boolean |
Specifies whether the control has a border.
|
|
|
BorderStyle (enumerated) |
Specifies the style of the border of
|
|
|
Long |
Specifies the width of the bottom margin |
|
|
Boolean |
Specifies whether PowerBuilder moves
|
|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing |
|
Boolean |
Specifies whether control characters
|
|
|
Boolean |
Specifies whether users can make changes
|
|
|
String |
Specifies the name that displays in the |
|
|
Boolean |
Specifies whether PowerBuilder puts the
|
|
|
String |
Specifies the name of the stock icon When the user drags the control, the icon displays when the control |
|
|
Boolean |
Specifies whether the control is enabled
|
|
|
String |
Specifies the typeface used for text |
|
|
FontCharSet (enumerated) |
Specifies the character set for text |
|
|
FontFamily (enumerated) |
Specifies the font family for text in |
|
|
FontPitch (enumerated) |
Specifies the spacing of the font used |
|
|
Boolean |
Specifies whether the RichTextEdit control
If a document has a header or footer and is opened in a control that |
|
|
Integer |
Specifies the height of the control, |
|
|
Boolean |
Specifies whether the RichTextEdit control
|
|
|
ImeMode |
Integer |
Specifies the input method editor mode. |
|
Long |
Specifies default background color for |
|
|
Boolean |
Specifies whether input field names are
|
|
|
Boolean |
Specifies whether input fields are visible.
|
|
|
Boolean |
Specifies default text formatting. Values
Maintained for forward compatibility with PowerBuilder .NET. In |
|
|
Long |
Specifies the width of the left margin |
|
|
Modified |
Boolean |
Specifies whether the document has been
When the first change is made to a newly opened or saved document, |
|
Long |
Specifies the value for the display height |
|
|
PaperOrientation(enumerated) |
Specifies the page orientation in the |
|
|
Long |
Specifies the value for the display width |
|
|
Boolean |
When the value is true, |
|
|
String |
Specifies the name of the stock pointer |
|
|
Boolean |
Specifies whether the user has access
|
|
|
Boolean |
Specifies whether the user can resize
|
|
|
Long |
Specifies the width of the right margin |
|
|
Boolean |
Specifies whether a ruler bar is visible
If the RichTextEdit pop-up menu is enabled, the user can use |
|
|
Long |
Specifies the starting position in a |
|
|
Long |
Specifies the length of text you want |
|
|
StatusBar |
Boolean |
Specifies whether a status bar is visible
If the pop-up menu is enabled, the user can use it to turn |
|
Integer |
Specifies the tab value of the control Note that because a RichTextEdit allows tabs within its content, the |
|
|
String |
Specifies the tag value assigned to the |
|
|
Integer |
Specifies the point size of text in the |
|
|
Boolean |
Specifies whether a tool bar for formatting
|
|
|
Long |
Specifies the width of the top margin |
|
|
Boolean |
Specifies default text formatting. Values
Maintained for forward compatibility with PowerBuilder .NET. In |
|
|
Boolean |
Specifies whether the control is visible:
|
|
|
Boolean |
Specifies whether the RichTextEdit control
|
|
|
Integer |
Specifies default text weight formatting |
|
|
Integer |
Specifies the width of the control, in |
|
|
Boolean |
Determines whether large blocks of text
|
|
|
Integer |
Specifies the X position (the distance |
|
|
Integer |
Specifies the Y position (the distance |
Events
|
RichTextEdit event |
Occurs |
|---|---|
|
Immediately before the Open event occurs |
|
|
Immediately after the Close event occurs |
|
|
When the user double-clicks anywhere |
|
|
When a dragged control is dropped on |
|
|
When a dragged control enters the control. |
|
|
When a dragged control leaves the control. |
|
|
When a dragged control is within the |
|
|
When the document in the RichTextEdit |
|
|
Just before the control receives focus |
|
|
When the user presses the F1 key or drags |
|
|
When the user selects an input field |
|
|
When the user presses a key. |
|
|
When the control loses focus (becomes |
|
|
When the first change is made to the In the Modified event script, you can set a flag indicating |
|
|
When the left or middle mouse button |
|
|
When the mouse has moved within the control. |
|
|
When the left or middle mouse button |
|
|
When a Windows message occurs that is |
|
|
When the user selects a picture by clicking |
|
|
When the right mouse button is pressed |
|
|
When the right mouse button is released |
Functions
|
RichTextEdit function |
Datatype returned |
Description |
|---|---|---|
|
Boolean |
Returns true if there |
|
|
String |
Returns the name assigned to the control. |
|
|
Long |
Clears selected text (if any) from the |
|
|
Long |
Clears all content from the specified |
|
|
Long |
Copies (but does not delete) the selected |
|
|
String |
Copies the selected contents of the RichTextEdit |
|
|
Long |
Cuts (deletes) the selected contents |
|
|
Integer |
Associates a DataWindow with the RichTextEdit |
|
|
Integer |
Starts or ends dragging of the control. |
|
|
Integer |
Finds text in the control. |
|
|
Integer |
Finds the next occurrence of text specified |
|
|
Alignment |
Obtains the alignment of the selected |
|
|
Integer |
Creates a reference to a context-specific |
|
|
Long |
Gets the size of the indentation, left |
|
|
PowerObject |
Returns a reference to the name of the |
|
|
Spacing |
Obtains the line spacing of the selected |
|
|
Long |
Returns the color of the selected text. |
|
|
Boolean |
Obtains font settings for the selected |
|
|
Integer |
Makes the control invisible. |
|
|
Integer |
Modifies the data value for all input |
|
|
String |
Gets the name of the selected input field. |
|
|
Integer |
Deletes the current occurrence of the |
|
|
String |
Obtains the data in the specified input |
|
|
Integer |
Inserts the named input field at the |
|
|
String |
Locates an input field. You can find |
|
|
Integer |
Inserts the named file in the RichTextEdit |
|
|
Integer |
Inserts the specified bitmap or picture |
|
|
Boolean |
Checks whether the RichTextEdit control |
|
|
Integer |
Returns the total number of lines in |
|
|
Integer |
Returns the length of the current line. |
|
|
Integer |
Moves the control to a specified location. |
|
|
Integer |
Returns the number of pages in the document. |
|
|
Integer |
Inserts the contents of the clipboard |
|
|
Long |
Inserts a string at the insertion point |
|
|
Integer |
Returns the distance of the pointer from |
|
|
Integer |
Returns the distance of the pointer from |
|
|
Integer |
Returns the position of the insertion |
|
|
Integer |
Adds the specified event to the end of |
|
|
Integer |
Flips between Preview of the document |
|
|
Integer |
Prints the contents of the control. You |
|
|
Integer |
Prints the contents of the control. You |
|
|
Integer |
Replaces selected text with given string. |
|
|
Integer |
Changes the size of the control. |
|
|
Integer |
Saves the current document in a file |
|
|
Integer |
Scrolls the RichTextEdit the specified |
|
|
Integer |
Scrolls forward to the next page in the |
|
|
Long |
Scrolls the RichTextEdit to the next |
|
|
Long |
Scrolls back to the prior page in the |
|
|
Long |
Scrolls the RichTextEdit to the prior |
|
|
Long |
Causes the control to scroll to the specified |
|
|
Integer |
Returns the number of the character column |
|
|
Long |
Returns the length of the selected text. |
|
|
Long |
Returns the number of the line in which |
|
|
Long |
Returns the number of the page in which |
|
|
Integer |
Returns the starting position of the |
|
|
String |
Returns a string containing the selected |
|
|
Long |
Selects text in the RichTextEdit control. |
|
|
Integer |
Selects all text in the control. |
|
|
Integer |
Selects all text in the line in which |
|
|
Integer |
Selects the word in which the insertion |
|
|
Integer` |
Sets the alignment for the selected paragraphs. |
|
|
Integer |
Sets focus to the RichTextEdit control. |
|
|
Integer |
Specifies the size of the paragraph’s |
|
|
Integer |
Specifies the control’s position |
|
|
Integer |
Controls automatic redrawing of the control. |
|
|
Integer |
Sets the line spacing for the selected |
|
|
Integer |
Sets the color of the selected text. |
|
|
Integer |
Sets the font properties of the selected |
|
|
Integer |
Makes the RichTextEdit control visible. |
|
|
Integer |
Allows editing of the header and footer |
|
|
String |
Returns the entire text of the line in |
|
|
Integer |
Triggers a specified event in the control |
|
|
Object |
Returns the type of the control. |
|
|
Integer |
Cancels the previous editing function |