uigetfile
Display standard dialog box for retrieving files
Syntax
-
uigetfile
uigetfile('FilterSpec
') uigetfile('FilterSpec
','DialogTitle
') uigetfile('FilterSpec
','DialogTitle
','DefaultName'
) uigetfile(...,'Location',[x y]) uigetfile(...,'MultiSelect',selectmode) [FileName,PathName] = uigetfile(...) [FileName,PathName,FilterIndex] = uigetfile(...)
Description
uigetfile
displays a dialog box used to retrieve one or more files. The dialog box lists the files and directories in the current directory.
uigetfile('FilterSpec')
displays a dialog box that lists files in the current directory. FilterSpec
determines the initial display of files and can include the *
wildcard. For example, '
*.m'
lists all the MATLAB M-files.
If FilterSpec
is a string or cell array, uigetfile
appends 'All Files'
to the list of file types. If FilterSpec
is a cell array, the first column contains the list of extensions, and the second column contains the list of descriptions. FilterSpec
can also be a filename. In this case the filename becomes the default filename and the file's extension is used as the default filter. If FilterSpec
is not specified, uigetfile
uses the default list of file types (i.e., all MATLAB files).
uigetfile('FilterSpec','DialogTitle')
displays a dialog box that has the title DialogTitle
.
uigetfile('FilterSpec','DialogTitle','DefaultName')
displays a dialog box in which a specified string, in this case 'DefaultName'
, appears in the File name field. 'Default Name'
can be a filename or the name of a directory. If it is the name of a directory, you must follow it with a slash (/)
or backslash (\)
separator.
uigetfile(...,'Location',[x y])
positions the dialog box at position [x,y]
, where x
and y
are the distances in pixel units from the left and top edges of the screen. This feature is supported only on UNIX platforms.
uigetfile(...,'MultiSelect',selectmode)
specifies if multiple file selection is enabled for the uigetfile
dialog. Valid values for selectmode
are 'on'
and 'off'
(default). If the value of 'MultiSelect'
is 'on'
and the user selects more than one file in the dialog box, then FileName
is a cell array of strings, each of which represents the name of a selected file. Otherwise, Filename
is a string representing the selected filename. Because multiple selections are always in the same directory, PathName
is always a string that represents a single directory.
[FileName,PathName] = uigetfile(...)
returns the name and path of the file selected in the dialog box. After the user clicks the Done button, FileName
contains the name of the file selected and PathName
contains the name of the path selected. If the user clicks the Cancel button or closes the dialog window, FileName
and PathName
are set to 0
.
[FileName,PathName,FilterIndex] = uigetfile(...)
returns the index of the filter selected in the dialog box. The indexing starts at 1. If the user clicks the Cancel button or closes the dialog window, FilterIndex
is set to 0
.