Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

fileDialog2([cancelCaption=string], [caption=string], [dialogStyle=int], [fileFilter=string], [fileMode=int], [fileTypeChanged=string], [okCaption=string], [optionsUICommit=string], [optionsUICreate=boolean], [optionsUIInit=string], [returnFilter=boolean], [selectFileFilter=string], [selectionChanged=string], [startingDirectory=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

fileDialog2 is undoable, NOT queryable, and NOT editable.

This command provides a dialog that allows users to select files or directories.

Return value

stringarray

Flags

cancelCaption, caption, dialogStyle, fileFilter, fileMode, fileTypeChanged, okCaption, optionsUICommit, optionsUICreate, optionsUIInit, returnFilter, selectFileFilter, selectionChanged, startingDirectory
Long name (short name) Argument types Properties
dialogStyle(ds) int create
  • 1 On Windows or Mac OS X will use a native style file dialog.
  • 2 Use a custom file dialog with a style that is consistent across platforms.
caption(cap) string create
Provide a title for the dialog.
startingDirectory(dir) string create
Provide the starting directory for the dialog.
fileFilter(ff) string create
Provide a list of file type filters to the dialog. Multiple filters should be separated by double semi-colons. See the examples section.
selectFileFilter(sff) string create
Specify the initial file filter to select. Specify just the begining text and not the full wildcard spec.
fileMode(fm) int create
Indicate what the dialog is to return.
  • 0 Any file, whether it exists or not.
  • 1 A single existing file.
  • 2 The name of a directory. Both directories and files are displayed in the dialog.
  • 3 The name of a directory. Only directories are displayed in the dialog.
  • 4 Then names of one or more existing files.
okCaption(okc) string create
If the dialogStyle flag is set to 2 then this provides a caption for the OK, or Accept, button within the dialog.
cancelCaption(cc) string create
If the dialogStyle flag is set to 2 then this provides a caption for the Cancel button within the dialog.
returnFilter(rf) boolean create
If true, the selected filter will be returned as the last item in the string array along with the selected files.
optionsUICreate(ocr) boolean create
MEL only. The string is interpreted as a MEL callback, to be called on creation of the file dialog. The callback is of the form:

global proc MyCustomOptionsUISetup(string $parent)

The parent argument is the parent layout into which controls can be added. This parent is the right-hand pane of the file dialog.

optionsUIInit(oin) string create
MEL only. The string is interpreted as a MEL callback, to be called just after file dialog creation, to initialize controls. The callback is of the form:

global proc MyCustomOptionsUIInitValues(string $parent, string $filterType)

The parent argument is the parent layout into which controls have been added using the optionsUICreate flag. The filterType argument is the initial file filter.

fileTypeChanged(ftc) string create
MEL only. The string is interpreted as a MEL callback, to be called when the user-selected file type changes. The callback is of the form:

global proc MyCustomFileTypeChanged(string $parent, string $newType)

The parent argument is the parent layout into which controls have been added using the optionsUICreate flag. The newType argument is the new file type.

selectionChanged(sc) string create
MEL only. The string is interpreted as a MEL callback, to be called when the user changes the file selection in the file dialog. The callback is of the form:

global proc MyCustomSelectionChanged(string $parent, string $selection)

The parent argument is the parent layout into which controls have been added using the optionsUICreate flag. The selection argument is the full path to the newly-selected file.

optionsUICommit(ocm) string create
MEL only. The string is interpreted as a MEL callback, to be called when the dialog is successfully dismissed. It will not be called if the user cancels the dialog, or closes the window using window title bar controls or other window system means. The callback is of the form:

global proc MyCustomOptionsUICommit(string $parent)

The parent argument is the parent layout into which controls have been added using the optionsUICreate flag.

Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

import maya.cmds as cmds
basicFilter = "*.mb"
cmds.fileDialog2(fileFilter=basicFilter, dialogStyle=2)
singleFilter = "All Files (*.*)"
cmds.fileDialog2(fileFilter=singleFilter, dialogStyle=2)
multipleFilters = "Maya Files (*.ma *.mb);;Maya ASCII (*.ma);;Maya Binary (*.mb);;All Files (*.*)"
cmds.fileDialog2(fileFilter=multipleFilters, dialogStyle=2)