File Class
Autodesk.Connectivity.WebServices›Autodesk.Connectivity.WebServices
Contains information relating to a file in the Vault.
Syntax
public class File Public Class File Properties
| Name | Description |
|---|---|
| Cat | Category information about this file. For files in the "None" category, the FileCat object will have an ID of 0. |
| CheckedOut | If true, then the latest version of this file is in the checked-out state. Whenever a file is checked-out, a new version is created as a placeholder. |
| CkInDate | The date and time that the file was checked in. This property is only valid if CheckedOut is false. |
| CkOutMach | The network ID of the computer that checked out the file. This parameter is valid only if CheckedOut is true. |
| CkOutSpec | The path on the client's computer that the file was checked out to. This parameter is valid only if CheckedOut is true. |
| CkOutUserId | The ID of the user that has the file checked out. This parameter is valid only if CheckedOut is true. |
| Cksum | The file's checksum. This parameter is valid only if CheckedOut is false. |
| Cloaked | If true, the logged-in user is restricted from seeing this file. The only valid data in a cloaked File is the Id and MasterId. All other data will be null or 0. |
| Comm | A comment string set by the user. If CheckedOut is true, then this property contains the comment set during checkout. If CheckedOut is false, then this property contains the comment set during check-in. Checking in a file, resets the comment for that version. |
| ControlledByChangeOrder | If true, the file is controlled by a change order. If false, the file is not controlled by a change order. |
| CreateDate | Tells the date and time that this version of the file was created in the Vault. For the first version of a file, this date will match CkInDate. For later versions, this value will have the time when the previous version was checked out. |
| CreateUserId | The ID of the user who checked-in or uploaded this file. |
| CreateUserName | The Name of the user who checked-in or uploaded this file. |
| DesignVisAttmtStatus | The status of a design visualization (.dwf) file. |
| FileClass | The classification of the file. |
| FileLfCyc | Life cycle information about this file. |
| FileRev | Revision information about this file. For files in "NULL" revisions, the FileRev object will have an ID of 0. |
| FileSize | The size, in bytes, of the file. This property is only valid if CheckedOut is false. |
| FileStatus | Tells if the file needs updating or not. |
| FolderId | The ID of the parent folder. |
| Hidden | If true, the file should be hidden by the client. |
| Id | A unique identifier for the file. |
| IsOnSite | In a multi-site environment, this property tells if the file is on the local site. True means that the file is on the local site. False means that the file is not on the local site. This value will always be true on a single-site environment. |
| Locked | Tells if the file can be modified by the logged in user. |
| MasterId | A unique identifier used to group all the versions of a file. In other words, different versions of a file will have a different Id but the same MasterId. |
| MaxCkInVerNum | The maximum version of this file currently checked-in to the vault. |
| ModDate | The last modified date of the file. This value is set by the client that uploaded the file. |
| Name | The name of the file. This value applies to all versions of the file. 'VerName' contains the name for a specific version of a file. |
| VerName | The historical name that matches this version of the file. |
| VerNum | The version of the file. A file that has just been added to the Vault, will have 1 as its VerNum. |
Returned By
Where you get a File — members that return one.
- AddFileCommandEventArgs.ReturnValue
- ChangeOrderService.RollbackToTargetFiles
- ChangeOrderService.UpdateFileLifeCycleDefinitions
- ChangeOrderService.UpdateFileLifeCycleStates
- CheckinFileCommandEventArgs.ReturnValue
- CheckoutFileCommandEventArgs.ReturnValue
- DocumentService.AddUploadedFile
- DocumentService.CheckinUploadedFile
- DocumentService.CheckoutFile
- DocumentService.FindFilesByDatesAndChecksums
- DocumentService.FindFilesByDatesPathsAndChecksums
- DocumentService.FindFilesByFoldersDatesNamesAndChecksums
- DocumentService.FindFilesByFoldersNamesAndChecksums
- DocumentService.FindFilesByIds
- DocumentService.FindFilesByPathsAndChecksums
- DocumentService.FindFilesBySearchConditions
- DocumentService.FindInFileSetBySearchConditions
- DocumentService.FindLatestFilesByMasterIds
- DocumentService.FindLatestFilesByPaths
- DocumentService.GetFileById
- DocumentService.GetFileByVersion
- DocumentService.GetFilesByIds
- DocumentService.GetFilesByMasterId
- DocumentService.GetFilesByVersions
- DocumentService.GetLatestFileByMasterId
- DocumentService.GetLatestFilesByFolderId
- DocumentService.GetLatestFilesByIds
- DocumentService.GetLatestFilesByMasterIds
- DocumentService.SetFileStatusByMasterId
- DocumentService.SetFileStatusByMasterIds
- DocumentService.UndoCheckoutFile
- DocumentService.UpdateFilePropertyDefinitions
- DocumentServiceExtensions.AddUploadedFileWithBehaviors
- DocumentServiceExtensions.RollbackToTargetFiles
- DocumentServiceExtensions.UpdateFileCategories
- DocumentServiceExtensions.UpdateFileLifeCycleDefinitions
- DocumentServiceExtensions.UpdateFileLifeCycleStates
- DocumentServiceExtensions.UpdateFileRevisionNumbers
- DocumentServiceExtensions.UpdateRevisionDefinitionAndNumbers
- FileArray.Files
- FileAssoc.CldFile
- FileAssoc.ParFile
- FileDelStatus.File
- FileFolder.File
- FilePath.File
- FileRollbackStatus.File
- UpdateFileLifeCycleStateCommandEventArgs.ReturnValue
Inheritance Hierarchy
- System.Object
- Autodesk.Connectivity.WebServices.File