+1 888 340 6572

Text GetColor: Difference between revisions

From MultiCharts
(Created page with "Returns an RGB color number or a legacy color value that correspond to the color of the text contained in a text object with the specified ID number; returns a value of -2 if ...")
 
No edit summary
Line 1: Line 1:
Returns an RGB color number or a legacy color value that correspond to the color of the text contained in a text object with the specified ID number; returns a value of -2 if the specified object ID number is invalid.  
Returns an RGB color number or a legacy color value that correspond to the color of the text contained in a text object with the specified ID number.
 
Text_GetColor will return a value of -2 if the specified object ID number is invalid.  
   
   
==== Usage ====
== Usage ==
<syntaxhighlight>Text_GetColor(ObjectID)</syntaxhighlight>  
<syntaxhighlight>Text_GetColor(ObjectID)</syntaxhighlight>  


Where: [[ObjectID]] - a numerical expression specifying the object ID number  
Where:
 
:'''ObjectID''' - a numerical expression specifying the object ID number.
   
   
==== Notes ====  
== Notes ==
An object-specific ID number is returned by [[Text_New]] when the text object is created.  
An object-specific ID number is returned by [[Text_New]] when the text object is created.  
   
   
==== Example ====
== Examples ==
Assign an RGB color number, corresponding to the color of the text object with an ID number of 3, to Value1 variable:  
Assign a [[RGB]] color number, corresponding to the color of the text object with an ID number of 3, to Value1 variable:  


<syntaxhighlight>Value1=Text_GetColor(3);</syntaxhighlight>
<syntaxhighlight>Value1 = Text_GetColor(3);</syntaxhighlight>


Assign a legacy color value, corresponding to the color of the text object with an ID number of 3, to Value1 variable:  
Assign a [[LegacyColorValue|legacy color value]], corresponding to the color of the text object with an ID number of 3, to Value1 variable:  


<syntaxhighlight>[LegacyColorValue=True];
<syntaxhighlight>[LegacyColorValue=True];
Value1=Text_GetColor(3);</syntaxhighlight>  
Value1 = Text_GetColor(3);</syntaxhighlight>  
 


[[Category:Text Drawing]]
[[Category:Text Drawing]]

Revision as of 07:57, 9 February 2012

Returns an RGB color number or a legacy color value that correspond to the color of the text contained in a text object with the specified ID number.

Text_GetColor will return a value of -2 if the specified object ID number is invalid.

Usage

Text_GetColor(ObjectID)

Where:

ObjectID - a numerical expression specifying the object ID number.

Notes

An object-specific ID number is returned by Text_New when the text object is created.

Examples

Assign a RGB color number, corresponding to the color of the text object with an ID number of 3, to Value1 variable:

Value1 = Text_GetColor(3);

Assign a legacy color value, corresponding to the color of the text object with an ID number of 3, to Value1 variable:

[LegacyColorValue=True];
Value1 = Text_GetColor(3);