SelectionFilterSettings.registerCustomGraphicsFilter Method

Parent Object: SelectionFilterSettings

Preview This 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

Registers a custom graphics selection sub-filter for this workspace. The filter matches custom graphics entities whose id starts with the given prefix and appears as a separate entry in the selection filter dropdown.

"selectionFilterSettings_var" is a variable referencing a SelectionFilterSettings object.

returnValue = selectionFilterSettings_var.registerCustomGraphicsFilter(displayName, idPrefix)

"selectionFilterSettings_var" is a variable referencing a SelectionFilterSettings object.

#include <Core/UserInterface/SelectionFilterSettings.h>

returnValue = selectionFilterSettings_var->registerCustomGraphicsFilter(displayName, idPrefix);

"selectionFilterSettings_var" is a variable referencing a SelectionFilterSettings object.

returnValue = selectionFilterSettings_var.registerCustomGraphicsFilter(displayName, idPrefix);

Return Value

Type	Description
boolean	Returns true if the filter was registered successfully, or false if a filter with the same displayName is already registered for this workspace.

Parameters

Name	Type	Description
displayName	string	The user-visible name shown in the selection filter dropdown.
idPrefix	string	The prefix to match against each custom graphics entity's id property.

Version

Introduced in version July 2026