Autodesk Vault ProfessionalVault API

IVaultNavigationModel Interface

Autodesk.DataManagement.Client.Framework.Vault.Forms›Autodesk.DataManagement.Client.Framework.Vault.Forms.Interfaces

This interfaces describes a model which encapsulates a workflow for navigating the contents of a vault. Navigation consists of a Parent entity and it's child content and methods to move up and down the content hierarchy

Syntax

public interface IVaultNavigationModel 
Public Interface IVaultNavigationModel

Properties

NameDescription
CanMoveBackGets whether or not the model can navigate back to the entity that was loaded prior to the current one.
CanMoveUpGets whether or not the model can navigate to the current entities parent.
ContentGets the child content for the Parent entity that was navigated to. The Content loads in the background and will be available after the ContentLoaded event is fired.
EqualityComparerGets the EqualityComparer used for the model. If null, then the default equality comparer is being used.
FocusedContentGets the entity that has Focus. An entity can be focused, but not selected.
NavigationPathGets the hierarchy of the current Parent all the way up to the root Navigation object. The NavigationPath loads in the background and will be available after the NavigationPathLoaded event is fired.
ParentGets the Parent entity (ie. the Entity that was navigated to). The Parent is the container for the Content.
SelectedContentGets the selected entities.

Methods

NameDescription
CanNavigateTests if the specified entity can be navigated to (ie. it can have children)
MoveBackNavigates to the entity that was loaded prior to the current one
MoveUpNavigates to the current entities parent
NavigateChanges the data in the model to represent a new entity. The Content for the new entity will be loaded in a background thread.
Navigate(IEntity,NavigationContext)Changes the data in the model to represent a new entity. The Content for the new entity will be loaded in a background thread.
Navigate(IEntity,IEnumerable<IEntity>,NavigationContext)Changes the data in the model to represent a new entity. The Content for the new entity is supplied and thus doesn't need to be loaded in a background thread.
ReloadReloads the models Content
SetFocusedContentSets the focused entity.
SetSelectedContentSets the selected entities.

Events

NameDescription
ContentAddedThis event is fired when entities are added manually to the Content of the model.
ContentLoadedAfter the ParentChanged notification is sent as a result of a Navigate, the model will begin to load the child content associated with the Parent. This event is fired when the Content is finished loading.
ContentRemovedThis event is fired when entities are removed manually from the Content of the model.
ContentUpdatedThis event is fired when entities are update manually in the Content of the model. The event allows all views a chance to refresh their display to represent the new data.
ExceptionThis event is fired when an exception occurs
FocusedContentChangedThis event is fired when the FocusedContent property changes via the SetFocusedContent method.
NavigationPathLoadedAfter the ParentChanged notification is sent as a result of a Navigate, the model will begin to compute the NavigationPath. This event is fired when the computation is complete.
ParentChangedThis event is fired when the Parent changes as a result of navigating to a new entity (via Navigate).
SelectedContentChangedThis event is fired when the SelectedContent property changes via the SetSelectedContent method.

See Also