MULTI_LINE Rich Text Word Processor Control

MULTI_LINE Rich Text Properties

In addition to the MULTI_LINE Properties, the table below lists properties that are used with Rich Text Format word processor controls. See MULTI_LINE Rich Text Word Processor Control directive.

Use the links in the Property column to access the PxPlus Help page for a selected property. The Help page may provide additional details, particularly if the property can be used to define other controls.

The 'Selxxxxxx properties can be used to change the format of the current selected text, or if no text is selected, the changes affect the current text being entered.

For a complete list of all the properties available, see Properties List.

Property

Description

Auto

When set, the control will generate a 'Change' event whenever its value changes as opposed to the default Off state where the control will only generate the change event when losing focus.

Possible values are:

0	Only signal change when exiting the control or on special event such as double click/Enter. *(Default)*
1	Signal all changes to the value of the control regardless of why the change occurred.
2	Signal all changes done by the user but not done by the program.

BackColor$
BackColour$

Background color. For information on valid color names and color specifications, see Color Properties. (Default: "DEFAULT")

Border

Add border: 1 - Border; 0 - No border (Default: 1)

Note:
Applicable only when using Windows XP or Windows 7 style controls.

DisableBackColor$
DisableBackColour$

Background color when the control is disabled. For information on valid color names and color specifications, see Color Properties.

(The DisableBackColor$ property for RTF Multi-Lines was added in PxPlus 2024.)

DisableTextColor$
DisableTextColour$

Foreground text color when the control is disabled. For information on valid color names and color specifications, see Color Properties.

(The DisableTextColor$ property for RTF Multi-Lines was added in PxPlus 2024.)

EnterMode

This property is used to define how the ENTER key will be processed with the control. For the multi-line, the EnterMode property defines whether the ENTER key is to be allowed within the control or considered a TAB to exit the control.

When 0 (zero), it indicates that the ENTER key will not be considered as a TAB; thus, depending on the type of multi-line, it will signal the input complete for a 1-line field or insert a line feed on a control with multiple input lines.

(Default for Multi-line: The default setting reflects the '+E' mnemonic setting.)

Eom$

Last change terminator. See also MULTI_LINE directive.

FindText

Controls RTF word processor Find option: This property controls access to the Find text dialogue box within the RTF word processor control. When this control is set to 1, the user can press CTRL-F to initiate a find within the control. Setting the control to 0 disables CTRL-F. (Default: 1 - CTRL-F enabled)

This property also controls the F3 key for Find Next. If desired, the property can be set to 2, which will cause the Find dialogue box to be initiated under program control.

Note:
The Find logic within the system uses a common buffer for the Find string throughout the session. This means that when the Find dialog is initiated, it will default to the string last found within the same session.

Focus

Focus indicator: 1 = Control has focus (Default: 0)

FrameColor$

Color of the frame/border around the control.

(The FrameColor$ property was added in PxPlus 2024.)

Len

Input length of line.

Lock

Lock status: Possible values are:

0	Unlock *(Default)*
1	Lock
2	Lock (cell contents can be selected/copied) *(Grid Only)*
-1	Permanently locked *(Multi-Line Only)*

(The Lock status of 2 was added in PxPlus 2019.)

LockBackColor$

Background color when the control is locked. For information on valid color names and color specifications, see Color Properties.

(The LockBackColor$ property was added in PxPlus 2024.)

LockTextColor$

Foreground text color when the control is locked. For information on valid color names and color specifications, see Color Properties.

(The LockTextColor$ property was added in PxPlus 2024.)

MenuCtl

This property reports/sets the CTL value to generate when an object is selected on a right-click of the mouse.

Msg$

Message line text for the control.

OnFocusCtl

On Focus CTL event: 0 is returned if no On Focus CTL value is set up for the control.

SelAlign$

RTF word processor Alignment: This property controls the font for the currently selected text in a RTF word processor Multi_Line style control. If no text is currently selected, the current text entry will be affected. Paragraph alignment: "R"ight, "L"eft, "C"entered. (Default: The default setting is the control font.)

SelBold

RTF word processor BOLD setting: This property reflects whether the text will be bold for the currently selected text in a RTF word processor Multi_Line style control. If no text is currently selected, the current text entry will be affected. 0 if not bold, 1 if bold. (Default: The default setting is the control font.)

SelBulletno

RTF word processor bullet number setting: This property reflects the bullet number for the current text in a RTF word processor Multi_Line style control. Changing this number will change the current bullet sequence number and those following. (Default: The default setting starts at 1 and increments by 1 for each paragraph.)

SelBullets

RTF word processor bullets setting: This property reflects whether the text will be bulleted for the currently selected text in a RTF word processor Multi_Line style control. (0 = None, 1 = Yes, 2 = Numbers)

SelBulletStyle

RTF word processor bullet style setting: This property reflects the bullet style for the current text in a RTF word processor Multi_Line style control.

SelChooseFont

RTF word processor Font selector: This property controls access to the Font selection dialogue box within the RTF word processor Multi_Line style control.

When this control is set to 1, the user can press Ctrl-Shift-Insert to initiate a Font selector within the control. Setting the control to 0 disables Ctrl-Shift-Insert. If desired, the property can be set to 2, which will cause the Font selection dialogue box to be initiated under program control. (Default: The default setting is 1 - Ctrl-Shift-Insert enabled).

SelectLength

Length of selected item: This reports the number of characters currently highlighted. This allows for cut, copy and paste within a graphical user interface input region.

SelectOffset

This property indicates where the highlight begins within the data or, if nothing is highlighted, the current cursor location. This allows for cut, copy and paste within a graphical user interface input region.

SelectText$

