×

Sign up and get MultiCharts free

Use its powerful simulation mode with data included out of the box. Just fill out the form and start honing your trading skills with a few clicks.

Changes - MultiCharts
Open main menu

Changes

Arw SetTextBGColor

291 bytes added, 09:20, 19 February 2012
no edit summary
Assigns the specified background color to the text of an arrow object with the specified ID number; . Arw_SetTextBGColor 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 ====<syntaxhighlight>Arw_SetTextBGColor(ObjectID,TextBGColor)</syntaxhighlight>
==== 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 [[LegacyColorValue|legacy color value]], or by one of [[:Category:Colors|17 base color words]].
==== Notes ==== * An object-specific ID number is returned assigned by [[Arw_New]], [[Arw_New_s]], [[Arw_New_self]] or [[Arw_New_self_s]] when the arrow object is created.* Use [[Arw_GetActive]], [[Arw_GetFirst]] or [[Arw_GetNext]] to get the object-specific ID number of an already created arrow.
==== Example ==Examples ==Assign the color [[Blue|blue ]] to the text background of an arrow object with the ID number of 3:  <syntaxhighlight>Value1 = Arw_SetTextBGColor(3, Blue);</syntaxhighlight>
<syntaxhighlight>Value1=Arw_SetTextBGColorAssign the [[RGB]] color 2138336 (Orange) to the text background of an arrow object with the ID number of 3,Blue);</syntaxhighlight>:
Assign the RGB color <syntaxhighlight>Value1 = Arw_SetTextBGColor(3, 2138336 (Orange) to the text background of an arrow object with the ID number of 3: ;</syntaxhighlight>
<syntaxhighlight>Value1=Arw_SetTextBGColorAssign the [[LegacyColorValue|legacy color]] 4 ([[Green]]) to the text background of an arrow object with the ID number of 3,2138336);</syntaxhighlight>:
Assign the legacy color 4 (Green) to the text background of an arrow object with the ID number of 3: <syntaxhighlight>[LegacyColorValue = True];
<syntaxhighlight>[LegacyColorValue=True];Value1=Arw_SetTextBGColor(3,4);</syntaxhighlight>
[[Category:ArrowDrawing]]