bovender framework
C# framework that implements MVVM and more
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:
Bovender.Mvvm.Actions.FileFolderActionBase Bovender.Mvvm.Actions.NotificationAction Bovender.Mvvm.Actions.MessageActionBase Bovender.Mvvm.Actions.ChooseFileOpenAction Bovender.Mvvm.Actions.ChooseFileSaveAction

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)
 
- 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...
 
- Protected Member Functions inherited from Bovender.Mvvm.Actions.NotificationAction
override Window CreateView ()
 Returns a view that can bind to expected message contents. More...
 
override ViewModels.ViewModelBase GetDataContext (MessageContent messageContent)
 Gets a ViewModelBase object that will be injected into the view In the abstract base class, this returns the messageContent parameter as-is. More...
 
- Protected Member Functions inherited from Bovender.Mvvm.Actions.MessageActionBase
override void Invoke (object parameter)
 Invokes the action by creating a view and a corresponding view model. More...
 
void Invoke< T > (T messageContent, Action response)
 
virtual void ShowView (Window view)
 Shows the view as a modal dialog. More...
 

Properties

string Filter [get, set]
 Filter string for the file dialog. More...
 
- Properties inherited from Bovender.Mvvm.Actions.FileFolderActionBase
string Description [get, set]
 
StringMessageContent MessageContent [get]
 
- Properties inherited from Bovender.Mvvm.Actions.NotificationAction
string Caption [get, set]
 
string Message [get, set]
 
string Param1 [get, set]
 
string Param2 [get, set]
 
string Param3 [get, set]
 
string OkButtonText [get, set]
 
string CancelButtonText [get, set]
 
string FormattedText [get]
 Returns the Message string formatted with the three params. More...
 
- Properties inherited from Bovender.Mvvm.Actions.MessageActionBase
MessageContent Content [get, set]
 

Additional Inherited Members

- Public Member Functions inherited from Bovender.Mvvm.Actions.NotificationAction
 NotificationAction (string caption, string message)
 
 NotificationAction (string caption, string message, string okButtonText)
 
 NotificationAction (string caption, string message, string okButtonText, string param)
 
 NotificationAction (string caption, string message, string okButtonText, string param1, string param2)
 
 NotificationAction (string caption, string message, string okButtonText, string param1, string param2, string param3)
 
- Static Public Attributes inherited from Bovender.Mvvm.Actions.NotificationAction
static readonly DependencyProperty CaptionProperty
 
static readonly DependencyProperty MessageProperty
 
static readonly DependencyProperty Param1Property
 
static readonly DependencyProperty Param2Property
 
static readonly DependencyProperty Param3Property
 
static readonly DependencyProperty OkButtonTextProperty
 
static readonly DependencyProperty CancelButtonTextProperty
 

Detailed Description

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

Definition at line 31 of file FileDialogActionBase.cs.

Member Function Documentation

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.

Definition at line 61 of file FileDialogActionBase.cs.

Property Documentation

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.

Definition at line 47 of file FileDialogActionBase.cs.


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