Difference between revisions of "API Component.Property.SetColor"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <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 | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Component|Component]] | ||
| + | :[[API Component.Property|Property]] | ||
| + | ::[[API Component.Property|SetColor]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The component handle of the property owner | :The component handle of the property owner | ||
| − | + | [[Variable Types|BYTE]] ''Red'' | |
:The 0-255 red part of the colour | :The 0-255 red part of the colour | ||
| − | + | [[Variable Types|BYTE]] ''Green'' | |
:The 0-255 green part of the colour | :The 0-255 green part of the colour | ||
| − | + | [[Variable Types|BYTE]] ''Blue'' | |
:The 0-255 blue part of the colour | :The 0-255 blue part of the colour | ||
| − | + | ||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==Detailed description== |
| − | + | This is a helper function that takes the red, green and blue values form 0-255 and calls [[API Component.Property.SetValue|SetValue]] with the property name "color" and the argument the RGB value built from this calls arguments. | |
| − | * Add to a calculation icon: ::Component.Property.SetColor(handle, red, green, blue) | + | |
| + | |||
| + | 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: <pre class="brush:[cpp]">::Component.Property.SetColor(handle, red, green, blue)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets a components 'color' property as a R,G,B value
Contents
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
