Class FileDialogManager

A manager for the FileDialog class.

Inheritance

System.Object

FileDialogManager

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dalamud.Interface.ImGuiFileDialog

Assembly: Dalamud.dll

Syntax

public class FileDialogManager

Fields

| Improve this Doc View Source

AddedWindowFlags

Additional flags with which to draw the window.

Declaration

public ImGuiWindowFlags AddedWindowFlags

Field Value

Type	Description
ImGuiWindowFlags

| Improve this Doc View Source

CustomSideBarItems

Additional quick access items for the side bar.

Declaration

public readonly List<(string Name, string Path, FontAwesomeIcon Icon, int Position)> CustomSideBarItems

Field Value

Type	Description
System.Collections.Generic.List<System.ValueTuple<System.String, System.String, FontAwesomeIcon, System.Int32>>

Methods

| Improve this Doc View Source

Draw()

Draws the current dialog, if any, and executes the callback if it is finished.

Declaration

public void Draw()

| Improve this Doc View Source

OpenFileDialog(String, String, Action<Boolean, List<String>>, Int32, String, Boolean)

Create a dialog which selects already existing files.

Declaration

public void OpenFileDialog(string title, string filters, Action<bool, List<string>> callback, int selectionCountMax, string startPath = null, bool isModal = false)

Parameters

Type	Name	Description
System.String	title	The header title of the dialog.
System.String	filters	Which files to show in the dialog.
System.Action<System.Boolean, System.Collections.Generic.List<System.String>>	callback	The action to execute when the dialog is finished.
System.Int32	selectionCountMax	The maximum amount of files or directories which can be selected. Set to 0 for an infinite number.
System.String	startPath	The directory which the dialog should start inside of. The last path this manager was in is used if this is null.
System.Boolean	isModal	Whether the dialog should be a modal popup.

| Improve this Doc View Source

OpenFileDialog(String, String, Action<Boolean, String>)

Create a dialog which selects a single, already existing file.

Declaration

public void OpenFileDialog(string title, string filters, Action<bool, string> callback)

Parameters

Type	Name	Description
System.String	title	The header title of the dialog.
System.String	filters	Which files to show in the dialog.
System.Action<System.Boolean, System.String>	callback	The action to execute when the dialog is finished.

| Improve this Doc View Source

OpenFolderDialog(String, Action<Boolean, String>)

Create a dialog which selects an already existing folder.

Declaration

public void OpenFolderDialog(string title, Action<bool, string> callback)

Parameters

Type	Name	Description
System.String	title	The header title of the dialog.
System.Action<System.Boolean, System.String>	callback	The action to execute when the dialog is finished.

| Improve this Doc View Source

OpenFolderDialog(String, Action<Boolean, String>, String, Boolean)

Create a dialog which selects an already existing folder.

Declaration

public void OpenFolderDialog(string title, Action<bool, string> callback, string startPath, bool isModal = false)

Parameters

Type	Name	Description
System.String	title	The header title of the dialog.
System.Action<System.Boolean, System.String>	callback	The action to execute when the dialog is finished.
System.String	startPath	The directory which the dialog should start inside of. The last path this manager was in is used if this is null.
System.Boolean	isModal	Whether the dialog should be a modal popup.

| Improve this Doc View Source

Reset()

Removes the current dialog, if any.

Declaration

public void Reset()

| Improve this Doc View Source

SaveFileDialog(String, String, String, String, Action<Boolean, String>)

Create a dialog which selects an already existing folder or new file.

Declaration

public void SaveFileDialog(string title, string filters, string defaultFileName, string defaultExtension, Action<bool, string> callback)

Parameters

Type	Name	Description
System.String	title	The header title of the dialog.
System.String	filters	Which files to show in the dialog.
System.String	defaultFileName	The default name to use when creating a new file.
System.String	defaultExtension	The extension to use when creating a new file.
System.Action<System.Boolean, System.String>	callback	The action to execute when the dialog is finished.

| Improve this Doc View Source

SaveFileDialog(String, String, String, String, Action<Boolean, String>, String, Boolean)

Create a dialog which selects an already existing folder or new file.

Declaration

public void SaveFileDialog(string title, string filters, string defaultFileName, string defaultExtension, Action<bool, string> callback, string startPath, bool isModal = false)

Parameters

Type	Name	Description
System.String	title	The header title of the dialog.
System.String	filters	Which files to show in the dialog.
System.String	defaultFileName	The default name to use when creating a new file.
System.String	defaultExtension	The extension to use when creating a new file.
System.Action<System.Boolean, System.String>	callback	The action to execute when the dialog is finished.
System.String	startPath	The directory which the dialog should start inside of. The last path this manager was in is used if this is null.
System.Boolean	isModal	Whether the dialog should be a modal popup.

| Improve this Doc View Source

SaveFolderDialog(String, String, Action<Boolean, String>)

Create a dialog which selects an already existing folder or new folder.

Declaration

public void SaveFolderDialog(string title, string defaultFolderName, Action<bool, string> callback)

Parameters

Type	Name	Description
System.String	title	The header title of the dialog.
System.String	defaultFolderName	The default name to use when creating a new folder.
System.Action<System.Boolean, System.String>	callback	The action to execute when the dialog is finished.

| Improve this Doc View Source

SaveFolderDialog(String, String, Action<Boolean, String>, String, Boolean)

Create a dialog which selects an already existing folder or new folder.

Declaration

public void SaveFolderDialog(string title, string defaultFolderName, Action<bool, string> callback, string startPath, bool isModal = false)

Parameters

Type	Name	Description
System.String	title	The header title of the dialog.
System.String	defaultFolderName	The default name to use when creating a new folder.
System.Action<System.Boolean, System.String>	callback	The action to execute when the dialog is finished.
System.String	startPath	The directory which the dialog should start inside of. The last path this manager was in is used if this is null.
System.Boolean	isModal	Whether the dialog should be a modal popup.