system.vision.showColorInput
Backwards Compatibility
This function replaces system.gui.chooseColor. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.
This function is used in Python Scripting.
Description​
Prompts the user to pick a color using the default color-chooser dialog box.
note
This function is available on secondary desktops via the system.vision.desktop function. See the Multi-Monitor Clients page for more details on secondary desktops.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax​
system.vision.showColorInput(initialColor, [dialogTitle])
Parameters​
| Type | Parameter | Description |
|---|---|---|
| Color | initialColor | A color to use as a starting point in the color choosing popup. |
| String | dialogTitle | The title for the color choosing popup. Defaults to "Choose Color". [optional] |
Returns​
Color - The new color chosen by the user.
Scope​
Vision Client
Code Examples​
Example #1
# This code would be placed in the actionPerformed event of a button
# and would change the background color of the container the button was placed in.
parent = event.source.parent
newColor = system.vision.showColorInput(parent.background)
parent.background = newColor