Arw SetStyle: Difference between revisions
From MultiCharts
No edit summary |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Assigns the specified style to the arrow of an arrow object with the specified ID number | <div style="display:inline;float:right;padding:5px;width:100px;font-size:85%;text-align:center;background:#FFF;border:1px solid #C0C0C0;"> | ||
[[File:ArrowStyles.png|alt=Arrow styles|Arrow styles]]<br/> | |||
The numerical expression '''ArrowStyle''', which ranges from 0 to 13, gives one of these arrow styles. | |||
</div> | |||
Assigns the specified style to the arrow of an arrow object with the specified ID number. | |||
Arw_SetStyle returns a value of 0 if the arrow style was successfully modified, and a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Arw_SetStyle(ObjectID,ArrowStyle)</syntaxhighlight> | <syntaxhighlight>Arw_SetStyle(ObjectID, ArrowStyle)</syntaxhighlight> | ||
Where: | |||
:'''ObjectID''' - a numerical expression specifying the object ID number. | |||
ArrowStyle - a numerical expression specifying the arrow style; arrow styles range from 0 to 13 | :'''ArrowStyle''' - a numerical expression specifying the arrow style; arrow styles range from 0 to 13. | ||
== 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 == | |||
Assign the arrow style of 5 to an arrow object with the ID number of 3: | Assign the arrow style of 5 to an arrow object with the ID number of 3: | ||
<syntaxhighlight>Value1=Arw_SetStyle(3,5);</syntaxhighlight> | <syntaxhighlight>Value1 = Arw_SetStyle(3, 5);</syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 09:08, 19 February 2012
The numerical expression ArrowStyle, which ranges from 0 to 13, gives one of these arrow styles.
Assigns the specified style to the arrow of an arrow object with the specified ID number.
Arw_SetStyle returns a value of 0 if the arrow style was successfully modified, and a value of -2 if the specified object ID number is invalid.
Usage
Arw_SetStyle(ObjectID, ArrowStyle)Where:
- ObjectID - a numerical expression specifying the object ID number.
- ArrowStyle - a numerical expression specifying the arrow style; arrow styles range from 0 to 13.
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 the arrow style of 5 to an arrow object with the ID number of 3:
Value1 = Arw_SetStyle(3, 5);