877
edits
Changes
no edit summary
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.
<syntaxhighlight>Text_GetBGColor(ObjectID)</syntaxhighlight>
Where: [[ :'''ObjectID]] ''' - a numerical expression specifying the object ID number .
An object-specific ID number is returned by [[Text_New]] when the text object is created.
<syntaxhighlight>Value1=Text_GetBGColor(3);</syntaxhighlight>
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];
Value1=Text_GetBGColor(3);</syntaxhighlight>
[[Category:Text Drawing]]