Daniel's XL Toolbox NG
Bovender.Mvvm.Actions.FileDialogActionBase Class Referenceabstract

Base class for actions that use dialogs based on System.Windows.Forms.FileDialog. More...

Inheritance diagram for Bovender.Mvvm.Actions.FileDialogActionBase:
Collaboration diagram for Bovender.Mvvm.Actions.FileDialogActionBase:

Protected Member Functions

abstract FileDialog GetDialog (string defaultString, string filter)
 
override string GetDialogResult (string defaultString, string filter)
 Displays an dialog to choose file or folder names. More...
 
override void Invoke (object parameter)
 
abstract FileDialog GetDialog (string defaultString, string filter)
 
override string GetDialogResult (string defaultString, string filter)
 Displays an dialog to choose file or folder names. More...
 
override void Invoke (object parameter)
 
- Protected Member Functions inherited from Bovender.Mvvm.Actions.FileFolderActionBase
override void Invoke (object parameter)
 
override System.Windows.Window CreateView ()
 Returns a view that can bind to expected message contents. More...
 
override void Invoke (object parameter)
 
override System.Windows.Window CreateView ()
 Returns a view that can bind to expected message contents. More...
 
- Protected Member Functions inherited from Bovender.Mvvm.Actions.MessageActionBase
override void Invoke (object parameter)
 Creates a view that has its dependent view model injected into it. More...
 
void Invoke< T > (T messageContent, Action respond)
 
virtual void ShowView (Window view)
 Shows the view as a modal dialog. Override this to do something else with the view. More...
 
override void Invoke (object parameter)
 Creates a view that has its dependent view model injected into it. More...
 
void Invoke< T > (T messageContent, Action respond)
 
virtual void ShowView (Window view)
 Shows the view as a modal dialog. Override this to do something else with the view. More...
 

Properties

string Filter [get, set]
 Filter string for the file dialog. Filter entries consist of a description and an extensions, separated by a pipe symbol; multiple entries are separated by pipe symbols as well: "Image Files(*.BMP;*.JPG;*.GIF)|*.BMP;*.JPG;*.GIF|All files (*.*)|*.*" More...
 
- Properties inherited from Bovender.Mvvm.Actions.FileFolderActionBase
string Description [get, set]
 
StringMessageContent MessageContent [get]
 
- Properties inherited from Bovender.Mvvm.Actions.MessageActionBase
string Caption [get, set]
 
string Message [get, set]
 
MessageContent Content [get, protected set]
 

Detailed Description

Base class for actions that use dialogs based on System.Windows.Forms.FileDialog.

Member Function Documentation

◆ GetDialog() [1/2]

abstract FileDialog Bovender.Mvvm.Actions.FileDialogActionBase.GetDialog ( string  defaultString,
string  filter 
)
protectedpure virtual

◆ GetDialog() [2/2]

abstract FileDialog Bovender.Mvvm.Actions.FileDialogActionBase.GetDialog ( string  defaultString,
string  filter 
)
protectedpure virtual

◆ GetDialogResult() [1/2]

override string Bovender.Mvvm.Actions.FileDialogActionBase.GetDialogResult ( string  defaultString,
string  filter 
)
inlineprotectedvirtual

Displays an dialog to choose file or folder names.

Parameters
defaultStringIndicates the default path and/or file name and/or extension.
Returns
Valid file name/path, or empty string if the dialog was cancelled.

Implements Bovender.Mvvm.Actions.FileFolderActionBase.

◆ GetDialogResult() [2/2]

override string Bovender.Mvvm.Actions.FileDialogActionBase.GetDialogResult ( string  defaultString,
string  filter 
)
inlineprotectedvirtual

Displays an dialog to choose file or folder names.

Parameters
defaultStringIndicates the default path and/or file name and/or extension.
Returns
Valid file name/path, or empty string if the dialog was cancelled.

Implements Bovender.Mvvm.Actions.FileFolderActionBase.

◆ Invoke() [1/2]

override void Bovender.Mvvm.Actions.FileDialogActionBase.Invoke ( object  parameter)
inlineprotected

◆ Invoke() [2/2]

override void Bovender.Mvvm.Actions.FileDialogActionBase.Invoke ( object  parameter)
inlineprotected

Property Documentation

◆ Filter

string Bovender.Mvvm.Actions.FileDialogActionBase.Filter
getset

Filter string for the file dialog. Filter entries consist of a description and an extensions, separated by a pipe symbol; multiple entries are separated by pipe symbols as well: "Image Files(*.BMP;*.JPG;*.GIF)|*.BMP;*.JPG;*.GIF|All files (*.*)|*.*"

This property will only be used to set the dialog filter if the derived class does not set the property in its implementation of the abstract GetDialog() method.


The documentation for this class was generated from the following file: