A newer version of Max is available. Click here to access the latest version of the documentation

opendialog Reference

Open a dialog to ask for a file or folder

opendialog

Description

Use the opendialog object to select a file of a specific type or folder from a standard dialog window. To choose a folder, use the "fold" type. opendialog reports the entire pathname of the file or folder chosen, which can be passed to any Max object after the word read or load.

Examples

Look for folders or a certain kind of file

Arguments

folder [symbol]

Optional

Sets opendialog to choose folders only

soundfile [symbol]

Optional

Use this argument to list audio files (AIFF, NeXT/Sun, and WAV, along with some generic data file types). Jitter Appendix A lists all the files that can be opened.

file-types [symbol]

Optional

One or more symbols set the list of file types or file extensions (beginning with '.') that determine which files are listed by the opendialog object.

Attributes

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

bang

Opens a standard Open Document dialog window for choosing a file or folder.

anything

Arguments

filetype [list]
One or more symbols are interpreted as one or more type codes used to determine which files are listed by the opendialog object. Example type codes for files are TEXT for text files, maxb for Max binary format patcher files, .maxpat for modern Max patcher files, and AIFF for AIFF format audio files. types with no arguments makes the object accept all file types, which is the default setting.

path

Arguments

filepath [symbol]
Opens a a standard dialog window to the specified path, if valid, and caches the path for any subsequent opening via the bang message. Omitting the filepath argument unsets any path previously set.

set

Arguments

filetype [list]
The word set, followed by one or more four-letter filetype codes or file extensions (beginning with '.') sets the opendialog object to search for the specified file type(s) or extension(s) without opening a dialog window. Example type codes for files are TEXT for text files, maxb for Max binary format patcher files, .maxpat for modern Max patcher files, and AIFF for AIFF format audio files. set with no arguments makes the object accept all file types, which is the default setting.

setpath

Arguments

filepath [symbol]
Specifies a file path to use when the standard dialog window is opened with the bang message, if the path is valid. Omitting the filepath argument unsets any path previously set.

sound

Sets opendialog to list audio files (AIFF, NeXT/Sun, and WAV, along with some generic data file types) and opens a standard dialog window. Jitter Appendix A lists all the files that can be opened.

types

Arguments

filetype [list]
The word types, followed by one or more four-letter filetype codes sets the opendialog object to search for the specified file type(s) or extension(s) and opens a standard dialog window. Example type codes for files are TEXT for text files, maxb for Max binary format patcher files, .maxpat for modern Max patcher files, and AIFF for AIFF format audio files. types with no arguments makes the object accept all file types, which is the default setting.

Output

bang

If the dialog box is cancelled by the user, a bang message is sent out the right outlet.

symbol

Out left outlet: The absolute pathname of the file chosen by the user as a symbol. The output pathnames contain slash separators.

Absolute pathnames look like this:

"C:/Max Folder/extras/mystuff/mypatch.pat"

The conformpath object can be used to convert paths of one pathtype and/or pathstyle to another.

See Also

Name Description
Search Paths Search Paths
conformpath Convert file paths styles
dialog Open a dialog box
dropfile Drag and drop files
date Report current date and time
filedate Report the modification date of a file
filein Read and access a file of binary data
filepath Manage and report on the Max search path
folder List the files in a folder
savedialog Open a dialog asking for a filename
strippath Separate filename from a full pathname