Text GetAttribute: Difference between revisions
From MultiCharts
No edit summary |
|||
Line 1: | Line 1: | ||
Returns a logical value indicating the setting for an attribute of a text object with the specified ID number | Returns a logical value indicating the setting for an attribute of a text object with the specified ID number. | ||
The settings of the following attributes can be returned: border, bold, italic, strike-out, and underline. | Text_GetAttribute returns a value of '''True''' if the attribute is set to on, and a value of '''False''' if the attribute is set to off or if the specified object ID number is invalid. | ||
The settings of the following attributes can be returned: border, bold, italic, strike-out, and underline. | |||
<syntaxhighlight>Text_GetAttribute(ObjectID,Attribute)</syntaxhighlight> | |||
== Usage == | |||
<syntaxhighlight>Text_GetAttribute(ObjectID, Attribute)</syntaxhighlight> | |||
== Parameters == | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
:'''Attribute''' - a numerical expression specifying the attribute: | |||
0 - border | ::'''0''' - border | ||
1 - bold | ::'''1''' - bold | ||
2 - italic | ::'''2''' - italic | ||
3 - strike-out | ::'''3''' - strike-out | ||
4 - underline | ::'''4''' - underline | ||
== Notes == | |||
An object-specific ID number is returned by [[Text_New]] when the text object is created. | An object-specific ID number is returned by [[Text_New]] when the text object is created. | ||
== Example == | |||
Assign a true/false value, indicating the setting of "bold" attribute for the text object with an ID number of 3, to Bold variable: | Assign a true/false value, indicating the setting of "bold" attribute for the text object with an ID number of 3, to Bold variable: | ||
<syntaxhighlight>Variable:Bold(False); | <syntaxhighlight>Variable: Bold(False); | ||
Bold=Text_GetAttribute(3,1);</syntaxhighlight> | |||
Bold = Text_GetAttribute(3,1);</syntaxhighlight> | |||
[[Category:Text Drawing]] | [[Category:Text Drawing]] |
Revision as of 08:06, 9 February 2012
Returns a logical value indicating the setting for an attribute of a text object with the specified ID number.
Text_GetAttribute returns a value of True if the attribute is set to on, and a value of False if the attribute is set to off or if the specified object ID number is invalid.
The settings of the following attributes can be returned: border, bold, italic, strike-out, and underline.
Usage
Text_GetAttribute(ObjectID, Attribute)
Parameters
- ObjectID - a numerical expression specifying the object ID number.
- Attribute - a numerical expression specifying the attribute:
- 0 - border
- 1 - bold
- 2 - italic
- 3 - strike-out
- 4 - underline
Notes
An object-specific ID number is returned by Text_New when the text object is created.
Example
Assign a true/false value, indicating the setting of "bold" attribute for the text object with an ID number of 3, to Bold variable:
Variable: Bold(False);
Bold = Text_GetAttribute(3,1);