Difference between revisions of "Arw SetTextAttribute"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Sets an attribute of the text in an arrow object with the specified ID number; returns a value of 0 if the attribute was successfully set, and a value of -2 if the specified o...")
 
Line 7: Line 7:
  
 
==== Parameters ====  
 
==== Parameters ====  
<syntaxhighlight>ObjectID</syntaxhighlight> - a numerical expression specifying the object ID number  
+
[[ObjectID]] - a numerical expression specifying the object ID number  
  
<syntaxhighlight>Attribute</syntaxhighlight> - a numerical expression specifying the attribute:
+
[[Attribute]]- a numerical expression specifying the attribute:
  
 
  0 - border
 
  0 - border
Line 17: Line 17:
 
  4 - underline
 
  4 - underline
  
<syntaxhighlight>LogicalExpression</syntaxhighlight> - a logical value; True = on and False = off  
+
[[LogicalExpression]] - a logical value; True = on and False = off  
 
   
 
   
 
==== 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 returned by [[Arw_New]] when the arrow object is created.  
 
   
 
   
 
==== Example ====
 
==== Example ====

Revision as of 13:24, 20 January 2012

Sets an attribute of the text in an arrow object with the specified ID number; 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.

Usage

Arw_SetTextAttribute(ObjectID,Attribute,LogicalExpression)

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

LogicalExpression - a logical value; True = on and False = off

Notes

An object-specific ID number is returned by Arw_New when the arrow object is created.

Example

Set the attribute "bold" to on for the text in an arrow object with the ID number of 3:

Value1=Arw_SetTextAttribute(3,1,True);