FileDialog.filterIndex Property

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

Description

Gets or sets the index of the filter currently selected in the file dialog box. Use the FilterIndex property to set which filtering option is shown first to the user. You can also use the value of FilterIndex after showing the file dialog to perform special file operations depending upon the filter chosen. The first item in the filter list is index 0.

Syntax

"fileDialog_var" is a variable referencing a FileDialog object.

# Get the value of the property.
propertyValue = fileDialog_var.filterIndex

# Set the value of the property.
fileDialog_var.filterIndex = propertyValue
"fileDialog_var" is a variable referencing a FileDialog object.
#include <Core/UserInterface/FileDialog.h>

// Get the value of the property.
integer propertyValue = fileDialog_var->filterIndex();

// Set the value of the property, where value_var is an integer.
bool returnValue = fileDialog_var->filterIndex(value_var);

Property Value

This is a read/write property whose value is an integer.

Samples

Name Description
Write user interface to a file API Sample Writes out the full structure of the Fusion user interface. This information is useful when editing the user-interface, as discussed in the usre manual topic User-Interface Customization with Fusion's API

Version

Introduced in version August 2014