Holds information about percent completion of a process and defines events that occur when the process is finished. This message can optionally carry a view model with additional events and capabilities. More...

Inheritance diagram for Bovender.Mvvm.Messaging.ProcessMessageContent:

[legend]

Collaboration diagram for Bovender.Mvvm.Messaging.ProcessMessageContent:

[legend]

Public Member Functions
	ProcessMessageContent ()
	Creates a new ProcessMessageContent. More...

	ProcessMessageContent (ViewModelBase viewModel)
	Creates a new ProcessMessageContent that encapsulates the given viewModel to enable views to access the encapsulated view model's members (e.g. in order to bind to the view model's events). More...

	ProcessMessageContent (Action cancelProcess)
	Creates a new ProcessMessageContent that has the ability to cancel a process. More...

	ProcessMessageContent (ViewModelBase viewModel, Action cancelProcess)
	Creates a new ProcessMessageContent that has the ability to cancel a process and that encapsulates a view model to provide a view easy access to the view model's members (e.g. in order to bind to the view model's events). More...

	ProcessMessageContent ()
	Creates a new ProcessMessageContent. More...

	ProcessMessageContent (ViewModelBase viewModel)
	Creates a new ProcessMessageContent that encapsulates the given viewModel to enable views to access the encapsulated view model's members (e.g. in order to bind to the view model's events). More...

	ProcessMessageContent (Action cancelProcess)
	Creates a new ProcessMessageContent that has the ability to cancel a process. More...

	ProcessMessageContent (ViewModelBase viewModel, Action cancelProcess)
	Creates a new ProcessMessageContent that has the ability to cancel a process and that encapsulates a view model to provide a view easy access to the view model's members (e.g. in order to bind to the view model's events). More...

Public Member Functions inherited from Bovender.Mvvm.Messaging.ViewModelMessageContent
	ViewModelMessageContent ()

	ViewModelMessageContent (ViewModelBase viewModel)
	Creates a new instance and set the ViewModel property to the parameter. More...

	ViewModelMessageContent ()

	ViewModelMessageContent (ViewModelBase viewModel)
	Creates a new instance and set the ViewModel property to the parameter. More...

Public Member Functions inherited from Bovender.Mvvm.Messaging.MessageContent
	MessageContent ()
	Creates a new, empty message content. More...

override object	RevealModelObject ()
	Returns the model object that this view model wraps or null if there is no wrapped model object. More...

	MessageContent ()
	Creates a new, empty message content. More...

override object	RevealModelObject ()
	Returns the model object that this view model wraps or null if there is no wrapped model object. More...

Public Member Functions inherited from Bovender.Mvvm.ViewModels.ViewModelBase
bool	IsViewModelOf (object model)
	Determines whether the current object is a view model of a particular model object. Returns false if either the model or the viewmodel's wrapped model object is null. More...

Window	InjectInto< T > ()
	Injects the ViewModel into a newly created View and wires the RequestCloseView event. More...

Window	InjectInto (Window view)
	Injects the view model into an existing view by setting the view's DataContext. More...

void	InjectAndShowInThread< T > (IntPtr ownerForm)
	Creates a new thread that creates a new instance of the view T , sets its Forms owner and shows it modelessly. Use this to show views during asynchronous operations. More...

void	InjectAndShowInThread< T > ()
	Creates a new thread that creates a new instance of the view T and shows it modelessly. Use this to show views during asynchronous operations. More...

void	InjectAndShowDialogInThread< T > (IntPtr ownerForm)
	Creates a new thread that creates a new instance of the view T and shows it as a dialog. Use this to show dialogs during asynchronous operations. More...

bool	IsViewModelOf (object model)
	Determines whether the current object is a view model of a particular model object. Returns false if either the model or the viewmodel's wrapped model object is null. More...

Window	InjectInto< T > ()
	Injects the ViewModel into a newly created View and wires the RequestCloseView event. More...

Window	InjectInto (Window view)
	Injects the view model into an existing view by setting the view's DataContext. More...

void	InjectAndShowInThread< T > (IntPtr ownerForm)
	Creates a new thread that creates a new instance of the view T , sets its Forms owner and shows it modelessly. Use this to show views during asynchronous operations. More...

void	InjectAndShowInThread< T > ()
	Creates a new thread that creates a new instance of the view T and shows it modelessly. Use this to show views during asynchronous operations. More...

void	InjectAndShowDialogInThread< T > (IntPtr ownerForm)
	Creates a new thread that creates a new instance of the view T and shows it as a dialog. Use this to show dialogs during asynchronous operations. More...

