Class FileDialogManager
A manager for the Dalamud.Interface.ImGuiFileDialog.FileDialog class.
Assembly: Dalamud.dll​
public class FileDialogManager
Properties​
GetDefaultSortOrder​
Gets or sets a function that returns the desired default sort order in the file dialog.
public Func<FileDialog.SortingField>? GetDefaultSortOrder { get; set; }
SetDefaultSortOrder​
Gets or sets an action to invoke when a file dialog changes its sort order.
public Action<FileDialog.SortingField>? SetDefaultSortOrder { get; set; }
Fields​
CustomSideBarItems​
Additional quick access items for the sidebar.
public readonly List<(string Name, string Path, FontAwesomeIcon Icon, int Position)> CustomSideBarItems
AddedWindowFlags​
Additional flags with which to draw the window.
public ImGuiWindowFlags AddedWindowFlags
Methods​
OpenFolderDialog(string, Action<bool, string>)​
Create a dialog which selects an already existing folder.
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. |
OpenFolderDialog(string, Action<bool, string>, string?, bool)​
Create a dialog which selects an already existing folder.
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. |
SaveFolderDialog(string, string, Action<bool, string>)​
Create a dialog which selects an already existing folder or new folder.
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. |
SaveFolderDialog(string, string, Action<bool, string>, string?, bool)​
Create a dialog which selects an already existing folder or new folder.
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. |
OpenFileDialog(string, string, Action<bool, string>)​
Create a dialog which selects a single, already existing file.
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. |
OpenFileDialog(string, string, Action<bool, List<string>>, int, string?, bool)​
Create a dialog which selects already existing files.
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. |
SaveFileDialog(string, string, string, string, Action<bool, string>)​
Create a dialog which selects an already existing folder or new file.
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. |
SaveFileDialog(string, string, string, string, Action<bool, string>, string?, bool)​
Create a dialog which selects an already existing folder or new file.
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. |
Draw()​
Draws the current dialog, if any, and executes the callback if it is finished.
public void Draw()
Reset()​
Removes the current dialog, if any.
public void Reset()
Events​
SelectionChanged​
Event fires when a new file is selected by the user
public event EventHandler<string>? SelectionChanged
Event Type​
System.EventHandler<System.String>: Returns the path of the file as a string