The following tables list the members exposed by the File type.
| Name | Description | |
|---|---|---|
|
AttachCustomFileAttribute(ServerID, EntityID, EntityID, IDatabase) | Attach a custom file attribute to a file |
|
|
CheckInFile(EntityID, IDatabase) | Check a file back in |
|
|
CheckInFileList(HashSet<EntityID>, IDatabase) | Check files back in |
|
|
CheckoutFile(EntityID, EntityID, string, IDatabase) | Check out a file |
|
|
DeleteSystemFileAttribute(EntityID, EntityID, IDatabase) | Delete a system file attribute |
|
|
Equals(Object) | Determines whether the specified object is equal to the current object. (inherited from Object). |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (inherited from Object). |
|
|
FindAttributesByName(string, IDatabase) | Find file change attributes by name |
|
|
FlattenAttributes(EntityID, bool, IDatabase, EntityAttributeCache) | For a particular file, 'flatten' the hierarchical attributes down to a flat list |
|
|
GetActiveCheckout(EntityID, IDatabase) | Get the active check out state for a file |
|
|
GetActiveCheckoutInfoForFileList(HashSet<EntityID>, IDatabase) | Get the active check out state for a file |
|
|
GetActiveUserCheckouts(EntityID, EntityID, IDatabase) | Get information about all files checked out by a user |
|
|
GetActiveUserCheckouts(EntityID, IDatabase) | Get information about all files checked out by a user |
|
|
GetAllGroupAccess(EntityID, IDatabase) | Get information about all groups who can access a file (at the file level only) |
|
|
GetAllRoleAccess(EntityID, IDatabase) | Get information about all roles thatcan access a file |
|
|
GetAllUserAccess(EntityID, IDatabase) | Get information about all users who can access a file (at the file level only) |
|
|
GetAttachedFileAttributes(string, EntityID, EntityID, IDatabase) | Given a file name and a folder, work out what attributes should be / are attached to it |
|
|
GetBasicFileInfoList(HashSet<EntityID>, IDatabase) | Get the information about list of files |
|
|
GetBasicFileInfoListWithLinkedFiles(HashSet<EntityID>, IDatabase) | Get the information about list of files including linked files |
|
|
GetCurrentVersionNumber(EntityID, IDatabase) | Get information about the current version of a file |
|
|
GetCustomFileAttributes(EntityID, IDatabase) | Get any custom file attribute info (without values) |
|
|
GetFileFolder(EntityID, IDatabase) | Get the id of the folder housing a file |
|
|
GetFileHistory(EntityID, bool, IDatabase) | Get the file history of a file |
|
|
GetFileID(string, EntityID, IDatabase) | Get a file id from a folder, based on its name |
|
|
GetFileIDs(List<String>, EntityID, IDatabase) | Get file ids from a folder, based on names |
|
|
GetFileInfo(EntityID, bool, IDatabase) | Get the latest information about a file |
|
|
GetFileInfo(EntityID, int, bool, IDatabase) | Get the information about a particular file version |
|
|
GetFileInfo(EntityID, int, bool, bool, IDatabase) | Get the information about a particular file version |
|
|
GetFileName(EntityID, IDatabase) | Get the file name of a given file |
|
|
GetFileNamesForListOfFiles(HashSet<EntityID>, IDatabase) | Get the file names for a given list of file ids |
|
|
GetFileProject(EntityID, IDatabase) | Given a file id, work out what project its in |
|
|
GetGroupAccess(EntityID, EntityID, IDatabase) | Get group access to a file |
|
|
GetHashCode | Serves as the default hash function. (inherited from Object). |
|
|
GetLinkedFileSource(EntityID, IDatabase) | Get the source for a linked file |
|
|
GetLinkedFileSourcePath(EntityID, IDatabase) | Get the path to the source for a linked file |
|
|
GetProjectIdsForFiles(HashSet<EntityID>, IDatabase) | Given a list of file ids, work out the projects they are in |
|
|
GetStandardFlatSearchAttributes(IDatabase) | Get the standard set of file flat search attributes |
|
|
GetStandardSearchAttributes(IDatabase) | Get the standard set of file search attributes |
|
|
GetSystemFileAttribute(bool, string, bool, IDatabase) | Get the required system attributes for a file |
|
|
GetSystemFileAttributeExtensions(EntityID, IDatabase) | Given an attribute id, find all the extensions that are set for it |
|
|
GetSystemFileAttributesAndExtensions(IDatabase) | Get all system file attributes and their extensions |
|
|
GetType | Gets the Type of the current instance. (inherited from Object). |
|
|
GetUpdatedFiles(Dictionary<EntityIDInt32>, IDatabase) | Get any files which have been updated since a particular version for each |
|
|
GetUserAccess(EntityID, EntityID, IDatabase) | Get the access available to a user for a given file |
|
|
GetUserAccess(EntityID, EntityID, bool, IDatabase) | Get the access available to a user for a given file |
|
|
GetUserCheckouts(EntityID, IDatabase) | Get all check outs for a user |
|
|
GetUserFolderCheckouts(EntityID, EntityID, IDatabase) | Get all user folder checkouts |
|
|
GetUserProjectCheckouts(EntityID, EntityID, bool, IDatabase) | For a particular user, get all the files they have checked out in a given project |
|
|
HasBeenLinkedTo(EntityID, IDatabase) | Has this file been linked to? |
|
|
HasFileBeenIssued(EntityID, IDatabase) | Has a file been issued? |
|
|
IsLinkedFile(EntityID, IDatabase) | Is this file a linked file? |
|
|
MarkAsModified(EntityID, IDatabase) | Mark a file as modified |
|
|
MarkMultipleFilesAsModified(HashSet<EntityID>, IDatabase) | Mark a list of files as modified |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (inherited from Object). |
|
|
PerformAddFile(string, EntityID, EntityID, string, FileChangeData, DateTime, IDatabase) | Add a file to the database This overload does not attach inherited attributes (i.e. system file attributes, project file attributes, folder file attributes). See the overload for that option. |
|
|
PerformAddFile(string, EntityID, EntityID, string, FileChangeData, DateTime, bool, IDatabase) | Add a file to the database This overload does not attach inherited attributes (i.e. system file attributes, project file attributes, folder file attributes). See the overload for that option. |
|
|
PurgeFile(EntityID, EntityID, IDatabase, IClient) | Purges a file completely from the system - this is _really_ dangerous, be warned! |
|
|
PurgeFiles(List<EntityID>, EntityID, IDatabase, IClient) | Purges a given list of files completely from the system - this is _really_ dangerous, be warned! |
|
|
RegenPreview(EntityID, int, IDatabase) | Regen a preview for a specific file and version |
|
|
ReindexFile(EntityID, IDatabase) | Reindex a file |
|
|
ReindexFile(EntityID, int, bool, IDatabase) | Reindex a file |
|
|
ReplicateFile(FileInfo, EntityID, EntityID, IDatabase) | Replicate an existing file into a new project |
|
|
SearchAndGatherFiles(SearchQuery, EntityID, EntityID, SearchLimitOption, bool, IDatabase, FileGatherer) | |
|
|
SetGroupAccess(EntityID, EntityID, RoleAccessType, RoleAccessType, IDatabase) | Set some user access for a group |
|
|
SetStandardFlatSearchAttributes(List<FlatSearchAttribute>, IDatabase) | Set the standard set of search attributes for flat searches |
|
|
SetStandardSearchAttributes(Dictionary<EntityIDAttributeSearchContext>, IDatabase) | Set the standard set of search attributes for project searches |
|
|
SetSystemFileAttribute(AttributeInfo, List<String>, EntityID, IDatabase) | Set a file attribute at the system level |
|
|
SetUserAccess(EntityID, EntityID, RoleAccessType, RoleAccessType, IDatabase) | Set some user access for a file |
|
|
ToString | Returns a string that represents the current object. (inherited from Object). |