Class XbpMLE() Foundation
Class function of the XbpMLE class.
The XbpMLE class provides objects that manage multi-line text entry fields. These are dialog elements that display text within rectangular screen areas. The "text" displayed in each entry field is a character string that may be formatted using the characters Carriage Return+Line Feed (CRLF) to include many text lines. This character string is stored in the edit buffer of the XbpMLE object. Both horizontal and vertical scroll bars are displayed to allow easy navigation through long text. The text can be edited when the XbpMLE object is in edit mode (the default setting). The current cursor position marks the point where characters input using the keyboard are inserted or overwrite existing characters.
By default, XbpMLE objects use automatic word wrap when displaying text. This means that the length of text lines is limited during display to the width of the edit window. Automatic word wrap can be turned off to allow each row of text displayed in the edit window to include the entire row delimited by the characters CRLF.
XbpMLE objects allow sections of text to be selected (marked) and copied to the clipboard. Characters from the clipboard can also be inserted into the text buffer of the XbpMLE object. The XbpMLE object processes keyboard entries as a series of independent character inputs. The keys that are used to input ASCII characters are copied into the edit buffer while other specific keys are automatically processed (such as the Insert and Delete keys). The following table lists the keys that receive special processing by the XbpMLE object along with the default action each key causes:
|Move cursor one character to the left
|Select one character to the left
|Select one word to the left
|Move one character to the right
|Select one character to the right
|Select one word to the right
|Move up one row
|Select one row up
|Move down one row
|Select one row down
|Move one page up
|Move one page to the left
|Move one page down
|Move one page to the right
|Move to beginning of current row
|Select all characters to start of current row
|Move to start of edit buffer
|Select all characters to start of edit buffer
|Move to end of current row
|Select all characters to end of current row
|Move to end of edit buffer
|Select all characters to end of edit buffer
|Delete the character to the left of cursor
|Toggle between "Insert" and "Overstrike" edit modes
|Delete selected characters and replace with characters from the clipboard
|Copy marked characters to the clipboard
|Delete the character to the right of cursor or delete selected characters without copying them to the clipboard
|Delete selected characters and copy them to the clipboard
|Copied into the edit buffer as character if :ignoreTab is set to .F.
|Other keys containing ASCII characters are copied to the edit buffer as characters
The xbeP_Keyboard event is generally generated for each keypress. This allows the default behavior of the XbpMLE object to be redefined in the :keyBoard() callback method or the callback code block.
The instance variables in this group configure system resources. If changes are made to these values, they must either be made before the :create() method is executed or the :configure() method must be used to activate the changes.
If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.