Skip to main content
A newer version of this page is available. .

DocumentsViewModel<TModule, TUnitOfWork> Members

The base class for POCO view models that operate the collection of documents.

Properties

Name Description
ActiveModule

A navigation list entry that corresponds to the currently active document. If the active document does not have the corresponding entry in the navigation list, the property value is null. This property is read-only. Since DocumentsViewModel is a POCO view model, this property will raise INotifyPropertyChanged.PropertyEvent when modified so it can be used as a binding source in views.

DefaultModule
Modules Navigation list that represents a collection of module descriptions.
NavigationPaneVisibility Contains a current state of the navigation pane.
SelectedModule

A currently selected navigation list entry. This property is writable. When this property is assigned a new value, it triggers the navigating to the corresponding document. Since DocumentsViewModel is a POCO view model, this property will raise INotifyPropertyChanged.PropertyEvent when modified so it can be used as a binding source in views.

Methods

Name Description
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnClosing(CancelEventArgs)

Used to close all opened documents and allows you to save unsaved results and to cancel closing. Since DocumentsViewModel is a POCO view model, an instance of this class will also expose the OnClosingCommand property that can be used as a binding source in views.

OnLoaded(TModule)

Finalizes the DocumentsViewModel initialization and opens the default document. Since DocumentsViewModel is a POCO view model, an instance of this class will also expose the OnLoadedCommand property that can be used as a binding source in views.

PinPeekCollectionView(TModule)

Creates and shows a document which view is bound to PeekCollectionViewModel. The document is created and shown using a document manager service named “WorkspaceDocumentManagerService”. Since DocumentsViewModel is a POCO view model, an instance of this class will also expose the PinPeekCollectionViewCommand property that can be used as a binding source in views.

ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RestoreLogicalLayout()
SaveAll()

Saves changes in all opened documents. Since DocumentsViewModel is a POCO view model, an instance of this class will also expose the SaveAllCommand property that can be used as a binding source in views.

SaveLogicalLayout()
Show(TModule)

Navigates to a document. Since DocumentsViewModel is a POCO view model, an instance of this class will also expose the ShowCommand property that can be used as a binding source in views.

ShowCore(TModule)
ToString() Returns a string that represents the current object. Inherited from Object.
See Also