GET STYLE SHEET INFO
GET STYLE SHEET INFO ( styleSheetName ; font ; size ; styles )
Parameter | Type | Description | |
---|---|---|---|
styleSheetName | Text | → | Name of style sheet |
font | Text | ← | Character font |
size | Integer | ← | Font size |
styles | Integer | ← | Style value |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The GET STYLE SHEET INFO command returns the current configuration of the style sheet designated in the styleSheetName parameter.
In styleSheetName, you pass the name of the style sheet as defined in the Design mode. To designate an automatic style sheet, you can use one of the following constants, found in the "Font Styles" theme:
Constant | Type | Value | Comment |
---|---|---|---|
Automatic style sheet | Text | __automatic__ | Used by default for all objects |
Automatic style sheet_additional | Text | __automatic_additional_text__ | Supported by static text, fields and variables only. Used for additional text in dialog boxes. |
Automatic style sheet_main | Text | __automatic_main_text__ | Supported by static text, fields and variables only. Used for main text in dialog boxes. |
In font, the command returns the name of the font associated with the style sheet for the current platform.
In size, the command returns the size in points of the font associated with the style sheet for the current platform.
In styles, the command returns a value corresponding to the style(s) associated with the style sheet for the current platform. You can compare the value received with the following constants, found in the "Font Styles" theme:
Constant | Type | Value |
---|---|---|
Bold | Integer | 1 |
Bold and Italic | Integer | 3 |
Bold and Underline | Integer | 5 |
Italic | Integer | 2 |
Italic and Underline | Integer | 6 |
Plain | Integer | 0 |
Underline | Integer | 4 |
If the command is executed correctly, the OK system variable is set to 1. Otherwise (for example, if the styleSheetName does not exist), it is set to 0.
Compatibility Note
In project architecture, only the three automatic style sheets are supported by this command.
Example
You want to find out the current configuration of the "Automatic" style sheet:
var $size;$style : Integer
var $font : Text
GET STYLE SHEET INFO(Automatic style sheet;$font;$size;$style)