system.gui.color
This function is used in Python Scripting.
Description​
Creates a new color object, either by parsing a string or by having the RGB[A] channels specified explicitly. See toColor to see a list of available color names.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax (String)​
system.gui.color(color)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | color | A string that will be coerced into a color. Can accept many formats, such as "red" or "#FF0000" or "255,0,0". |
Returns​
Color - The newly created color.
Scope​
Vision Client
Syntax (int)​
system.gui.color(red, green, blue, [alpha])
Parameters​
| Type | Parameter | Description |
|---|---|---|
| Integer | red | The red component of the color, an integer 0-255. |
| Integer | green | The green component of the color, an integer 0-255. |
| Integer | blue | The blue component of the color, an integer 0-255. |
| Integer | alpha | The alpha component of the color, an integer 0-255. [optional] |
Returns​
Color - The newly created color.
Scope​
Vision Client
Code Examples​
Example #1
# This example changes the background color of a component to red.
myComponent = event.source
myComponent.background = system.gui.color(255,0,0) # turn the component red
Keywords​
system gui color, gui.color