SelectionFilterSettings.isFilterEnabled Method

Parent Object: SelectionFilterSettings

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.


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

Description

Gets whether a selection filter category is currently enabled.

Syntax

"selectionFilterSettings_var" is a variable referencing a SelectionFilterSettings object.

returnValue = selectionFilterSettings_var.isFilterEnabled(filterId)
"selectionFilterSettings_var" is a variable referencing a SelectionFilterSettings object.

#include <Core/UserInterface/SelectionFilterSettings.h>

returnValue = selectionFilterSettings_var->isFilterEnabled(filterId);
"selectionFilterSettings_var" is a variable referencing a SelectionFilterSettings object.

returnValue = selectionFilterSettings_var.isFilterEnabled(filterId);

Return Value

Type Description
boolean Returns true if the filter is enabled, false if it is disabled. An error occurs if the filterId does not match any available filter.

Parameters

Name Type Description
filterId string The name of the selection filter category, as returned by the availableFilters property.

Version

Introduced in version July 2026