Difference between revisions of "Arw SetTextSize"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Assigns the specified font size to the text of an arrow object with the specified ID number; returns a value of 0 if the font size was successfully assigned, and a value of -2...")
 
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Assigns the specified font size to the text of an arrow object with the specified ID number; returns a value of 0 if the font size was successfully assigned, and a value of -2 if the specified object ID number is invalid.  
+
Assigns the specified font size to the text of an arrow object with the specified ID number.
 +
 
 +
Arw_SetTextSize returns a value of 0 if the font size was successfully assigned, and a value of -2 if the specified object ID number is invalid.  
 
   
 
   
==== Usage ====
+
== Usage ==
<syntaxhighlight>Arw_SetTextSize(ObjectID,FontSize)</syntaxhighlight>  
+
<syntaxhighlight>Arw_SetTextSize(ObjectID, FontSize)</syntaxhighlight>  
 +
 
 +
Where:
 +
 
 +
:'''ObjectID''' - a numerical expression specifying the object ID number.
  
Where: <syntaxhighlight>ObjectID</syntaxhighlight> - a numerical expression specifying the object ID number
+
:'''FontSize''' - a numerical expression specifying the font size.
            <syntaxhighlight>FontSize</syntaxhighlight> - a numerical expression specifying the font size  
 
 
   
 
   
==== Notes ====  
+
== Notes ==
An object-specific ID number is returned by <syntaxhighlight>Arw_New</syntaxhighlight> when the arrow object is created.  
+
* 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 ====
+
== Example ==
 
Assign the font size of 16 to the text of an arrow object with the ID number of 3:  
 
Assign the font size of 16 to the text of an arrow object with the ID number of 3:  
  
<syntaxhighlight>Value1=Arw_SetTextSize(3,16);</syntaxhighlight>
+
<syntaxhighlight>Value1 = Arw_SetTextSize(3, 16);</syntaxhighlight>
 
 
  
 
[[Category:ArrowDrawing]]
 
[[Category:ArrowDrawing]]

Latest revision as of 09:11, 19 February 2012

Assigns the specified font size to the text of an arrow object with the specified ID number.

Arw_SetTextSize returns a value of 0 if the font size was successfully assigned, and a value of -2 if the specified object ID number is invalid.

Usage

Arw_SetTextSize(ObjectID, FontSize)

Where:

ObjectID - a numerical expression specifying the object ID number.
FontSize - a numerical expression specifying the font size.

Notes

Example

Assign the font size of 16 to the text of an arrow object with the ID number of 3:

Value1 = Arw_SetTextSize(3, 16);