Autodesk Vault ProfessionalVault API

ClassicVaultBrowserControl Class

Autodesk.DataManagement.Client.Framework.Vault.FormsAutodesk.DataManagement.Client.Framework.Vault.Forms.Controls

A grid control which can display Vault Entities and their properties. Users can navigate the vault by drilling down on the Entities.

Syntax

public class ClassicVaultBrowserControl : System.Windows.Forms.UserControl 
Public Class ClassicVaultBrowserControl
   Inherits System.Windows.Forms.UserControl

Constructors

NameDescription
ClassicVaultBrowserControlCreates an instance of the ClassicVaultBrowserControl object

Properties

NameDescription
OptionsBehaviorGets a set of options which allows the user to configure various behaviors of the control
OptionsDragDropGets a set of options which allows the user to configure drag and drop behavior of the control

Methods

NameDescription
LoadViewStateLoads the grid settings from the persistent storage.
LogicalToDeviceUnits
LogicalToDeviceUnits(Int32)
LogicalToDeviceUnits(Size)
ReEvaluateCustomFiltersForces the control to compute which entities should be displayed.
SaveViewStateSaves the grid settings to the persistent storage.
ScaleBitmapLogicalToDevice
ServerSortCriteriaNotifyNotifies subscribers that server sort criteria has been changed
SetDataSourceConnects the user control to the data model that is used to supply entities to the control.
UpdateDataSourceForces the grid to recompute it's values for a list of properties
UpdateDataSource(IEnumerable<String>,CancellationToken)Forces the grid to recompute it's values for a list of properties
UpdateDataSource(IEnumerable<IEntity>,IEnumerable<String>)Forces the grid to recompute it's values for a list of properties on specific entities
UpdateDataSourceAsyncForces the grid to recompute it's values for a list of properties on specific entities

Events

NameDescription
DpiChangedAfterParent
DpiChangedBeforeParent
EntityDoubleClickThis event is fired when an entity is double clicked. If the entity is a folder or a other container, then the folder will be opened and the event will not be fired. Otherwise, this event is fired.
ExceptionEvent fired when an exception occurs
GetContextMenuThis event is fired when a right click occurs in the grid. The handler of the event can provide a custom context menu to display. Otherwise, the default context menu will be shown.
SelectionChangedEvent fired when selection changed
ServerSortChangedEvent fired when the sorted columns change. This only fires when the server properties have changes (ie. not the ones marked as calculated) since this is used to determine when we need to refresh the view.

Inheritance Hierarchy

  • System.Object
  • System.MarshalByRefObject
  • System.ComponentModel.Component
  • System.Windows.Forms.Control
  • System.Windows.Forms.ScrollableControl
  • System.Windows.Forms.ContainerControl
  • System.Windows.Forms.UserControl
  • Autodesk.DataManagement.Client.Framework.Vault.Forms.Controls.ClassicVaultBrowserControl

See Also