ColorUtilities.GetColorFromName(String) Method

Top

Description

Gets color based on a color name.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

ColorUtilities.GetColorFromName(

String name)

Arguments

name
Description:	String color name.

Return Value

Type:

number

Returns a Variable representation of the specified color. Returns a -1 if the specified color name is unknown.

Syntax

myVariable1 = ColorTools.GetColorFromName(myString1);