API Component.Property.SetColor: Difference between revisions
XML Import to change Variable types into Variable Types |
XML import of updated API docs |
||
| Line 1: | Line 1: | ||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
Sets a components 'color' property as a R,G,B value | Sets a components 'color' property as a R,G,B value | ||
| Line 39: | Line 41: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetColor(handle, red, green, blue)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetColor(handle, red, green, blue)</pre> | ||
''<span style="color:red;">No additional | ''<span style="color:red;">No additional examples</span>'' | ||
Revision as of 09:58, 17 June 2013
<sidebar>API contents</sidebar>
Sets a components 'color' property as a R,G,B value
Parameters
HANDLE Handle
- The component handle of the property owner
BYTE Red
- The 0-255 red part of the colour
BYTE Green
- The 0-255 green part of the colour
BYTE Blue
- The 0-255 blue part of the colour
Return value
This call does not return a value
Detailed description
This is a helper function that takes the red, green and blue values form 0-255 and calls SetValue with the property name "color" and the argument the RGB value built from this calls arguments.
No check is made to see if the target Handle has a property called "color", and no error is returned if it does not.
Examples
Calling in a calculation
- Add to a calculation icon:
::Component.Property.SetColor(handle, red, green, blue)
No additional examples