Autodesk Vault ProfessionalVault API

InteractiveAcquireFileSettings Class

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

Configuration options for the interactive AcquireFiles workflow that is used to download and/or checkout files from the vault. This class derives off of ProgressAcquireFilesSettings

Syntax

public class InteractiveAcquireFileSettings : ProgressAcquireFilesSettings 
Public Class InteractiveAcquireFileSettings
   Inherits ProgressAcquireFilesSettings

Constructors

NameDescription
InteractiveAcquireFileSettingsConstructs an instance of the AcquireFileSettings class

Properties

NameDescription
AllowLocalPathChangesGets or sets whether or not the local path can be changed via the user interface.
CaptionGets the caption of the progress dialog
CheckoutCommentGets or sets the comment that will be applied to any files that are Checked Out.
DefaultAcquisitionOptionGets or sets how files will be acquired (whether they are downloaded, checked out, or both).
HelpContextGets or sets an optional context that identifies this instance of a Acquire Files dialog.
HistoricalModeWhether or not the dialog should display in Historical Mode or not.
LocalPathThe path where files will be downloaded to. If null then files will be downloaded to their working folders
OptionsExtensibilityGets an object which contains handlers that can be used to augment the functionality of the Acquire Files workflow
OptionsRelationshipGatheringGets options which can be used to configure how the relationships for entities added via AddEntityToAcquire are evaluated to see what additional files should be acquired
OptionsResolutionGets an object which handles scenarios that need resolution. For example, what to do if a file exists, how to handle files not on the remote server, how to update out of date file references, etc.
OptionsThreadingGets an object which allows for the configuration of the background processing.
OrganizeFilesRelativeToCommonVaultRootGets or sets how files should be organized when downloaded to a LocalPath.
ParentGets the handle of the window that will be used as the parent of the progress dialog
PersistenceKeyGets or sets the key to retrieve persisted information about the state of the gui
VaultConnectionGets a connection to a vault server from which the files will be acquired

Methods

NameDescription
AddEntityToAcquireAdds to the list of entities to be acquired. This may be an actual file, or a container object (ie. a folder) that contains files
AddEntityToAcquire(IEntity)Adds to the list of entities to be acquired. This may be an actual file, or a container object (ie. a folder) that contains files
AddEntityToAcquire(IEnumerable<IEntity>)Adds to the list of entities to be acquired. This may be a list of actual files, container objects (ie. a folder) that contains files, or a combination of both
AddFileToAcquireAdds a file to the list of entities to be acquired.
AddFileToAcquire(FileIteration,AcquisitionOption)Adds a file to the list of entities to be acquired.
AddFileToAcquire(FileIteration,AcquisitionOption,FilePathAbsolute)Adds a file to the list of entities to be acquired.
AddFileToAcquire(FileIteration,AcquisitionOption,FolderPathAbsolute)Adds a file to the list of entities to be acquired.
IsValidConfigurationTests if the Autodesk.DataManagement.Client.Framework.Vault.Settings.AcquireFilesSettings object has been properly configured and that we can proceed with the file acquisition

Inheritance Hierarchy

See Also