BrowseVaultNavigationModel Class

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

An implementation of the Autodesk.DataManagement.Client.Framework.Vault.Forms.Interfaces.IProgressiveLoadingVaultNavigationModel which is used to model a workflow for browsing and drilling down in a folder hierarchy of the Vault with ability to load more content on demand.

Syntax

public class BrowseVaultNavigationModel : Autodesk.DataManagement.Client.Framework.Vault.Forms.Interfaces.IProgressiveLoadingVaultNavigationModel, Autodesk.DataManagement.Client.Framework.Vault.Forms.Interfaces.IVaultNavigationModel

Public Class BrowseVaultNavigationModel
   Implements Autodesk.DataManagement.Client.Framework.Vault.Forms.Interfaces.IProgressiveLoadingVaultNavigationModel, Autodesk.DataManagement.Client.Framework.Vault.Forms.Interfaces.IVaultNavigationModel

Constructors

Name	Description
BrowseVaultNavigationModel	Constructs an instance of the BrowseVaultNavigationModel class

Properties

Name	Description
CanLoadMoreContent	Gets whether or not the model can request to append more content in view control.
CanMoveBack	Gets whether or not the model can navigate back to the entity that was loaded prior to the current one.
CanMoveUp	Gets whether or not the model can navigate to the current entities parent.
Content	Gets 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.
EqualityComparer	Gets the EqualityComparer used for the model. Returns null if the default comparer is being used.
FocusedContent	Gets the entity that has Focus. An entity can be focused, but not selected.
GetChildrenOverride	Gets or sets a delagate that is called to get the children for an entity during the navigation process.
LoadHiddenChildren	Gets or sets whether or not to include hidden children when loading content.
NavigationPath	Gets 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.
Parent	Gets the Parent entity (ie. the Entity that we navigated to). The Parent is the container for the Content.
RestrictNavigation	Gets or sets if navigation should be restricted to the current entity.
SelectedContent	Gets the selected entities

Methods

Name	Description
AddEntitiesToContent	Adds specified entities to existing Content
CanNavigate	Tests if the specified entity can be navigated to (ie. it can have children)
Clear	Removes all of the Content from the model
FindEntitiesNameStartsWith	Searches the Content for all entities whose EntityName starts with the specified text
LoadMoreContent	Loads additional content that fall beyond previosly loaded bookmark
MoveBack	Navigates to the entity that was loaded prior to the current one
MoveUp	Navigates to the current entities parent
Navigate	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,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.
Reload	Reloads the models Content
SetFocusedContent	Sets the focused entity.
SetSelectedContent	Sets the selected entities.
SetSelectedContentByName	Selects all Content in the model whose EntityName matches a list of names.
Update	Updates entities contained in this model.

Events

Name	Description
ContentAdded	This event is fired when entities are added manually to the Content of the model.
ContentLoaded	After 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.
ContentRemoved	Not implemented.
ContentUpdated	This event is fired when Entities managed by this model is updated via the Update method. The event allows all views a chance to refresh their display to represent the new data.
Exception	This event is fired when an exception occurs
FocusedContentChanged	This event is fired when the FocusedContent property changes via the SetFocusedContent method.
MoreContentRequested	This event is fired when the additional content is requested from view control. Event to call for Server and append more content.
NavigationPathLoaded	After 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.
ParentChanged	This event is fired when the Parent changes as a result of navigating to a new entity (via the Navigate method).
SelectedContentChanged	This event is fired when the SelectedContent property changes via the SetSelectedContent method.

Inheritance Hierarchy

System.Object
Autodesk.DataManagement.Client.Framework.Vault.Forms.Models.BrowseVaultNavigationModel