API Component.Property.SetColor - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:39Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:12Z

JonnyW: XML import

2014-01-16T15:57:43Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:24Z

XML import of API documentation

JonnyW: XML import of updated API docs

2013-06-17T09:58:24Z

XML import of updated API docs

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:08:51Z

XML Import to change Variable types into Variable Types

JonnyW at 19:24, 7 June 2013

2013-06-07T19:24:37Z

Admin: XML import

2013-05-12T21:50:42Z

XML import

Admin: XML import

2013-05-12T01:51:02Z

XML import

Admin: XML import

2013-05-11T22:07:04Z

XML import

← Older revision		Revision as of 11:54, 16 January 2023
Line 42:		Line 42:
	===Calling in a calculation===		===Calling in a calculation===
	* 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 examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Sets a components 'color' property as a R,G,B value
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetColor'''
-====Class hierarchy====
+|-
-[[API Component|Component]]
+| colspan="2" | Sets a components 'color' property as a R,G,B value&nbsp;
-:[[API Component.Property|Property]]
+|-
-::[[API Component.Property|SetColor]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | Handle
+|-
-==Parameters==
+| colspan="2" | The component handle of the property owner&nbsp;
-[[Variable Types|HANDLE]] ''Handle''
+|-
-:The component handle of the property owner
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Red
-[[Variable Types|BYTE]] ''Red''
+|-
-:The 0-255 red part of the colour
+| colspan="2" | The 0-255 red part of the colour&nbsp;
+|-
-[[Variable Types|BYTE]] ''Green''
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-:The 0-255 green part of the colour
+| width="90%" | Green
+|-
-[[Variable Types|BYTE]] ''Blue''
+| colspan="2" | The 0-255 green part of the colour&nbsp;
-:The 0-255 blue part of the colour
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Blue
-==Return value==
+|-
-''This call does not return a value''
+| colspan="2" | The 0-255 blue part of the colour&nbsp;

← Older revision		Revision as of 15:57, 16 January 2014
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

← Older revision		Revision as of 14:27, 9 August 2013
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 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 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>
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''

← Older revision		Revision as of 19:24, 7 June 2013
Line 29:		Line 29:

	==Detailed description==		==Detailed description==
−	~~''<span style=~~"color~~:red;~~">No ~~additional information</span>~~''	+	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.
		+
		+
		+	No check is made to see if the target ''Handle'' has a property called "color", and no error is returned if it does not.

@@ Line 3: / Line 3: @@
 <div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API Component|Component]]
+====Class hierarchy====
 :[[API Component.Property|Property]]
 ::[[API Component.Property|SetColor]]
@@ Line 10: / Line 11: @@
 ==Parameters==
-''[[Variable types|HANDLE]] Handle''
+[[Variable types|HANDLE]] ''Handle''
 :The component handle of the property owner
-''[[Variable types|BYTE]] Red''
+[[Variable types|BYTE]] ''Red''
 :The 0-255 red part of the colour
-''[[Variable types|BYTE]] Green''
+[[Variable types|BYTE]] ''Green''
 :The 0-255 green part of the colour
-''[[Variable types|BYTE]] Blue''
+[[Variable types|BYTE]] ''Blue''
 :The 0-255 blue part of the colour
@@ Line 26: / Line 27: @@
 ==Detailed description==
-''No additional information''
+''<span style="color:red;">No additional information</span>''
 ==Examples==
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetColor(handle, red, green, blue)</pre>