4D v13.4OBJECT Get styled text |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
4D v13.4
OBJECT Get styled text
|
OBJECT Get styled text ( {* ;} object {; startSel {; endSel}} ) -> Function result | ||||||||
Parameter | Type | Description | ||||||
* | Operator |
![]() |
If specified, object is an object name (string) If omitted, object is a variable or a field | |||||
object | Form object |
![]() |
Object name (if * is specified) or Text field or variable (if * is omitted) | |||||
startSel | Longint |
![]() |
Start of selection | |||||
endSel | Longint |
![]() |
End of selection | |||||
Function result | Text |
![]() |
Text including style tags | |||||
The OBJECT Get styled text command returns the styled text found in the text field or variable designated by the object parameter.
If you pass the optional * parameter, this indicates that the object parameter is an object name (string). During execution, if the object has the focus, the command returns information about the object being edited; however, when the object does not have the focus, the command returns information about the data source (field or variable) of the object.
If you omit the * parameter, this indicates that the object parameter is a field or a variable. In this case, you pass a field or variable reference instead of a string and during execution, the command returns information about this field or variable.
The command returns the text with any style tags that are associated with it, which means, for example, that you can copy and paste text while keeping its style.
The optional startSel and endSel parameters let you designate a selection of text in object. The startSel and endSel values give a selection of plain text, without taking any style tags found in the text into account.
If the values of startSel and endSel are equal or if startSel is greater than endSel, an error is returned.
After this command is executed, the OK variable is set to 1 if no error occurred; otherwise, it is set to 0. This is the case more particularly when style tags are not evaluated properly (incorrect or missing tags).
In the case of an error, the variable is not changed. When an error occurs on a variable when text is being evaluated, 4D transforms the text into plain text; as a result, the <, > and & characters are converted into HTML entities.
Product: 4D
Theme: Object Properties
Number:
1116
Created: 4D v12
Modified: 4D v12.1
OBJECT Get plain text
OBJECT SET STYLED TEXT
TEXT TO ARRAY
multi-style, multistyle, multi style***