CommandInputs.addIntegerSliderListCommandInput Method

Parent Object: CommandInputs
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/CommandInputs.h>

Description

Adds a new slider input to the command. The value type is integer.

Syntax

"commandInputs_var" is a variable referencing a CommandInputs object.
# Uses no optional arguments.
returnValue = commandInputs_var.addIntegerSliderListCommandInput(id, name, valueList)

# Uses optional arguments.
returnValue = commandInputs_var.addIntegerSliderListCommandInput(id, name, valueList, hasTwoSliders)
"commandInputs_var" is a variable referencing a CommandInputs object.

#include <Core/UserInterface/CommandInputs.h>

// Uses no optional arguments.
returnValue = commandInputs_var->addIntegerSliderListCommandInput(id, name, valueList);

// Uses optional arguments.
returnValue = commandInputs_var->addIntegerSliderListCommandInput(id, name, valueList, hasTwoSliders);

Return Value

Type Description
IntegerSliderCommandInput Returns the created IntegerSliderCommandInput object or null if the creation failed.

Parameters

Name Type Description
id string The unique ID of this command input. It must be unique with respect to the other inputs associated with this command.
name string The displayed name of this command as seen in the dialog.
valueList integer[] Provides the value list of the slider command input. This defines all of the values that the slider can return. As the user moves the slider it will jump between these values. The low and high values of the list are used as the minimum and maximum values of the slider.
hasTwoSliders boolean Optional input. Indicates if the slider has two sliders.

This is an optional argument whose default value is False.

Samples

Name Description
Command Inputs API Sample

Creates a command dialog that demonstrates all of the available command inputs.

To use the sample, create a new Python or C++ script and copy and paste this code, replacing the default code. You also need to unpack this zip file which contains a resource folder into the same folder where the source code file (.py or .cpp) is.

Version

Introduced in version June 2015