Go to: Synopsis. Return value. Flags. Python examples.
fileDialog2([cancelCaption=string], [caption=string], [dialogStyle=int], [fileFilter=string], [fileMode=int], [okCaption=string], [returnFilter=boolean], [selectFileFilter=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.
cancelCaption, caption, dialogStyle, fileFilter, fileMode, okCaption, returnFilter, selectFileFilter, startingDirectory
Long name (short name) |
Argument types |
Properties |
dialogStyle(ds) |
int |
|
|
- 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 |
|
|
Provide a title for the dialog. |
|
startingDirectory(dir) |
string |
|
|
Provide the starting directory for the dialog. |
|
fileFilter(ff) |
string |
|
|
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 |
|
|
Specify the initial file filter to select. Specify just the
begining text and not the full wildcard spec. |
|
fileMode(fm) |
int |
|
|
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 |
|
|
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 |
|
|
If the dialogStyle flag is set to 2 then this provides a
caption for the Cancel button within the dialog. |
|
returnFilter(rf) |
boolean |
|
|
If true, the selected filter will be returned as the last item
in the string array along with the selected files. |
|
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. |
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)