Protected Member Functions
void	DoCancel ()
	Cancels the process, sends a message to any subscribed views informing about the state change, and requests to close the subscribed views. More...

bool	CanCancel ()

void	DoCancel ()
	Cancels the process, sends a message to any subscribed views informing about the state change, and requests to close the subscribed views. More...

bool	CanCancel ()

Protected Member Functions inherited from Bovender.Mvvm.Messaging.MessageContent
virtual void	DoConfirm ()
	Executes the confirmation logic: sets Confirmed to True and calls DoCloseView() to issue a RequestCloseView message. More...

virtual bool	CanConfirm ()
	Determines whether the ConfirmCommand can be executed. More...

virtual void	DoConfirm ()
	Executes the confirmation logic: sets Confirmed to True and calls DoCloseView() to issue a RequestCloseView message. More...

virtual bool	CanConfirm ()
	Determines whether the ConfirmCommand can be executed. More...

Protected Member Functions inherited from Bovender.Mvvm.ViewModels.ViewModelBase
virtual void	OnPropertyChanged (string propertyName)

virtual bool	CanCloseView ()

virtual void	DoCloseView ()

	ViewModelBase ()
	Does not allow public instantiation of this class. More...

virtual void	OnPropertyChanged (string propertyName)

virtual bool	CanCloseView ()

virtual void	DoCloseView ()

	ViewModelBase ()
	Does not allow public instantiation of this class. More...

Properties
string	Caption `[get, set]`

string	Message `[get, set]`

string	CancelButtonText `[get, set]`

bool	Processing `[get, set]`

bool	IsIndeterminate `[get, set]`

int	PercentCompleted `[get, set]`

bool	WasSuccessful `[get, set]`

bool	WasCancelled `[get, set]`

Exception	Exception `[get, set]`
	If something in the process went wrong, this will be the corresponding exception. More...

Action	CancelProcess `[get, set]`
	Delegate that can be called to cancel the current process. More...

DelegatingCommand	CancelCommand `[get]`

Message< ProcessMessageContent >	CompletedMessage `[get]`

Properties inherited from Bovender.Mvvm.Messaging.ViewModelMessageContent
ViewModelBase	ViewModel `[get, set]`

Properties inherited from Bovender.Mvvm.Messaging.MessageContent
bool	Confirmed `[get, set]`

DelegatingCommand	ConfirmCommand `[get]`
	Sets the Confirmed property to true and triggers a RequestCloseView event. More...

Properties inherited from Bovender.Mvvm.ViewModels.ViewModelBase
ICommand	CloseViewCommand `[get]`

virtual string	DisplayString `[get, set]`

bool	IsSelected `[get, set]`

Dispatcher	ViewDispatcher `[get, set]`

Dispatcher	Dispatcher `[get]`
	Captures the dispatcher of the thread that the object was created in. More...

Additional Inherited Members
Events inherited from Bovender.Mvvm.ViewModels.ViewModelBase
EventHandler	RequestCloseView
	Raised by the CloseView Command, signals that associated views are to be closed. More...

PropertyChangedEventHandler	PropertyChanged

Detailed Description

Holds information about percent completion of a process and defines events that occur when the process is finished. This message can optionally carry a view model with additional events and capabilities.

Constructor & Destructor Documentation

◆ ProcessMessageContent() [1/8]

Bovender.Mvvm.Messaging.ProcessMessageContent.ProcessMessageContent ( )

inline

Creates a new ProcessMessageContent.

◆ ProcessMessageContent() [2/8]

Bovender.Mvvm.Messaging.ProcessMessageContent.ProcessMessageContent ( ViewModelBase viewModel )

inline

Creates a new ProcessMessageContent that encapsulates the given viewModel to enable views to access the encapsulated view model's members (e.g. in order to bind to the view model's events).

Parameters

viewModel View model to encapsulate

◆ ProcessMessageContent() [3/8]

Bovender.Mvvm.Messaging.ProcessMessageContent.ProcessMessageContent ( Action cancelProcess )

inline

Creates a new ProcessMessageContent that has the ability to cancel a process.

Parameters

cancelProcess Method to invoke when the Cancel button is clicked

◆ ProcessMessageContent() [4/8]

Bovender.Mvvm.Messaging.ProcessMessageContent.ProcessMessageContent	(	ViewModelBase	viewModel,
		Action	cancelProcess
	)

inline

Creates a new ProcessMessageContent that has the ability to cancel a process and that encapsulates a view model to provide a view easy access to the view model's members (e.g. in order to bind to the view model's events).

Parameters

viewModel	View model to encapsulate
cancelProcess	Method to invoke when the Cancel button is clicked

◆ ProcessMessageContent() [5/8]

