Provides functions to query, download, and check out files from Vault.
It also has a function to add files (with limitations), and another function to update properties.
It also has a function to add files (with limitations), and another function to update properties.
In a rule, this class is instantiated by the predefined object named iLogicVault.
Note: these functions will only work if the Vault add-in is loaded. Vault Basic is not supported.
Inheritance Hierarchy
System.ObjectAutodesk.iLogic.Vault.iLogicVaultClass
Namespace: Autodesk.iLogic.Vault
Assembly: Autodesk.iLogic.Vault (in Autodesk.iLogic.Vault.dll) Version: 29.0
Syntax
VB
Public NotInheritable Class iLogicVaultClass
C#
public sealed class iLogicVaultClass
The iLogicVaultClass type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | iLogicVaultClass |
Properties
| Name | Description | |
|---|---|---|
 | IsVaultBasic |
Returns True if we are running on Vault Basic.
|
| IsVaultPro |
Returns True if we are running on Vault Pro.
|
| LoggedIn |
Property representing the current user's Vault connection state. Returns true if the current user is logged in.
|
Methods
| Name | Description | |
|---|---|---|
| AddFile |
Adds local file to Vault and optionally attaches it to a parent file. Does NOT build parent-child relationships! So this function should not be used on any file (e.g. an assembly or drawing) that contains references to other files. |
| CheckFilesExistBySearchCriteria(Dictionary(TKey, TValue), Boolean, String) | |
| CheckFilesExistBySearchCriteria(Dictionary(TKey, TValue), Boolean, String, String) | |
| ConvertLocalPathToVaultPath |
Convert the local file or folder path to the corresponding folder path in Vault.
|
| CopyLocalFile |
Copies a local file to a new name. The source file's location and extension are captured and applied to the copy. Use Check-In (iLogic) command for adding the new file to Vault. |
| GetFileByFullFilePath(String, Boolean) |
Downloads Vault file using full file path, e.g. "$/Designs/Base.ipt". Returns full file name in local working folder. Children and attachments are also downloaded. |
| GetFileByFullFilePath(String, Dictionary(TKey, TValue) , Boolean) | |
| GetFileByFullFilePath(String, Dictionary(TKey, TValue) , Boolean, String) | |
| GetFileBySearchCriteria(Dictionary(TKey, TValue), Boolean, String, String) | |
| GetFileBySearchCriteria(Dictionary(TKey, TValue), Boolean, String, String, Dictionary(TKey, TValue) ) | |
| GetFileBySearchCriteria(Dictionary(TKey, TValue), Boolean, String, String, Dictionary(TKey, TValue) , Boolean) | |
| GetFileCopyBySourceFileNameAndAutoNumber |
Copy Vault file on file server and download using full file path, e.g. "$/Designs/Base.ipt". Create new file name using default or named numbering scheme. Preset Options: Download Children (recursively) = Enabled, Enforce Overwrite = True |
| GetFileCopyBySourceFileNameAndNewName |
Copy Vault file on file server and download using full file path, e.g. "$/Designs/Base.ipt". Create new file name re-using source file's extension and new file name variable. Preset Options: Download Children (recursively) = Enabled, Enforce Overwrite = True |
| GetFileCopyBySourceFileSearchAndAutoNumber | |
| GetFileCopyBySourceFileSearchAndNewName | |
| GetFilesBySearchCriteria | |
| GetNewNumber |
Create single file number by scheme name and optional input parameters.
|
| GetThumbnailFileByFullSourceFilePath |
Download Thumbnail Image of the given file as Image file.
|
| GetThumbnailFileBySearchCriteria | |
| GetThumbnailImageByFullSourceFilePath |
Get Thumbnail of the given file as Image object.
|
| GetThumbnailImageBySearchCriteria | |
| GetVaultConnection |
Deprecated. Returns current Vault connection. Leverage LoggedIn property whenever possible.
Null value returned if user is not logged in.
|
| GetVaultFileStatus | |
| UpdateVaultFileProperties |