Go to: Synopsis. Return value. Flags. Python examples.
fileBrowserDialog([actionName=string], [dialogStyle=int], [fileCommand=script], [fileType=string], [filterList=string], [includeName=string], [mode=int], [operationMode=string], [tipMessage=string], [windowTitle=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
fileBrowserDialog is undoable, NOT queryable, and NOT editable.
The fileBrowserDialog and fileDialog commands have now been deprecated.
Both commands are still callable, but it is recommended that the fileDialog2 command
be used instead. To maintain some backwards compatibility, both fileBrowserDialog and
fileDialog will convert the flags/values passed to them into the appropriate flags/values
that the fileDialog2 command uses and will call that command internally. It is not
guaranteed that this compatibility will be able to be maintained in future versions so
any new scripts that are written should use fileDialog2.
See below for an example of how to change a script to use fileDialog2.
actionName, dialogStyle, fileCommand, fileType, filterList, includeName, mode, operationMode, tipMessage, windowTitle
| Long name (short name) |
Argument types |
Properties |
|
actionName(an)
|
string
|
|
|
Script to be called when the file is validated.
|
|
dialogStyle(ds)
|
int
|
|
|
- 0 for old style dialog
- 1 for Windows 2000 style Explorer style
- 2 for Explorer style with "Shortcut" tip at bottom
|
|
fileCommand(fc)
|
script
|
|
|
The script to run on command action
|
|
fileType(ft)
|
string
|
|
|
Set the type of file to filter. By default this can be any one of:
"mayaAscii", "mayaBinary", "mel", "OBJ", "directory", "plug-in", "audio", "move", "EPS", "Illustrator", "image".
plug-ins may define their own types as well.
|
|
filterList(fl)
|
string
|
|
|
Specify file filters. Used with dialog style
1 and 2. Each string should be a description followed by a
comma followed by a semi-colon separated list of file
extensions with wildcard.
|
|
includeName(includeName)
|
string
|
|
|
Include the given string after the actionName in parentheses.
If the name is too long, it will be shortened to fit on the
dialog (for example, /usr/alias/commands/scripts/fileBrowser.mel
might be shortened to /usr/...pts/fileBrowser.mel)
|
|
mode(m)
|
int
|
|
|
Defines the mode in which to run the file brower:
- 0 for read
- 1 for write
- 2 for write without paths (segmented files)
- 4 for directories have meaning when used with the action
+100 for returning short names
|
|
operationMode(om)
|
string
|
|
|
Enables the option dialog. Valid strings are:
- "Import"
- "Reference"
- "SaveAs"
- "ExportAll"
- "ExportActive"
|
|
tipMessage(tm)
|
string
|
|
|
Message to be displayed at the bottom of the style 2 dialog box.
|
|
windowTitle(wt)
|
string
|
|
|
Set the window title of a style 1 or 2 dialog box
|
|
|
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
# Old way:
def importImage( fileName, fileType):
cmds.file( fileName, i=True );
return 1
cmds.fileBrowserDialog( m=0, fc=importImage, ft='image', an='Import_Image', om='Import' )
# Recommended way:
filename = cmds.fileDialog2(fileMode=1, caption="Import Image")
cmds.file( filename[0], i=True );