Difference between revisions of "Arw SetTextFontName"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Assigns the specified font to the text of an arrow object with the specified ID number; returns a value of -2 if the specified object ID number is invalid. Any font in the F...")
 
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Assigns the specified font to the text of an arrow object with the specified ID number; returns a value of -2 if the specified object ID number is invalid.  
+
Assigns the specified font to the text of an arrow object with the specified ID number.
  
Any font in the Fonts folder can be used; the folder is accessible from the Control Panel in Windows XP operating system.  
+
Arw_SetTextFontName returns a value of -2 if the specified object ID number is invalid.
 +
 
 +
Any font in the Fonts folder can be used; the folder is accessible from the Control Panel in Windows operating system. You can look in a text editor for the specific name of your preferred font.
 
   
 
   
==== Usage ====
+
== Usage ==
<syntaxhighlight>Arw_SetTextFontName(ObjectID,"FontName")</syntaxhighlight>  
+
<syntaxhighlight>Arw_SetTextFontName(ObjectID, "FontName")</syntaxhighlight>  
  
Where: <syntaxhighlight>ObjectID</syntaxhighlight> - a numerical expression specifying the object ID number  
+
Where:  
            <syntaxhighlight>FontName</syntaxhighlight> - a string expression specifying the font name  
+
 
 +
:'''ObjectID''' - a numerical expression specifying the object ID number.
 +
 
 +
:'''FontName''' - a string expression specifying the font name.
 +
::* The FontName input is not case sensitive, but spaces do need to match.
 
   
 
   
==== 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 ====
+
== Examples ==
 
Assign font Verdana to the text of an arrow object with the ID number of 3:  
 
Assign font Verdana to the text of an arrow object with the ID number of 3:  
  
<syntaxhighlight>Value1=Arw_SetTextFontName(3,"Verdana");</syntaxhighlight>
+
<syntaxhighlight>Value1 = Arw_SetTextFontName(3, "Verdana");</syntaxhighlight>
 +
 
 +
Assign font Times New Roman to the text of an arrow object with the ID number of 6:
 +
 
 +
<syntaxhighlight>Value1 = Arw_SetTextFontName(6, "Times New Roman");</syntaxhighlight>
  
 
[[Category:ArrowDrawing]]
 
[[Category:ArrowDrawing]]

Latest revision as of 10:40, 22 January 2018

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

Arw_SetTextFontName returns a value of -2 if the specified object ID number is invalid.

Any font in the Fonts folder can be used; the folder is accessible from the Control Panel in Windows operating system. You can look in a text editor for the specific name of your preferred font.

Usage

Arw_SetTextFontName(ObjectID, "FontName")

Where:

ObjectID - a numerical expression specifying the object ID number.
FontName - a string expression specifying the font name.
  • The FontName input is not case sensitive, but spaces do need to match.

Notes

Examples

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

Value1 = Arw_SetTextFontName(3, "Verdana");

Assign font Times New Roman to the text of an arrow object with the ID number of 6:

Value1 = Arw_SetTextFontName(6, "Times New Roman");