+1 888 340 6572

Arw SetTextBGColor: Difference between revisions

From MultiCharts
(Created page with "Assigns the specified background color to the text of an arrow object with the specified ID number; returns a value of 0 if the color was successfully assigned, and a value of...")
 
No edit summary
Line 5: Line 5:


==== Parameters ====  
==== Parameters ====  
<syntaxhighlight>ObjectID</syntaxhighlight> - a numerical expression specifying the object ID number  
[[ObjectID]] - a numerical expression specifying the object ID number  


<syntaxhighlight>TextBGColor</syntaxhighlight> - an expression specifying the text background color  
[[TextBGColor]] - an expression specifying the text background color  


The color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words.  
The color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words.  
   
   
==== 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:25, 20 January 2012

Assigns the specified background color to the text of an arrow object with the specified ID number; returns a value of 0 if the color was successfully assigned, and a value of -2 if the specified object ID number is invalid.

Usage

Arw_SetTextBGColor(ObjectID,TextBGColor)

Parameters

ObjectID - a numerical expression specifying the object ID number

TextBGColor - an expression specifying the text background color

The color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words.

Notes

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

Example

Assign the color blue to the text background of an arrow object with the ID number of 3:

Value1=Arw_SetTextBGColor(3,Blue);

Assign the RGB color 2138336 (Orange) to the text background of an arrow object with the ID number of 3:

Value1=Arw_SetTextBGColor(3,2138336);

Assign the legacy color 4 (Green) to the text background of an arrow object with the ID number of 3:

[LegacyColorValue=True];
Value1=Arw_SetTextBGColor(3,4);