Difference between revisions of "Arw GetTextAttribute"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Returns a logical value indicating the setting for an attribute of the text in an arrow object with the specified ID number; returns a value of <syntaxhighlight>True</syntaxhi...")
 
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 value of <syntaxhighlight>True</syntaxhighlight> if the attribute is set to on, and a value of <syntaxhighlight>False</syntaxhighlight> if the attribute is set to off or if the specified object ID number is invalid.  
+
Returns a logical value indicating the setting for an attribute of the text in an arrow object with the specified ID number; 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.  
Line 21: Line 21:
 
==== Notes ====  
 
==== Notes ====  
 
An object-specific ID number is assigned by  
 
An object-specific ID number is assigned by  
<syntaxhighlight>Arw_New
+
[[Arw_New]] when the arrow object is created.  
</syntaxhighlight> when the arrow object is created.  
 
 
   
 
   
 
==== Example ====
 
==== Example ====

Revision as of 13:01, 20 January 2012

Returns a logical value indicating the setting for an attribute of the text in an arrow object with the specified ID number; returns a value of True if the attribute is set to on, and a value of Falseif 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.

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 when the arrow object is created.

Example

Assign a true/false value, indicating the setting of "bold" attribute for the arrow object with an ID number of 3, to ArwTxtBold variable:


Variable:ArwTxtBold(False); 
ArwTxtBold=Arw_GetTextAttribute(3,1);