Autodesk Vault ProfessionalVault API

SelectEntitySettings Class

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

Options for configuring the behavior for the Autodesk.DataManagement.Client.Framework.Vault.Forms.Library.SelectEntity workflow.

Syntax

public class SelectEntitySettings 
Public Class SelectEntitySettings 

Constructors

NameDescription
SelectEntitySettingsCreates an instance of the SelectEntitySettings class

Properties

NameDescription
ActionableEntityClassIdsGets or adds the Entity Class IDs which represent the entities that are being acted on. If empty, then every type of entity is actionable.
ActionButtonEnablementRuleGets or sets the chosen rule from SelectEntitySettings.ActionButtonEnablementRules that determines when the action button is enabled.
ActionButtonNavigatesContainersGets or sets if the Action Button should navigate into containers instead of opening them.
ClearTextBoxOnNonActionableEntityGets or sets if the text box should clear its contents when an non-actionable entity is selected.
DialogCaptionGets or sets the caption to display in the Select Entity dialog box
EntitiesToHideGets or sets a list of entities that should not be displayed in the Select Entity dialog
HelpContextGets or sets context-specified data that is sent to Autodesk.DataManagement.Client.Framework.Forms.Interfaces.ICustomHelpProvider when the help button is clicked
InitialBrowseLocationGets or sets the initial entity that is being viewed when the Select Entity dialog is launched. If not specified, then the Vault Root ($) will be displayed
InitialSelectionTextGets or sets what the inital contents of the text box will be.
MultipleSelectGets or sets whether or not the grid which displays a list of entities to select supports single or multiple selection
NavigationPathSettingsGets or sets the settings used to configure the Navigation Path combobox. If null, a default configuration will be used.
OptionsExtensibilityGets or sets the Extensibility Options for for the dialog.
OptionsWindowGets the options that can be used to configure the dialogs parent and location
PersistenceKeyGets or sets a key that uniquely defines an instance of a Autodesk.DataManagement.Client.Framework.Vault.Forms.Library.SelectEntity workflow. This key will be used to persist GUI settings
RestrictNavigationGets or sets if navigation should be restricted to the InitialBrowseLocation.
SelectionTextLabelGets or sets the label for the text box that displays a list of the selected entities.
ShowFolderViewGets or sets whether or not to display folder tree view.
ShowHiddenChildrenGets or sets whether or not to display hidden entities in the grid.s

Methods

NameDescription
ConfigureActionButtonsConfigures the action button used to submit the dialog.
ConfigureFiltersConfigures options for the entity filters.
ConfigureRevisionsConfigures options surrounding the revisions control.

Inheritance Hierarchy

  • System.Object
  • Autodesk.DataManagement.Client.Framework.Vault.Forms.Settings.SelectEntitySettings

See Also