CommandInputs.addRadioButtonGroupCommandInput Method

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

Description

Adds a new Radio Button Group input to the command.

Syntax

"commandInputs_var" is a variable referencing a CommandInputs object.
# Uses no optional arguments.
returnValue = commandInputs_var.addRadioButtonGroupCommandInput(id)

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

#include <Core/UserInterface/CommandInputs.h>

// Uses no optional arguments.
returnValue = commandInputs_var->addRadioButtonGroupCommandInput(id);

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

Return Value

Type Description
RadioButtonGroupCommandInput Returns the created RadioButtonGroupCommandInput 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 label of this radio button group as seen in the dialog.

This is an optional argument whose default value is "".

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 July 2015