Text contained within the highlight: This allows for cut, copy and paste within a graphical user interface input region. See Multiple Selections.

SelEmboss

RTF word processor Emboss setting: This property reflects whether the text will be Embossed for the currently selected text in a RTF word processor Multi_Line style control. If no text is currently selected, the current text entry will be affected. 0 if not Embossed, 1 if Embossed. (Default: The default setting is the control font.)

SelFont$

RTF word processor Font setting: This property reflects the Font to be used for the currently selected text in a RTF word processor Multi_Line style control. If no text is currently selected, the current text entry will be affected. (Default: The default setting comes from the control's default Font specification.)

See 'FONT' mnemonic.

Example:

To set the font to Arial, 1.5 times normal size, and Bold, the format would be xxx'Font$="Arial,1.5,B" (comma-separated).

SelFontSize

RTF word processor Font Size setting: This property reflects the Font Size to be used for the currently selected text in a RTF word processor Multi_Line style control.

SelIndent

RTF word processor Indentation setting: This property reflects the Indentation to be used for the currently selected paragraph(s) in a RTF word processor Multi_Line style control. If no paragraph is currently selected, the current text entry will be affected. (Default: 0)

The indentation is measured in TWIPS, which is 1/1440 of an inch (or 1/20th of a POINT). To create an indentation of 1/2 an inch, use 720.

SelItalic

RTF word processor Italics setting: This property reflects whether the text will be in Italics for the currently selected text in a RTF word processor Multi_Line style control. If no text is currently selected, the current text entry will be affected. 0 if not in italics, 1 if in italics. (Default: The default setting is the control font.)

SelParaUndent

RTF word processor Paragraph Undent setting: This property reflects the amount of indentation to be eliminated from the contents of the currently selected paragraph(s) in a RTF word processor Multi_Line style control. If no paragraph is currently selected, the current text entry will be affected. (Default: 0)

The Indentation is measured in TWIPS, which is 1/1440 of an inch (or 1/20th of a POINT). To create an indentation of 1/2 an inch, use 720.

The Undentation only affects the body of the paragraph that follows the first line.

Example:

If you wanted to indent the first line by 1/2 an inch yet leave the rest of the paragraph un-indented, you would set both the 'Indent and 'ParaUndent properties to 720.

SelRightIndent

RTF word processor Right Indentation setting: This property reflects the right side indentation to be used for the currently selected paragraph(s) in a RTF word processor Multi_Line style control. If no paragraph is currently selected, the current text entry will be affected. (Default: 0)

The Indentation is measured in TWIPS, which is 1/1440 of an inch (or 1/20th of a POINT). To create an indentation of 1/2 an inch, use 720.

SelStrikeOut

RTF word processor Strikeout setting: This property reflects whether the text will be "Striked Out" for the currently selected text in a RTF word processor Multi_Line style control. If no text is currently selected, the current text entry will be affected. (Default: 0 - No Strikeout)

SelTextColor$
SelTextColour$

RTF word processor Text Color setting: This property reflects the color of the text that is currently selected in a RTF word processor Multi_Line style control. If no text is currently selected, the current text entry will be affected.

For information on valid color names and color specifications, see Color Properties. (Default: The default setting is "DEFAULT" (normally BLACK)).

SelUnderline

RTF word processor Underline setting: This property reflects whether the text will be underlined for the currently selected text in a RTF word processor Multi_Line style control. If no text is currently selected, the current text entry will be affected. 0 if not underlined, 1 if underlined. (Default: The default setting is the control font.)

SignalOnExit

Controls whether a 'Change' signal will be generated when the control (or region of a grid control) is exited regardless of whether the control's value changes. Normally, controls only signal changes when the control loses focus and the contents have changed. Setting 'SignalOnExit allows a change signal to also be generated whenever focus leaves the control (or region for grid).

0	No signal on exit unless control value has changed.
1	Signal on exit regardless of whether value has changed (on grid, signals whenever changing cell).
2	Signal when changing row or on exit of grid (sets column value to 0 and row value to last row exited). (Grid Only)
3	Signal when exiting the grid (sets column and row values to zero). *(Grid Only)*

Text$

Text of item.

Note:
The 'Value$ property of a Rich Text control returns the data in RTF format, whereas the 'Text$ property will return just the text without any formatting information.

TextColor$
TextColour$

Foreground text color. For information on valid color names and color specifications, see Color Properties. (Default: "DEFAULT")

(The TextColor$ property for RTF Multi-Lines was added in PxPlus 2024.)

Tip$

Tip message for control.

Value$

Current item value.

Note:
The 'Value$ property of a Rich Text control returns the data in RTF format, whereas the 'Text$ property will return just the text without any formatting information.

MULTI_LINE Rich Text Word Processor Control

Note: Applicable only when using Windows XP or Windows 7 style controls.

Note: The Find logic within the system uses a common buffer for the Find string throughout the session. This means that when the Find dialog is initiated, it will default to the string last found within the same session.

Note: The 'Value$ property of a Rich Text control returns the data in RTF format, whereas the 'Text$ property will return just the text without any formatting information.

Note: The 'Value$ property of a Rich Text control returns the data in RTF format, whereas the 'Text$ property will return just the text without any formatting information.

See Also

Note:
Applicable only when using Windows XP or Windows 7 style controls.

Note:
The Find logic within the system uses a common buffer for the Find string throughout the session. This means that when the Find dialog is initiated, it will default to the string last found within the same session.

Note:
The 'Value$ property of a Rich Text control returns the data in RTF format, whereas the 'Text$ property will return just the text without any formatting information.

Note:
The 'Value$ property of a Rich Text control returns the data in RTF format, whereas the 'Text$ property will return just the text without any formatting information.