Folder Methods

The following tables list the members exposed by the Folder type.

	Name	Description
	AddChangeAttribute(EntityID, EntityID, bool, IDatabase)	Add a change attribute
	AddChangeAttribute(EntityID, EntityID, bool, Nullable<Int64>, IDatabase)	Add a change attribute
	AttachAttributeToFolder(EntityID, EntityID, bool, EntityID, IDatabase)	Attach an attribute for a folder
	CancelCheckOut(EntityID, IDatabase)	Cancel a check out
	CheckInFolder(EntityID, bool, EntityID, bool, string, int, bool, IDatabase, Dictionary<EntityIDFolderState>)	Check a folder back in
	CheckoutFolder(EntityID, EntityID, bool, string, IDatabase)	Check out a managed folder
	ClearUserFolderLayouts(IDatabase)	Clear any user folder layouts
	ContainsFile(EntityID, string, IDatabase)	Does this folder contain a file of a given name?
	CreateFolder(string, EntityID, EntityID, bool, bool, FolderType, EntityID, IDatabase)	Create a folder
	CreateManagedFolderChange(EntityID, int, EntityID, string, FolderState, IDatabase)	Create a managed folder change
	DoesFolderHaveIssuedFiles(EntityID, IDatabase)	Does this folder have any issued files?
	Equals(Object)	Determines whether the specified object is equal to the current object. (inherited from Object).
	ExportFolder(EntityID, bool, bool, bool, string, EntityID, IDatabase, IClient, ref Dictionary<EntityIDString>, ref Dictionary<EntityIDString>)
	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 folder attributes by name
	FlattenAttributes(EntityID, bool, bool, IDatabase, EntityAttributeCache)	For a particular folder, 'flatten' the hierarchical attributes down to a flat list
	GetActiveCheckout(EntityID, IDatabase)	Get the active check out state for a managed folder
	GetActiveUserCheckouts(EntityID, IDatabase)	Get information about all files checked out by a user
	GetActiveUserCheckoutsClosingRules(EntityID, IDatabase)	Get information about all Folders checked out by a user that match Active Closing Rules
	GetAllGroupAccess(EntityID, IDatabase)	Get information about all groups who can access a folder (at the folder level only)
	GetAllRoleAccess(EntityID, IDatabase)	Get information about all rolesth atcan access a folder (at the folder level only)
	GetAllUserAccess(EntityID, IDatabase)	Get information about all users who can access a folder (at the folder level only)
	GetAllowableFileExtensions(EntityID, IDatabase)	Get the list of allowed file extensions for a given folder
	GetChangedFolderFiles(EntityID, EntityID, bool, DateTime, IDatabase)	Get all visible files in a folder that were changed after a certain date
	GetCurrentManagedFolderVersion(EntityID, IDatabase)	Get the current version for a managed folder
	GetEntityPath(EntityID, EntityID, IDatabase)	Get the path to a folder of a given id
	GetFileChangesForManagedFolder(EntityID, int, IDatabase)	Given a managed folder id, get all the file changes for a particular version
	GetFileCount(EntityID, IDatabase)	Get the number of files in a folder (includes deleted)
	GetFolder(EntityID, bool, IDatabase)	Get the folder info for a folder
	GetFolderAttributeValue(EntityID, string, IDatabase)	Get a project attribute value, based on a name and project id
	GetFolderAttributes(EntityID, IDatabase)	Given a folder id, get all attributes (and values)
	GetFolderChangeID(EntityID, int, IDatabase)	Given a folder and a version (which may be -1 if unknown), get the folder change id
	GetFolderFileAttributeExtensions(EntityID, EntityID, IDatabase)	Given a folder file attribute, find what extensions exist for it
	GetFolderFileAttributes(EntityID, bool, IDatabase)	Get initial attributes for a folder, without looking at extensions
	GetFolderFileAttributes(EntityID, string, bool, IDatabase)	Get initial attributes for a folder
	GetFolderFileAttributesAndExtensions(EntityID, IDatabase)	Given a folder, get all file attributes and their extensions
	GetFolderFileAttributesWithInheritance(EntityID, string, bool, IDatabase)	Get initial attributes for a folder
	GetFolderFileChangeAttributes(EntityID, bool, bool, IDatabase)	Get initial attributes for a file change on a folder
	GetFolderFileIDs(EntityID, EntityID, IDatabase)	Get all visible file ids in a folder
	GetFolderFileNames(EntityID, EntityID, string, char, char, IDatabase)	Get the list of file names in a folder (that the user can see)
	GetFolderFiles(EntityID, EntityID, bool, IDatabase)	Get all visible files in a folder
	GetFolderFiles(EntityID, bool, IDatabase)	Get all files in a folder
	GetFolderID(string, EntityID, IDatabase)	Given a folder name and a parent, get its id
	GetFolderIDFromPath(string, EntityID, IDatabase)	Get a folder id from a path
	GetFolderIDFromPath(string, IDatabase)	Get a folder id from a path
	GetFolderIDFromURIPath(string, EntityID, IDatabase)	Given a uri style path, find the folder
	GetFolderName(EntityID, IDatabase)	Get the name of a given folder
	GetFolderPath(EntityID, IDatabase)	Get a folder path as a string
	GetFolderPath(EntityID, bool, IDatabase)	Get a folder path as a string
	GetFolderType(EntityID, IDatabase)	Get the folder type
	GetGroupAccess(EntityID, EntityID, IDatabase)	Get group access to a folder
	GetGroupAccessOld(EntityID, EntityID, IDatabase)	Get group access to a folder
	GetHashCode	Serves as the default hash function. (inherited from Object).
	GetLatestVersion(EntityID, IDatabase)	Get the latest version number of a folder - must be a managed folder
	GetParentFolderID(EntityID, IDatabase)	Get the id of the parent folder
	GetPopularAttributes(double, EntityID, bool, IDatabase, out Dictionary<EntityIDAttributeInfo>, out Dictionary<EntityIDAttributeInfo>)	Given a folder, work out (against a ratio of popularity) the set of popular file and change attributes
	GetProjectID(EntityID, IDatabase)	Get the project a folder belongs to
	GetProjectIDForRootFolder(EntityID, IDatabase)	Get the id of a project, given a root folder
	GetProjectRootFolder(string, EntityID, bool, IDatabase)	Get a project root folder by its name
	GetProjectRootFolderIDs(EntityID, IDatabase)	Get all the project root folder as ids
	GetProjectRootFolders(EntityID, bool, IDatabase)	Get all the project root folders
	GetSubFolder(EntityID, string, bool, IDatabase)	Get the sub folder with a certain name from a parent folder
	GetSubFolderIDs(EntityID, IDatabase)	Get all the sub folders of a folder as a list of ids
	GetSubFolders(EntityID, bool, bool, IDatabase)	Get all the sub folders of a folder
	GetSubFolders(EntityID, bool, bool, int, IDatabase)	Get all the sub folders of a folder
	GetTDProjectID(string, EntityID, IDatabase)	Get the id of a 12d model project by name
	GetType	Gets the Type of the current instance. (inherited from Object).
	GetUserAccess(EntityID, EntityID, IDatabase)	Get the access type a user has to this folder
	GetUserAccess(EntityID, EntityID, List<EntityID>, List<EntityID>, IDatabase)	Get the access type a user has to this folder
	GetVisibleTDProjects(EntityID, EntityID, TDConnectionContext, IDatabase)	Get a list of all 12d projects inside a folder that the user has access to
	HasFileExtensionsSet(EntityID, IDatabase)	Does a folder have any file extensions set?
	Index(EntityID, bool, IDatabase)	Index a server folder
	Index(EntityID, bool, bool, IDatabase)	Index a server folder
	Index(ProjectFolder, bool, IDatabase)	Index a server folder
	Index(ProjectFolder, bool, bool, IDatabase)	Index a server folder
	InheritsFromParent(EntityID, IDatabase)	Does a folder inherit access permissions from its parent?
	IsFileExtensionAllowed(string, EntityID, IDatabase)	Check if a file extension is allowed in a given folder
	MemberwiseClone	Creates a shallow copy of the current Object. (inherited from Object).
	MoveFolder(EntityID, EntityID, bool, EntityID, IDatabase)	Move a folder
	PurgeFolder(EntityID, bool, bool, IDatabase, IClient)	Delete a folder from the database
	RegenAllFilePreviews(EntityID, bool, IDatabase)	Regen all file previews
	RemoveFolderAttribute(EntityID, EntityID, EntityID, IDatabase)	Remove a folder attribute
	RemoveFolderFileAttribute(EntityID, EntityID, EntityID, IDatabase)	Remove a folder file attribute
	RemoveFolderFileChangeAttribute(EntityID, EntityID, EntityID, IDatabase)	Remove a folder file change attribute
	ReplicateFolder(ProjectFolder, EntityID, EntityID, bool, EntityID, IDatabase, IClient)	Replicate a folder and all its contents
	SetAllowableFolderFileExtensions(EntityID, List<String>, IDatabase)	Set up any allowable file extensions for a folder
	SetFolderAttribute(EntityID, AttributeInfo, EntityID, IDatabase)	Set a folder attribute
	SetFolderAttributeValues(EntityID, List<AttributeInfo>, IDatabase)	Update folder attributes
	SetFolderFileAttribute(EntityID, AttributeInfo, List<String>, EntityID, IDatabase)	Set a folder file attribute
	SetFolderFileChangeAttribute(EntityID, AttributeInfo, EntityID, IDatabase)	Set a folder file change attribute
	SetFolderName(EntityID, string, IDatabase)	Set the name of a folder
	SetFolderType(EntityID, FolderType, bool, EntityID, IDatabase)	Set the folder type
	SetGroupAccess(EntityID, EntityID, RoleAccessType, RoleAccessType, IDatabase)	Set some group access for a folder
	SetInheritsFileAttributes(EntityID, bool, IDatabase)	Set whether or not the folder inherits file attributes from above
	SetInheritsPermissions(EntityID, bool, IDatabase)	Set whether or not the folder inherits permissions from above
	SetRoleAccess(EntityID, EntityID, RoleAccessType, RoleAccessType, IDatabase)	Set some project role access for a folder
	SetUserAccess(EntityID, EntityID, RoleAccessType, RoleAccessType, IDatabase)	Set some user access for a folder
	ToString	Returns a string that represents the current object. (inherited from Object).

Top