savedialog Reference

Open a dialog asking for a filename

savedialog

Description

Opens a file dialog for selection or entry of a filename to write. savedialog takes a list of one or more file types and allows you to save a file and choose a type for it.

Examples

Select a folder or a specific file type for file saving

Discussion

To choose a folder, use the "fold" type. savedialog reports the entire pathname of the file or folder chosen, which can be passed to any Max object after the word write or save.

Arguments

filetypes [symbol]

Optional

Sets one or more file types that will be displayed as choices for the user. The symbol fold specifies that the dialog box should let the user choose only folders.

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

Causes a standard Save As dialog box to appear, allowing the user to type in a filename and choose a folder location. The resulting location and filename are output as a symbol.

anything

Arguments

filetype [list]
One or more four-letter filetype codes sets the list of types displayed in the dialog box. Example type codes for files are TEXT for text files, maxb for Max binary format patcher files, and AIFF for AIFF format audio files. The symbol fold specifies that the dialog box should let the user choose only folders.

name

Arguments

filename [symbol]
The word name, followed by a symbol, specifies a default file name.

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 a four-letter filetype codes, sets the savedialog object to display the desired file type without opening the dialog box. The chosen file type is sent out the middle outlet when the user chooses Save in the dialog box.

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.

Output

bang

Out right outlet: If the user chooses Cancel in the dialog box, or an error occurs, a bang is sent out.

symbol

Out left outlet: The absolute pathname of the file 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.

symbol

Out middle outlet: The four-letter filetype code which specifies the filetype currently selected.

See Also

Name Description
conformpath Convert file paths styles
dialog Open a dialog box
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
opendialog Open a dialog to ask for a file or folder