Class CommandResult

Represents the result of a command's execution.

Inheritance
System.Object
CommandResult
Namespace: Algenta.Colectica.ViewModel.Commands
Assembly: Algenta.Colectica.ViewModel.dll
Syntax
public class CommandResult : object

Properties

AffectedItems

Gets a collection of items that have been changed or for which related items have have been changed. If items in the collection are displayed in the navigator or the main item view, their views will be refreshed.

Declaration
public Collection<IdentifierTriple> AffectedItems { get; }
Property Value
Type Description
Collection<IdentifierTriple>

IsSuccessful

Gets or sets a value indicating whether the command executed functionality.

Declaration
public bool IsSuccessful { get; set; }
Property Value
Type Description
System.Boolean

ItemsToShow

Gets a list of items that should be displayed after the command is executed. Only the first item in the collection is displayed.

Declaration
public Collection<IVersionable> ItemsToShow { get; }
Property Value
Type Description
Collection<IVersionable>

MessageDetails

Gets or sets extended details to be displayed after the command is finished. If no message should be displayed, this should be left blank.

Declaration
public string MessageDetails { get; set; }
Property Value
Type Description
System.String

MessageText

Gets or sets the text of a message to be displayed after the command is finished. If no message should be displayed, this should be left blank.

Declaration
public string MessageText { get; set; }
Property Value
Type Description
System.String

MessageTitle

Gets or sets the text the title of the message to be displayed after the command is finsihed. If no message should be displayed, this should be left blank.

Declaration
public string MessageTitle { get; set; }
Property Value
Type Description
System.String

ModifiedItems

Gets a collection of items that have been changed and need to be saved.

Declaration
public Collection<IVersionable> ModifiedItems { get; }
Property Value
Type Description
Collection<IVersionable>

RefreshNavigation

Gets or sets a value indicating whether the navigator should be refreshed after the command is finished.

Declaration
public bool RefreshNavigation { get; set; }
Property Value
Type Description
System.Boolean

Methods

Clear()

Clears the values of the MessageTitle, MessageText, and MessageDetails properties.

Declaration
public void Clear()

Extension Methods