Class OpenDialog

The OpenDialogprovides an interactive dialog box for users to select files or directories.
Inheritance
System.Object
Responder
View
Toplevel
Window
Dialog
FileDialog
OpenDialog
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Remarks

The open dialog can be used to select files for opening, it can be configured to allow multiple items to be selected (based on the AllowsMultipleSelection) variable and you can control whether this should allow files or directories to be selected.

To use, create an instance of OpenDialog, and pass it to Run(Func<Exception, Boolean>). This will run the dialog modally, and when this returns, the list of files will be available on the FilePaths property.

To select more than one file, users can use the spacebar, or control-t.

Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class OpenDialog : FileDialog

Constructors

OpenDialog()

Initializes a new OpenDialog.
Declaration
public OpenDialog()

OpenDialog(ustring, ustring, List<String>, OpenDialog.OpenMode)

Initializes a new OpenDialog.
Declaration
public OpenDialog(ustring title, ustring message, List<string> allowedTypes = null, OpenDialog.OpenMode openMode)
Parameters
Type Name Description
NStack.ustring title The title.
NStack.ustring message The message.
System.Collections.Generic.List<System.String> allowedTypes The allowed types.
OpenDialog.OpenMode openMode The open mode.

Properties

AllowsMultipleSelection

Gets or sets a value indicating whether this OpenDialog allows multiple selection.
Declaration
public bool AllowsMultipleSelection { get; set; }
Property Value
Type Description
System.Boolean true if allows multiple selection; otherwise, false, defaults to false.

CanChooseDirectories

Gets or sets a value indicating whether this OpenDialog can choose directories.
Declaration
public bool CanChooseDirectories { get; set; }
Property Value
Type Description
System.Boolean true if can choose directories; otherwise, false defaults to false.

CanChooseFiles

Gets or sets a value indicating whether this OpenDialog can choose files.
Declaration
public bool CanChooseFiles { get; set; }
Property Value
Type Description
System.Boolean true if can choose files; otherwise, false. Defaults to true

FilePaths

Returns the selected files, or an empty list if nothing has been selected
Declaration
public IReadOnlyList<string> FilePaths { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.String> The file paths.

Implements

System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize