Difference between revisions of "Arw SetTextAttribute"

From MultiCharts
Jump to navigation Jump to search
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
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.  
+
Sets an attribute of the text in an arrow object with the specified ID number.
 +
 
 +
Arw_SetTextAttribute 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.  
 
The following text attributes can be set: border, bold, italic, strike-out, and underline.  
 
   
 
   
==== Usage ====
+
== Usage ==
<syntaxhighlight>Arw_SetTextAttribute(ObjectID,Attribute,LogicalExpression)</syntaxhighlight>  
+
<syntaxhighlight>Arw_SetTextAttribute(ObjectID, Attribute, LogicalExpression)</syntaxhighlight>  
  
==== Parameters ====  
+
== Parameters ==
[[ObjectID]] - a numerical expression specifying the object ID number  
+
:'''ObjectID''' - a numerical expression specifying the object ID number.
  
[[Attribute]]- a numerical expression specifying the attribute:
+
:'''Attribute''' - a numerical expression specifying the attribute:
 +
::'''0''' - border,
 +
::'''1''' - bold,
 +
::'''2''' - italic,
 +
::'''3''' - strike-out,
 +
::'''4''' - underline.
  
0 - border
+
:'''LogicalExpression''' - a logical value; [[True]] = on and [[False]] = off.
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 assigned by [[Arw_New]], [[Arw_New_s]], [[Arw_New_self]] or [[Arw_New_self_s]] when the arrow object is created.
==== Notes ====  
+
* Use [[Arw_GetActive]], [[Arw_GetFirst]] or [[Arw_GetNext]] to get the object-specific ID number of an already created arrow.
An object-specific ID number is returned by [[Arw_New]] when the arrow object is created.  
 
 
   
 
   
==== Example ====
+
== Example ==
 
Set the attribute "bold" to on for the text in an arrow object with the ID number of 3:  
 
Set the attribute "bold" to on for the text in an arrow object with the ID number of 3:  
  
<syntaxhighlight>Value1=Arw_SetTextAttribute(3,1,True);</syntaxhighlight>
+
<syntaxhighlight>Value1 = Arw_SetTextAttribute(3, 1, True);</syntaxhighlight>
  
 
[[Category:ArrowDrawing]]
 
[[Category:ArrowDrawing]]

Latest revision as of 09:23, 19 February 2012

Sets an attribute of the text in an arrow object with the specified ID number.

Arw_SetTextAttribute 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

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);