UserInterface.AddBooleanChoice(String, String, String, String, String) Method

Top

Description

Adds a Boolean Choice element to the UserInterface.

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

UserInterface.AddBooleanChoice(	String valueDestination,
	String elementLabel,
	String trueLabel,
	String falseLabel,
	String defaultValue)

Arguments

valueDestination
Description:	A String that represents either an object or a writeable property of an object where the value will be stored.

elementLabel
Description:	The label shown to the left of the input element.

trueLabel
Description:	The label corresponding to a 'true' value.

falseLabel
Description:	The label corresponding to a 'false' value.

defaultValue
Description:	The default value for the Boolean Choice.

Return Value

Type:

number

The return value is not used.

Syntax

myVariable1 = myUserInterface1.AddBooleanChoice(myString1, myString2, myString3, myString4, myString5);