Autodesk.DataManagement.Client.Framework.Vault › Autodesk.DataManagement.Client.Framework.Vault.Currency.Entities
Represents information about a folder in the vault.
Syntax C# Visual Basic
public class Folder : IEntity Public Class Folder Implements IEntity Constructors Name Description Folder Creates a Folder entity object
Properties Name Description Category Gets the category that is assigned to this folder. This can be null as not all products support categories. CreateDate Gets the date and time that the folder was created. CreateUserId Gets the ID of the user who crated this folder. CreateUserName Gets the name of the user who created this folder. EntityClass Gets the entity class associated with this Folder. EntityIterationId Gets the Iteration ID of this Folder. Since Folders are not iteration based, this will always have the same value as the EntityMasterId. EntityMasterId Gets the Master Id of this Folder. Folders are not iteration based and the MasterID is always the sole unique identifier for a folder. EntityName Gets the descriptive name for this Folder. This is always the Folder Name without the full path. FolderPath Gets the path of the location of this folder. If this folder is $/Folder1/Folder2, then the path would be $/Folder1 In the case where this folder is the root ($), the returned path is the empty string. FullName Gets the full vault path for this folder (ie. "$/Folder1") FullUncName Gets the full UNC path for this folder, or null if no UNC path exists. Id Gets the unique identifier for this folder IsCloaked Gets if this folder is cloaked. A cloaked object is one that the caller does not have permissions to view. The only valid data in a cloaked folder is the EntityMasterId. All other data will be null or 0. IsLibraryFolder Gets whether or not this folder is a library folder IsVaultRoot Gets whether or not this folder is the vault root folder LinkInfo Gets if this is a Link to a Folder. If the value is not null, then LinkInfo provides information about the Link to this Folder Locked Gets whether this folder can be modified by the logged in user. NumberOfChildren Gets the number of immediate child folders. Parent Gets or sets the parent folder. It is important to note that this CAN be null. A folder always has a parent ID but the full blown object might not have been loaded. ParentId Gets the Id of this folders parent. A value of -1 means that this folder has no parent
Methods Name Description Equals Tests if obj is equal to this Folder object.
Returned By Where you get a Folder — members that return one.
Inheritance Hierarchy System.Object Autodesk.DataManagement.Client.Framework.Vault.Currency.Entities.Folder See Also
