Text GetBGColor: Difference between revisions
From MultiCharts
no edit summary
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
Returns an RGB color number or a legacy color value that correspond to the background color of a text object with the specified ID number | Returns an RGB color number or a legacy color value that correspond to the background color of a text object with the specified ID number. | ||
Text_GetBGColor returns a value of -2 if the specified object ID number is invalid. | |||
== Usage == | |||
<syntaxhighlight>Text_GetBGColor(ObjectID)</syntaxhighlight> | <syntaxhighlight>Text_GetBGColor(ObjectID)</syntaxhighlight> | ||
Where: | 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. | 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 background color of the text object with an ID number of 3, to Value1 variable: | Assign an [[RGB]] color number, corresponding to the background color of the text object with an ID number of 3, to Value1 variable: | ||
<syntaxhighlight>Value1=Text_GetBGColor(3);</syntaxhighlight> | <syntaxhighlight>Value1 = Text_GetBGColor(3);</syntaxhighlight> | ||
Assign a legacy color value, corresponding to the background color of the text object with an ID number of 3, to Value1 variable: | Assign a [[LegacyColorValue|legacy color value]], corresponding to the background color of the text object with an ID number of 3, to Value1 variable: | ||
<syntaxhighlight>[LegacyColorValue=True]; | <syntaxhighlight>[LegacyColorValue=True]; | ||
Value1=Text_GetBGColor(3);</syntaxhighlight> | |||
Value1 = Text_GetBGColor(3);</syntaxhighlight> | |||
[[Category:Text Drawing]] | [[Category:Text Drawing]] |