SetOption Method (RICHEDITTEXT)
10.2A, PLBCMP GUI Only
The SetOption method for the RICHEDITTEXT object set or clears special behaviors. The method uses the following format:
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A RICHEDITTEXT object that is accessed.
return
Optional. A Numeric variable that returns the current RICHEDITTEXT special mode flags value.
flags
Optional. A Numeric Variable or decimal number that contains bit mask values used to invoke RICHEDITTEXT special behaviors.
mode
Optional. A Numeric Variable or decimal number that specifies a value which identifies whether a CLEAR or SET operation is to be performed.
Flags Affected: OVER, ZERO
Note the following:
The ZERO flag is set when the {return} value is zero.
The OVER flag is set if the value returned is too big to be stored into the {return} variable.
The bit mask definitions for the {flags} parameter are as follows:
|
Bit Mask Value |
Description |
|
0x1 |
When this bit is turned on, the ignores a CR ( 0x0D ) keyed character when the RICHEDITTEXT is single line edit control. Setting this bit value avoids the normal RICHEDITTEXT behavior of generating an audible beep when a CR character is keyed for a single line RICHEDITTEXT. |
4. The {mode} value specified whether the {flags} bit values are to be cleared or set as follows:
|
Mode Value |
Description |
|
1 |
Set the RICHEDITTEXT special mode flags. |
|
2 |
Clear the RICHEDITTEXT special mode flags. |
|
|
For any values other than 1 or 2, the SetOption method doesnot make any change to the current RICHEDITTEXT mode flags. |
The {return} always contains the current RICHEDITTEXT mode flag setting.
The mode {flags} can only be cleared and set when both the {flags} and {mode} parameters are specified. Otherwise, the method simply returns the current mode flag setting.
See Also: Method Syntax, EDITTEXT Methods, RICHEDITTEXT Methods
|