UserInterface.AddMultiChoiceItem(Variable, String, String) Method

Top

Description

Adds a Multi-Choice Item to a Multi-Choice Element.

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.AddMultiChoiceItem(	Variable multiChoiceId,
	String value,
	String label)

Arguments

multiChoiceId
Description:	The id of the Multi-Choice Element to which you wish to add the item.
Valid Range:	multiChoiceId ≥ 0

value
Description:	The name of the object that contains the value of the item, such as Variable1.Name or "Variable1".

label
Description:	The label to be presented to the user for this item.

Return Value

Type:

number

The return value is not used.

Syntax

myVariable1 = myUserInterface1.AddMultiChoiceItem(myVariable2, myString1, myString2);