Interface IDialogsFactory

Describes object providing methods for dialog based actions.

Methods

ActivateGlobalProgress(Action<GlobalProgressActionArgs>, GlobalProgressOptions)

Activates progress dialog blocking app interaction until progress is finished or canceled.

Parameters

Type	Name	Description
System.Action<GlobalProgressActionArgs>	progresAction	Action to be executed.
GlobalProgressOptions	progressOptions	Options for progress dialog.

Returns

Type	Description
GlobalProgressResult	Status of the action execution.

ActivateGlobalProgress(Func<GlobalProgressActionArgs, Task>, GlobalProgressOptions)

Activates progress dialog blocking app interaction until progress is finished or canceled.

Parameters

Type	Name	Description
System.Func<GlobalProgressActionArgs, System.Threading.Tasks.Task>	progresAction	Awaitable function to be executed.
GlobalProgressOptions	progressOptions	Options for progress dialog.

Returns

Type	Description
GlobalProgressResult	Status of the action execution.

CreateWindow(WindowCreationOptions)

Creates new window with Playnite's default styling applied.

Parameters

Type	Name	Description
WindowCreationOptions	options	Custom window options.

Returns

Type	Description
System.Windows.Window	New window instance.

GetCurrentAppWindow()

Gets currently active window. If no window is active, main window is returned instead.

Returns

Type	Description
System.Windows.Window	Window object.

ChooseImageFile(List<ImageFileOption>, String, Double, Double)

Displays dialog with an option to choose single image.

Parameters

Type	Name	Description
System.Collections.Generic.List<ImageFileOption>	files
System.String	caption
System.Double	itemWidth
System.Double	itemHeight

Returns

Type	Description
ImageFileOption	Null if dialog was canceled otherwise selected ImageFileOption object.

ChooseItemWithSearch(List<GenericItemOption>, Func<String, List<GenericItemOption>>, String, String)

Displays dialog with an option to choose single item and option to search for different items.

Parameters

Type	Name	Description
System.Collections.Generic.List<GenericItemOption>	items
System.Func<System.String, System.Collections.Generic.List<GenericItemOption>>	searchFunction
System.String	defaultSearch
System.String	caption

Returns

Type	Description
GenericItemOption	Null if dialog was canceled otherwise selected GenericItemOption object.

SaveFile(String)

Displays system file save dialog.

Parameters

Type	Name	Description
System.String	filter	File filter, for example "ZIP Archive|*.zip"

Returns

Type	Description
System.String	Selected file path or empty string if user cancels the dialog.

SaveFile(String, Boolean)

Displays system file save dialog.

Parameters

Type	Name	Description
System.String	filter	File filter, for example "ZIP Archive|*.zip"
System.Boolean	promptOverwrite	Indicates whether to ask user for file overrite if selected path exists.

Returns

Type	Description
System.String	Selected file path or empty string if user cancels the dialog.

SelectFile(String)

Displays system open file dialog.

Parameters

Type	Name	Description
System.String	filter	File filter, for example "ZIP Archive|*.zip"

Returns

Type	Description
System.String	Selected file path or empty string if user cancels the dialog.

SelectFiles(String)

Displays system open file dialog allowing to select multiple files.

Parameters

Type	Name	Description
System.String	filter	File filter, for example "ZIP Archive|*.zip"

Returns

Type	Description
System.Collections.Generic.List<System.String>	List of paths or null if user cancels the dialog.

SelectFolder()

Displays system dialog for folder selection.

Returns

Type	Description
System.String	Selected folder path or empty string if user cancels the dialog.

SelectIconFile()

Displays file open dialog with file filter set to show only image files used for icons.

Returns

Type	Description
System.String	Selected icon path or empty string if user cancels the dialog.

SelectImagefile()

Displays file open dialog with file filter set to show only image files.

Returns

Type	Description
System.String	Selected image path or empty string if user cancels the dialog.

SelectString(String, String, String)

Displays dialog asking user to input text string.

Parameters

Type	Name	Description
System.String	messageBoxText	Dialog message text.
System.String	caption	Dialog window caption.
System.String	defaultInput	Default string presented in input field.

Returns

Type	Description
StringSelectionDialogResult	Selection result.

SelectString(String, String, String, List<MessageBoxToggle>)

Parameters

Type	Name	Description
System.String	messageBoxText
System.String	caption
System.String	defaultInput
System.Collections.Generic.List<MessageBoxToggle>	options

Returns

Type	Description
StringSelectionDialogResult

ShowErrorMessage(String)

Displays error dialog window with text message.

Parameters

Type	Name	Description
System.String	messageBoxText	Dialog message text.

Returns

Type	Description
System.Windows.MessageBoxResult

ShowErrorMessage(String, String)

Displays error dialog window with text message.

Parameters

Type	Name	Description
System.String	messageBoxText	Dialog message text.
System.String	caption	Dialog window caption.

Returns

Type	Description
System.Windows.MessageBoxResult

ShowMessage(String)

Displays dialog window with text message.

Parameters

Type	Name	Description
System.String	messageBoxText	Dialog message text.

Returns

Type	Description
System.Windows.MessageBoxResult	Selected dialog response.

ShowMessage(String, String)

Displays dialog window with text message.

Parameters

Type	Name	Description
System.String	messageBoxText	Dialog message text.
System.String	caption	Dialog window caption.

Returns

Type	Description
System.Windows.MessageBoxResult	Selected dialog response.

ShowMessage(String, String, MessageBoxButton)

Displays dialog window with text message.

Parameters

Type	Name	Description
System.String	messageBoxText	Dialog message text.
System.String	caption	Dialog window caption.
System.Windows.MessageBoxButton	button	Available response button.

Returns

Type	Description
System.Windows.MessageBoxResult	Selected dialog response.

ShowMessage(String, String, MessageBoxButton, MessageBoxImage)

Displays dialog window with text message.

Parameters

Type	Name	Description
System.String	messageBoxText	Dialog message text.
System.String	caption	Dialog window caption.
System.Windows.MessageBoxButton	button	Available response button.
System.Windows.MessageBoxImage	icon	Dialog icon.

Returns

Type	Description
System.Windows.MessageBoxResult	Selected dialog response.

ShowMessage(String, String, MessageBoxImage, List<MessageBoxOption>)

Displays dialog window custom response options.

Parameters

Type	Name	Description
System.String	messageBoxText	Dialog message text.
System.String	caption	Dialog window caption.
System.Windows.MessageBoxImage	icon	Dialog icon.
System.Collections.Generic.List<MessageBoxOption>	options	Response options.

Returns

Type	Description
MessageBoxOption	Selected dialog option.

ShowSelectableString(String, String, String)

Displays dialog with textbox allowing to select/copy text.

Parameters

Type	Name	Description
System.String	messageBoxText	Dialog message text.
System.String	caption	Dialog window caption.
System.String	defaultInput	String added into selectable field.