IntegerSliderCommandInput Object

Derived from: SliderCommandInput Object
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/IntegerSliderCommandInput.h>

Description

Provides a command input to get the value of a slider from the user, the value type is integer.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
deleteMe Deletes this Command input.
getText Gets the texts of the slider if text has been defined.
setText Sets the text of the slider. Both the left and the right text should be set.

Properties

Name Description
commandInputs Gets the CommandInputs class of the parent, which can be a Command, GroupCommandInput or TabCommandInput.
expressionOne Uses an expression to set the value in the first input field. This can contain equations and is evaluated using the specified unit type.
expressionTwo Uses an expression to set the value in the second input field. This can contain equations and is evaluated using the specified unit type.

This property is only available when the hasTwoSliders property returns true.
hasTwoSliders Gets if the command input has two sliders.
id Gets the unique identifier for this input in the command's CommandInputs.
isEnabled Gets or sets if this input is currently enabled or disabled for user interaction.
isFullWidth Gets or sets if this input fills the entire width of the dialog. If true, the name is ignored and the input control will fill the entire width of the command dialog. The default value for this property in a new command input if false, or not to fill the width. This property does not apply to GroupCommandInputs or TabCommandInputs.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
isVisible Gets or sets if this input will be visible to the user.
maximumValue Gets and sets maximum value of the slider. This will fail if there is a value list because the minimum and maximum values are defined by the value list.
minimumValue Gets and sets minimum value of the slider. This will fail if there is a value list because the minimum and maximum values are defined by the value list.
name Gets the user visible name of this input.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
parentCommand Gets the parent Command.
parentCommandInput Gets the parent CommandInput if this commandInput is the child of a TabCommandInput or GroupCommandInput. Returns null if there is no parent.
spinStep Gets and sets the spin step. This defines the amount the slider moves when the user clicks the spin button beside the value. The spin step should be more than zero.
toolClipFilename Gets or sets the full filename of the image file (PNG) used for the tool clip. The tooltip is always shown but as the user hovers over the control it will progressively display the tool clip and description text.
tooltip Gets or sets the base tooltip string. This is always shown for commands. If the tooltip description and/or tool clip are also specified then the tooltip will progressively display more information as the user hovers the mouse over the control.
tooltipDescription Gets or sets additional text to display progressively along with the tooltip. The text for the description can contain some basic HTML formatting tags to format the tags. For example the br tag can be used to create multiple paragraphs. The tooltip is always shown but as the user hovers over the control it will progressively display the tool clip and description text.
unitType Gets and sets the unit type that is used when evaluating the user's input.
valueList Gets the value list of the slider. The list is empty if this command input was not added by value list.
valueOne Gets or sets the value associated with the first slider.
valueTwo If the hasTwoSliders property is true, this returns the value associated with the second slider.

Accessed From

CommandInputs.addIntegerSliderCommandInput, CommandInputs.addIntegerSliderListCommandInput

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