SelectionCommandInput.addSelectionFilter Method

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

Description

Adds an additional filter to the existing filter list.

Syntax

"selectionCommandInput_var" is a variable referencing a SelectionCommandInput object.
returnValue = selectionCommandInput_var.addSelectionFilter(filter)
"selectionCommandInput_var" is a variable referencing a SelectionCommandInput object.

#include <Core/UserInterface/SelectionCommandInput.h>

returnValue = selectionCommandInput_var->addSelectionFilter(filter);

Return Value

Type Description
boolean Returns true if the filter was added successfully.

Parameters

Name Type Description
filter string The name of a selection filter to add. The valid list of selection filters can be found here: Selection Filters.

Samples

Name Description
Selection Events API Sample The sample demos how to use selection events of a command.

Version

Introduced in version August 2014