Changes
Jump to navigation
Jump to search
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 ..."
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.
==== Usage ====
<syntaxhighlight>Text_GetColor(ObjectID)</syntaxhighlight>
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.
==== Example ====
Assign an 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>
Assign a legacy color value, corresponding to the color of the text object with an ID number of 3, to Value1 variable:
<syntaxhighlight>[LegacyColorValue=True];
Value1=Text_GetColor(3);</syntaxhighlight>
[[Category:Text Drawing]]
==== Usage ====
<syntaxhighlight>Text_GetColor(ObjectID)</syntaxhighlight>
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.
==== Example ====
Assign an 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>
Assign a legacy color value, corresponding to the color of the text object with an ID number of 3, to Value1 variable:
<syntaxhighlight>[LegacyColorValue=True];
Value1=Text_GetColor(3);</syntaxhighlight>
[[Category:Text Drawing]]
