DialogViewModel Class

Implementation of IDialogViewModel. This abstract class implements the dialog data handling logic and is therefore preferred over a custom implementation of IDialogViewModel.

Inheritance Hierarchy

System.Object
BionicCode.Utilities.Net.Standard.ViewModel.ViewModel
BionicCode.Utilities.Net.Framework.Wpf.Dialog.DialogViewModel

Namespace: BionicCode.Utilities.Net.Framework.Wpf.Dialog
Assembly: BionicCode.Utilities.Net.Framework.Wpf (in BionicCode.Utilities.Net.Framework.Wpf.dll) Version: 1.0.3.0 (1.0.0.0)

Syntax

public abstract class DialogViewModel : ViewModel, 
	IDialogViewModel, IViewModel, INotifyPropertyChanged, INotifyDataErrorInfo

Public MustInherit Class DialogViewModel
	Inherits ViewModel
	Implements IDialogViewModel, IViewModel, INotifyPropertyChanged, INotifyDataErrorInfo

Dim instance As DialogViewModel

public ref class DialogViewModel abstract : public ViewModel, 
	IDialogViewModel, IViewModel, INotifyPropertyChanged, INotifyDataErrorInfo

[<AbstractClassAttribute>]
type DialogViewModel =  
    class
        inherit ViewModel
        interface IDialogViewModel
        interface IViewModel
        interface INotifyPropertyChanged
        interface INotifyDataErrorInfo
    end

public abstract class DialogViewModel extends ViewModel implements IDialogViewModel, 
	IViewModel, INotifyPropertyChanged, INotifyDataErrorInfo

public abstract class DialogViewModel extends ViewModel implements IDialogViewModel, IViewModel, INotifyPropertyChanged, INotifyDataErrorInfo

BionicCode.Utilities.Net.Framework.Wpf.Dialog.DialogViewModel = function();

Type.createClass(
	'BionicCode.Utilities.Net.Framework.Wpf.Dialog.DialogViewModel',
	BionicCode.Utilities.Net.Standard.ViewModel.ViewModel,
	BionicCode.Utilities.Net.Framework.Wpf.Dialog.IDialogViewModel,
	BionicCode.Utilities.Net.Standard.ViewModel.IViewModel,
	INotifyPropertyChanged,
	INotifyDataErrorInfo);

 ABSTRACT CLASS DialogViewModel INHERIT ViewModel, 
	 IMPLEMENTS IDialogViewModel, IViewModel, INotifyPropertyChanged, INotifyDataErrorInfo

The DialogViewModel type exposes the following members.

Constructors

	Name	Description
	DialogViewModel(String, String)	Creates a nw instance of the DialogViewModel using a do-nothing dialog closed callback.
	DialogViewModel(String, String, Func<IDialogViewModel, Task>)	Creates a nw instance of the DialogViewModel registering a dialog closed callback.
	DialogViewModel(String, String, ImageSource, Func<IDialogViewModel, Task>)	Creates a nw instance of the DialogViewModel registering a dialog closed callback.

Top

Properties

	Name	Description
	DialogResult	The DialogResult of the user interaction.
	HasErrors	Gets a value that indicates whether the entity has validation errors. (Inherited from ViewModel.)
	Message	The message for the dialog to show to the user.
	ResponseCallbackAsync	The asynchronous callback that is invoked during the dialog interaction. Use this callback as continuation of the interrupted flow, after the required data was collected by the dialog.
	SendResponseAsyncCommand	ICommand that can be bound to the buttons of the dialog. The command parameter is a DialogResult.
	Title	The title of the dialog Window
	TitleBarIcon	The icon to display in the title bar of the Window

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExecuteSendResponseCommandAsync	Asynchronously called when the SendResponseAsyncCommand is executed.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetErrors	Gets all error messages of the specified property. If the propertyName is null all error messages will be returned. (Inherited from ViewModel.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetPropertyErrors	Gets all error messages of the specified property. If the propertyName is null all error messages will be returned. (Inherited from ViewModel.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsValueValid<TValue>	Can be used to check whether a value is valid. (Inherited from ViewModel.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnErrorsChanged	Raised when the validation state of the view model has changed (e.g. error added or removed). (Inherited from ViewModel.)
	OnInteractionCompleted	Event invocator of the InteractionCompleted event. Raising this event will request the dialog to be closed.
	OnPropertyChanged	Method called to fire a PropertyChanged event. Also raises the PropertyChanged event to support binding. (Inherited from ViewModel.)
	PropertyHasError	Checks whether the specified property has errors or is valid. (Inherited from ViewModel.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TrySetValue<TValue>(TValue, TValue, String)	Generic property setter. Sets the value of any property of the extending view model by passing in a the corresponding property backing field. Automatically raises the PropertyChanged event for this property. (Inherited from ViewModel.)
	TrySetValue<TValue>(TValue, Func<TValue, ValueTuple<Boolean, IEnumerable<String>>>, TValue, Boolean, Boolean, String)	Sets the value of the referenced property and executes a validation delegate. (Inherited from ViewModel.)
	TrySetValueSilent<TValue>(TValue, TValue, String)	Generic property setter. Silently sets the value of any property of the extending view model by passing in a the corresponding property backing field. Suppresses a PropertyChanged event for this property. (Inherited from ViewModel.)
	TrySetValueSilent<TValue>(TValue, Func<TValue, ValueTuple<Boolean, IEnumerable<String>>>, TValue, Boolean, Boolean, String)	Silently sets the value of the referenced property without raising PropertyChanged and executes a validation delegate. (Inherited from ViewModel.)

Top

Events

	Name	Description
	ErrorsChanged	Occurs when the validation errors have changed for a property or for the entire entity. (Inherited from ViewModel.)
	InteractionCompleted	Event to signal that the interaction with the dialog is completed.
	PropertyChanged	Event fired whenever a child property changes its value. (Inherited from ViewModel.)
	PropertyValueChanged	PropertyChanged implementation that sends old value and new value of the change and raises the INotifyPropertyChanged event. (Inherited from ViewModel.)

Top

Extension Methods

	Name	Description
	ToDictionary()	Overloaded. Coverts any type to a Dictionary<TKey, TValue>, where the TKey is the member name and TValue the member's value. (Defined by HelperExtensions.)
	ToDictionary()	Overloaded. Coverts any type to a Dictionary<TKey, TValue>, where the TKey is the member name and TValue the member's value. (Defined by HelperExtensions.)

Top

Remarks

It is recommended to use the Dialog attached behavior as it handles the view logic. Just bind DialogDataContextProperty to an instance of DialogViewModel (or IDialogViewModel) and define a DataTemplate for each implementation of DialogViewModel.

Reference

BionicCode.Utilities.Net.Framework.Wpf.Dialog Namespace

Other Resources

See advanced example