Difference between revisions of "Arw GetTextAttribute"
Jump to navigation
Jump to search
(→Usage) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | Returns a logical value indicating the setting for an attribute of the text in an arrow object with the specified ID number | + | Returns a logical value indicating the setting for an attribute of the text in an arrow object with the specified ID number. |
| + | |||
| + | Arw_GetTextAttribute 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. | The settings of the following attributes can be returned: border, bold, italic, strike-out, and underline. | ||
| − | + | == Usage == | |
| + | <syntaxhighlight>Arw_GetTextAttribute(ObjectID, Attribute) | ||
| + | </syntaxhighlight> | ||
| − | + | == Parameters == | |
| − | ObjectID - a numerical expression specifying the object ID number | + | :'''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 assigned by [[Arw_New]], [[Arw_New_s]], [[Arw_New_self]] or [[Arw_New_self_s]] when the arrow object is created. | |
| − | + | * Use [[Arw_GetActive]], [[Arw_GetFirst]] or [[Arw_GetNext]] to get the object-specific ID number of an already created arrow. | |
| − | + | == Example == | |
| − | + | Assign a true/false value, indicating the setting of "bold" attribute for the arrow object with an ID number of 3, to the ArwTxtBold variable: | |
| − | |||
| − | |||
| − | 3 | ||
| − | + | <syntaxhighlight>Variable: ArwTxtBold(False); | |
| − | + | ArwTxtBold = Arw_GetTextAttribute(3, 1); | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | ArwTxtBold=Arw_GetTextAttribute(3,1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 08:12, 19 February 2012
Returns a logical value indicating the setting for an attribute of the text in an arrow object with the specified ID number.
Arw_GetTextAttribute 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.
Contents
Usage
Arw_GetTextAttribute(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 assigned by Arw_New, Arw_New_s, Arw_New_self or Arw_New_self_s when the arrow object is created.
- Use Arw_GetActive, Arw_GetFirst or Arw_GetNext to get the object-specific ID number of an already created arrow.
Example
Assign a true/false value, indicating the setting of "bold" attribute for the arrow object with an ID number of 3, to the ArwTxtBold variable:
Variable: ArwTxtBold(False);
ArwTxtBold = Arw_GetTextAttribute(3, 1);
