dropfile
Max Reference
Open Help

dropfile

Drag and drop files

Description

dropfile defines a region for dragging and dropping files into and then outputs the filepath and filetype upon file input.

Examples

Arguments

None.

Attributes

border [float] (default: 2.)

Sets the size in pixels of the dropfile object's border.

bordercolor [4 floats]

Sets the color of the dropfile border in RGBA format.

folderslash [int] (default: 1)

Toggles adding a slash character ( / ) at the end of a folder name when output is triggered.

rounded [float] (default: 8.)

Sets the amount in pixels by which to round the corners of the dropfile object.

types [64 symbols]

The word types , followed by one or more four-letter filetype codes sets the dropfile object to search for the specified file type(s) and opens a standard dialog window. Example type codes for files are TEXT for text files, maxb for Max binary format 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.

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.

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 [float]

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

textjustification [int]

Text Justification

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

(drag)

When a file icon is dragged from the Finder or Max File Browser onto a dropfile object in a locked patcher window, the object checks the file's type against those that it has been told to accept. If the file is of an acceptable type, the outline of the dropfile box is highlighted. If the mouse button is released while the cursor is inside the dropfile box, the dropfile object outputs the type and full pathname of the file out its outlets.

Output

any symbol

Out right outlet: The four-letter filetype code of the acceptable file is sent out the right outlet.

symbol

Out left outlet: When an acceptable file icon has been dragged onto dropfile and the mouse released within its box, the absolute pathname of the file is sent out as a single 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.

When aliases of folders are dragged onto dropfile, the aliases are resolved to create the output path.

If you want to use the dropfile object to cause a file to be read by another object that accepts the read message with a filename argument, put a prepend read object between dropfile and the object that will open a file, as shown in the example.

See Also

Name Description
absolutepath Convert a file name to an absolute path
filepath Manage and report on the Max search path
folder List the files in a folder
opendialog Open a dialog to ask for a file or folder
relativepath Convert an absolute to a relative path
strippath Separate filename from a full pathname