Arw SetTextAttribute: Difference between revisions
From MultiCharts
no edit summary
m (Reverted edits by 176.8.90.7 (talk) to last revision by 194.84.116.138) |
No edit summary |
||
Line 1: | Line 1: | ||
Sets an attribute of the text in an arrow object with the specified ID number | Sets an attribute of the text in an arrow object with the specified ID number. | ||
Arw_SetTextAttribute returns a value of 0 if the attribute was successfully set, and a value of -2 if the specified object ID number is invalid. | |||
The following text attributes can be set: border, bold, italic, strike-out, and underline. | The following text attributes can be set: border, bold, italic, strike-out, and underline. | ||
== Usage == | |||
<syntaxhighlight>Arw_SetTextAttribute(ObjectID,Attribute,LogicalExpression)</syntaxhighlight> | <syntaxhighlight>Arw_SetTextAttribute(ObjectID, Attribute, LogicalExpression)</syntaxhighlight> | ||
== Parameters == | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
:'''Attribute''' - a numerical expression specifying the attribute: | |||
::'''0''' - border, | |||
0 - border | ::'''1''' - bold, | ||
::'''2''' - italic, | |||
1 - bold | ::'''3''' - strike-out, | ||
::'''4''' - underline. | |||
2 - italic | |||
3 - strike-out | |||
4 - underline | |||
:'''LogicalExpression''' - a logical value; [[True]] = on and [[False]] = off. | |||
== Notes == | |||
An object-specific ID number is | * 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 == | |||
Set the attribute "bold" to on for the text in an arrow object with the ID number of 3: | Set the attribute "bold" to on for the text in an arrow object with the ID number of 3: | ||
<syntaxhighlight>Value1=Arw_SetTextAttribute(3,1,True);</syntaxhighlight> | <syntaxhighlight>Value1 = Arw_SetTextAttribute(3, 1, True);</syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] |