Bovender.Mvvm.Messaging.ProcessMessageContent.ProcessMessageContent ( )

inline

Creates a new ProcessMessageContent.

◆ ProcessMessageContent() [6/8]

Bovender.Mvvm.Messaging.ProcessMessageContent.ProcessMessageContent ( ViewModelBase viewModel )

inline

Creates a new ProcessMessageContent that encapsulates the given viewModel to enable views to access the encapsulated view model's members (e.g. in order to bind to the view model's events).

Parameters

viewModel View model to encapsulate

◆ ProcessMessageContent() [7/8]

Bovender.Mvvm.Messaging.ProcessMessageContent.ProcessMessageContent ( Action cancelProcess )

inline

Creates a new ProcessMessageContent that has the ability to cancel a process.

Parameters

cancelProcess Method to invoke when the Cancel button is clicked

◆ ProcessMessageContent() [8/8]

Bovender.Mvvm.Messaging.ProcessMessageContent.ProcessMessageContent	(	ViewModelBase	viewModel,
		Action	cancelProcess
	)

inline

Creates a new ProcessMessageContent that has the ability to cancel a process and that encapsulates a view model to provide a view easy access to the view model's members (e.g. in order to bind to the view model's events).

Parameters

viewModel	View model to encapsulate
cancelProcess	Method to invoke when the Cancel button is clicked

Member Function Documentation

◆ CanCancel() [1/2]

bool Bovender.Mvvm.Messaging.ProcessMessageContent.CanCancel ( )

inlineprotected

◆ CanCancel() [2/2]

bool Bovender.Mvvm.Messaging.ProcessMessageContent.CanCancel ( )

inlineprotected

◆ DoCancel() [1/2]

void Bovender.Mvvm.Messaging.ProcessMessageContent.DoCancel ( )

inlineprotected

Cancels the process, sends a message to any subscribed views informing about the state change, and requests to close the subscribed views.

◆ DoCancel() [2/2]

void Bovender.Mvvm.Messaging.ProcessMessageContent.DoCancel ( )

inlineprotected

Cancels the process, sends a message to any subscribed views informing about the state change, and requests to close the subscribed views.

Property Documentation

◆ CancelButtonText

string Bovender.Mvvm.Messaging.ProcessMessageContent.CancelButtonText

getset

◆ CancelCommand

DelegatingCommand Bovender.Mvvm.Messaging.ProcessMessageContent.CancelCommand

get

◆ CancelProcess

Action Bovender.Mvvm.Messaging.ProcessMessageContent.CancelProcess

getset

Delegate that can be called to cancel the current process.

◆ Caption

string Bovender.Mvvm.Messaging.ProcessMessageContent.Caption

getset

◆ CompletedMessage

Message< ProcessMessageContent > Bovender.Mvvm.Messaging.ProcessMessageContent.CompletedMessage

get

◆ Exception

Exception Bovender.Mvvm.Messaging.ProcessMessageContent.Exception

getset

If something in the process went wrong, this will be the corresponding exception.

◆ IsIndeterminate

bool Bovender.Mvvm.Messaging.ProcessMessageContent.IsIndeterminate

getset

◆ Message

string Bovender.Mvvm.Messaging.ProcessMessageContent.Message

getset

◆ PercentCompleted

int Bovender.Mvvm.Messaging.ProcessMessageContent.PercentCompleted

getset

◆ Processing

bool Bovender.Mvvm.Messaging.ProcessMessageContent.Processing

getset

◆ WasCancelled

bool Bovender.Mvvm.Messaging.ProcessMessageContent.WasCancelled

getset

◆ WasSuccessful

bool Bovender.Mvvm.Messaging.ProcessMessageContent.WasSuccessful

getset

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

packages/Bovender.0.7.0.0/src/Mvvm/Messaging/ProcessMessageContent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProcessMessageContent() [1/8]

◆ ProcessMessageContent() [2/8]

◆ ProcessMessageContent() [3/8]

◆ ProcessMessageContent() [4/8]

◆ ProcessMessageContent() [5/8]

◆ ProcessMessageContent() [6/8]

◆ ProcessMessageContent() [7/8]

◆ ProcessMessageContent() [8/8]

Member Function Documentation

◆ CanCancel() [1/2]

◆ CanCancel() [2/2]

◆ DoCancel() [1/2]

◆ DoCancel() [2/2]

Property Documentation

◆ CancelButtonText

◆ CancelCommand

◆ CancelProcess

◆ Caption

◆ CompletedMessage

◆ Exception

◆ IsIndeterminate

◆ Message

◆ PercentCompleted

◆ Processing

◆ WasCancelled

◆ WasSuccessful