Folder Class

Namespace: SynergyServerScripting.Entities
Assembly: SynergyServerScripting (in SynergyServerScripting.dll)
VB
C#
F#
C++
JScript
Copy 
<Obfuscation(Exclude = true, ApplyToMembers = true)> _ 
Public Class Folder
This language is not supported or no code example is available.
VB
C#
F#
C++
JScript
Copy 
[Obfuscation(Exclude = true, ApplyToMembers = true)] 
public static class Folder
This language is not supported or no code example is available.
VB
C#
F#
C++
JScript
Copy 
[Obfuscation(Exclude = true, ApplyToMembers = true)] 
public ref class Folder 
This language is not supported or no code example is available.
VB
C#
F#
C++
JScript
Copy 
public  
   Obfuscation(Exclude = true, ApplyToMembers = true) 
class Folder
This language is not supported or no code example is available.
Methods
 
Name Description
Public method Static AddChangeAttribute(EntityID, EntityID, bool, Nullable<Int64>, IDatabase) Add a change attribute
Public method Static AddChangeAttribute(EntityID, EntityID, bool, IDatabase) Add a change attribute
Public method Static AssociateManagedFolderChangeWithFileChanges(EntityID, IEnumerable<EntityID>, IDatabase) Given a set of file changes, associate them with the latest change for that folder
Public method Static AssociateManagedFolderChangeWithFileChanges(IEnumerable<EntityID>, IDatabase) Given a set of file changes, associate them with the latest change for that folder
Public method Static AttachAttributeToFolder(EntityID, EntityID, bool, EntityID, IDatabase) Attach an attribute for a folder
Public method Static CancelCheckOut(EntityID, IDatabase) Cancel a check out
Public method Static CheckInFolder(EntityID, bool, EntityID, bool, string, int, bool, IDatabase, Dictionary<EntityIDFolderState>) Check a folder back in
Public method Static CheckoutFolder(EntityID, EntityID, bool, string, IDatabase) Check out a managed folder
Public method Static ClearUserFolderLayouts(IDatabase) Clear any user folder layouts
Public method Static ContainsFile(EntityID, string, IDatabase) Does this folder contain a file of a given name?
Public method Static CreateFolder(EntityID, string, EntityID, EntityID, bool, bool, FolderType, EntityID, IDatabase) Create a folder
Public method Static CreateFolder(string, EntityID, EntityID, bool, bool, FolderType, EntityID, IDatabase) Create a folder
Public method Static CreateManagedFolderChange(EntityID, int, EntityID, string, FolderState, IDatabase) Create a managed folder change
Public method Static DoesFolderHaveIssuedFiles(EntityID, IDatabase) Does this folder have any issued files?
Public method Equals(Object) Determines whether the specified object is equal to the current object. (inherited from Object).
Public method Static ExportFolder(EntityID, bool, bool, bool, bool, bool, string, Func<EntityIDBoolean>, Func<EntityIDBoolean>, EntityID, IDatabase, IClient) Export a folder
Public method Static ExportFolder(EntityID, bool, bool, bool, string, EntityID, IDatabase, IClient) Export a folder
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (inherited from Object).
Public method Static FindAttributesByName(string, IDatabase) Find folder attributes by name
Public method Static FlattenAttributes(EntityID, bool, bool, IDatabase, EntityAttributeCache) For a particular folder, 'flatten' the hierarchical attributes down to a flat list
Public method Static FlattenAttributes(EntityID, bool, bool, IDatabase, EntityAttributeCache, EntityID) For a particular folder, 'flatten' the hierarchical attributes down to a flat list
Public method Static GetActiveCheckout(EntityID, IDatabase) Get the active check out state for a managed folder
Public method Static GetActiveUserCheckouts(EntityID, EntityID, IDatabase) Get information about all files checked out by a user
Public method Static GetActiveUserCheckouts(EntityID, IDatabase) Get information about all files checked out by a user
Public method Static GetActiveUserCheckoutsClosingRules(EntityID, IDatabase) Get information about all Folders checked out by a user that match Active Closing Rules
Public method Static GetAllGroupAccess(EntityID, IDatabase) Get information about all groups who can access a folder (at the folder level only)
Public method Static GetAllRoleAccess(EntityID, IDatabase) Get information about all rolesth atcan access a folder (at the folder level only)
Public method Static GetAllUserAccess(EntityID, IDatabase) Get information about all users who can access a folder (at the folder level only)
Public method Static GetAllowableFileExtensions(EntityID, IDatabase) Get the list of allowed file extensions for a given folder
Public method Static GetBasicFileInfoRecursive(EntityID, IDatabase) Get some really basic file info about the files in this folder
Public method Static GetChangeDetails(EntityID, int, IDatabase) Get change details for a managed folder including change details of sub folders and files
Public method Static GetChangedFolderFiles(EntityID, EntityID, bool, DateTime, IDatabase) Get all visible files in a folder that were changed after a certain date
Public method Static GetCurrentManagedFolderVersion(EntityID, IDatabase) Get the current version for a managed folder
Public method Static GetEntityPath(EntityID, EntityID, IDatabase) Get the path to a folder of a given id
Public method Static GetFileChangesForManagedFolder(EntityID, int, IDatabase) Given a managed folder id, get all the file changes for a particular version
Public method Static GetFileCount(EntityID, IDatabase) Get the number of files in a folder (includes deleted)
Public method Static GetFolder(EntityID, bool, IDatabase) Get the folder info for a folder
Public method Static GetFolderAttributeValue(EntityID, string, IDatabase) Get a project attribute value, based on a name and project id
Public method Static GetFolderAttributes(EntityID, IDatabase) Given a folder id, get all attributes (and values)
Public method Static GetFolderChangeID(EntityID, int, IDatabase) Given a folder and a version (which may be -1 if unknown), get the folder change id
Public method Static GetFolderFileAttributeExtensions(EntityID, EntityID, IDatabase) Given a folder file attribute, find what extensions exist for it
Public method Static GetFolderFileAttributes(EntityID, bool, IDatabase) Get initial attributes for a folder, without looking at extensions
Public method Static GetFolderFileAttributes(EntityID, string, bool, IDatabase) Get initial attributes for a folder
Public method Static GetFolderFileAttributesAndExtensions(EntityID, IDatabase) Given a folder, get all file attributes and their extensions
Public method Static GetFolderFileAttributesWithInheritance(EntityID, string, bool, IDatabase) Get initial attributes for a folder
Public method Static GetFolderFileChangeAttributes(EntityID, bool, bool, IDatabase) Get initial attributes for a file change on a folder
Public method Static GetFolderFileIDs(EntityID, EntityID, IDatabase) Get all visible file ids in a folder
Public method Static GetFolderFileNames(EntityID, EntityID, string, char, char, IDatabase) Get the list of file names in a folder (that the user can see)
Public method Static GetFolderFileNamesAndIDs(EntityID, IDatabase) Get a list of file names and ids in a folder
Public method Static GetFolderFileNamesAndIDs(EntityID, IDatabase, StringComparer) Get a list of file names and ids in a folder
Public method Static GetFolderFiles(EntityID, EntityID, bool, IDatabase) Get all visible files in a folder
Public method Static GetFolderFiles(EntityID, bool, IDatabase) Get all files in a folder
Public method Static GetFolderID(string, EntityID, IDatabase) Given a folder name and a parent, get its id
Public method Static GetFolderIDFromChangeID(EntityID, IDatabase) Get a folder id from change id
Public method Static GetFolderIDFromPath(string, EntityID, IDatabase) Get a folder id from a path
Public method Static GetFolderIDFromPath(string, IDatabase) Get a folder id from a path
Public method Static GetFolderIDFromURIPath(string, EntityID, IDatabase) Given a uri style path, find the folder
Public method Static GetFolderName(EntityID, IDatabase) Get the name of a given folder
Public method Static GetFolderPath(EntityID, IDatabase) Get a folder path as a string
Public method Static GetFolderPath(EntityID, bool, IDatabase) Get a folder path as a string
Public method Static GetFolderType(EntityID, IDatabase) Get the folder type
Public method Static GetFolders(HashSet<EntityID>, IDatabase) Get the folder info for a list of folders
Public method Static GetFolders(HashSet<EntityID>, bool, IDatabase) Get the folder info for a list of folders
Public method Static GetGroupAccess(EntityID, EntityID, IDatabase) Get group access to a folder
Public method Static GetGroupAccessOld(EntityID, EntityID, IDatabase) Get group access to a folder
Public method GetHashCode Serves as the default hash function. (inherited from Object).
Public method Static GetLatestVersion(EntityID, IDatabase) Get the latest version number of a folder - must be a managed folder
Public method Static GetParentFolderID(EntityID, IDatabase) Get the id of the parent folder
Public method Static 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
Public method Static GetProjectID(EntityID, IDatabase) Get the project a folder belongs to
Public method Static GetProjectIDForRootFolder(EntityID, IDatabase) Get the id of a project, given a root folder
Public method Static GetProjectRootFolder(string, EntityID, bool, IDatabase) Get a project root folder by its name
Public method Static GetProjectRootFolderIDs(EntityID, IDatabase) Get all the project root folder as ids
Public method Static GetProjectRootFolders(EntityID, bool, IDatabase) Get all the project root folders
Public method Static GetSubFolder(EntityID, string, bool, IDatabase) Get the sub folder with a certain name from a parent folder
Public method Static GetSubFolderIDs(EntityID, IDatabase) Get all the sub folders of a folder as a list of ids
Public method Static GetSubFolderIDsAndNames(EntityID, IDatabase) Get all the sub folders of a folder as a list of ids and names
Public method Static GetSubFolders(EntityID, bool, bool, IDatabase) Get all the sub folders of a folder
Public method Static GetSubFolders(EntityID, bool, bool, int, IDatabase) Get all the sub folders of a folder
Public method Static GetTDProjectID(string, EntityID, IDatabase) Get the id of a 12d model project by name
Public method GetType Gets the Type of the current instance. (inherited from Object).
Public method Static GetUserAccess(EntityID, EntityID, IDatabase) Get the access type a user has to this folder
Public method Static GetUserAccess(EntityID, EntityID, List<EntityID>, List<EntityID>, IDatabase) Get the access type a user has to this folder
Public method Static GetVisibleTDProjects(EntityID, EntityID, TDConnectionContext, IDatabase) Get a list of all 12d projects inside a folder that the user has access to
Public method Static HasFileExtensionsSet(EntityID, IDatabase) Does a folder have any file extensions set?
Public method Static Index(EntityID, bool, IDatabase) Index a server folder
Public method Static Index(EntityID, bool, bool, IDatabase) Index a server folder
Public method Static Index(ProjectFolder, bool, IDatabase) Index a server folder
Public method Static Index(ProjectFolder, bool, bool, IDatabase) Index a server folder
Public method Static InheritsFromParent(EntityID, IDatabase) Does a folder inherit access permissions from its parent?
Public method Static IsFileExtensionAllowed(string, EntityID, IDatabase) Check if a file extension is allowed in a given folder
Protected method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object).
Public method Static MoveFolder(EntityID, EntityID, bool, EntityID, IDatabase) Move a folder
Public method Static PurgeFolder(EntityID, bool, bool, IDatabase, IClient) Delete a folder from the database
Public method Static RegenAllFilePreviews(EntityID, bool, IDatabase) Regen all file previews
Public method Static RemoveFolderAttribute(EntityID, EntityID, EntityID, IDatabase) Remove a folder attribute
Public method Static RemoveFolderFileAttribute(EntityID, EntityID, EntityID, IDatabase) Remove a folder file attribute
Public method Static RemoveFolderFileChangeAttribute(EntityID, EntityID, EntityID, IDatabase) Remove a folder file change attribute
Public method Static ReplicateFolder(ProjectFolder, EntityID, EntityID, bool, EntityID, IDatabase, IClient) Replicate a folder and all its contents
Public method Static SetAllowableFolderFileExtensions(EntityID, List<String>, IDatabase) Set up any allowable file extensions for a folder
Public method Static SetFolderAttribute(EntityID, AttributeInfo, EntityID, IDatabase) Set a folder attribute
Public method Static SetFolderAttributeValues(EntityID, List<AttributeInfo>, IDatabase) Update folder attributes
Public method Static SetFolderFileAttribute(EntityID, AttributeInfo, List<String>, EntityID, IDatabase) Set a folder file attribute
Public method Static SetFolderFileChangeAttribute(EntityID, AttributeInfo, EntityID, IDatabase) Set a folder file change attribute
Public method Static SetFolderName(EntityID, string, IDatabase) Set the name of a folder
Public method Static SetFolderType(EntityID, FolderType, bool, EntityID, IDatabase) Set the folder type
Public method Static SetGroupAccess(EntityID, EntityID, RoleAccessType, RoleAccessType, IDatabase) Set some group access for a folder
Public method Static SetInheritsFileAttributes(EntityID, bool, IDatabase) Set whether or not the folder inherits file attributes from above
Public method Static SetInheritsFileNamingRules(EntityID, bool, IDatabase) Set whether or not the folder inherits file naming rules from above
Public method Static SetInheritsPermissions(EntityID, bool, IDatabase) Set whether or not the folder inherits permissions from above
Public method Static SetRoleAccess(EntityID, EntityID, RoleAccessType, RoleAccessType, IDatabase) Set some project role access for a folder
Public method Static SetUserAccess(EntityID, EntityID, RoleAccessType, RoleAccessType, IDatabase) Set some user access for a folder
Public method ToString Returns a string that represents the current object. (inherited from Object).
Top
Inheritance Hierarchy
 
SynergyServerScripting.Entities.Folder
Applies to
 

.NET Framework

Supported in: 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1
See Also
 

In this article

Definition