Folder Object Properties
The Folder object provides the following properties, most of which are read-only. To affect some read-only properties requires user interaction or custom event procedures.
The AMProjectWorkflowPropertySet property set is assigned to a folder type when a workflow definition is assigned to the folder type. If the workflow definition is unassigned later, the property set will remain assigned to the folder type and cannot be removed. This is necessary to support vault history and is similar to property sets assigned to document types. Also, if the folder type is assigned to multiple levels of a Field-Path definition, the values returned to documents in the structure will be from the immediately previous level. Because the value can be inconsistent, routed properties should only be used in vault customization with great care.
Gets or sets the name of the document type to apply to documents that are automatically created in the current folder.
Syntax
AutoDocumentType As String
Remarks
The documents may be created because the folder is a shared workspace and the documents were created in the linked folder that resides outside the vault. The documents are then imported into the vault when the shared workspace is synchronized with the vault. For more information about configuring shared workspaces, see Configure Shared Workspaces.
The date and time when the folder was created. Read-only.
Syntax
Created As Date
An object that represents the user who created the folder. Read-only.
Syntax
CreatedBy As IASUser
True if the folder or its sub folder contains documents. Read-only.
Syntax
HasDocuments As Boolean
Returns the ID of the current object. The value is unique within the current vault. For the ID value that is unique among all vaults, retrieve the GlobalID property value, if available. Read-only.
Syntax
ID As String
True if the folder is associated with a project definition. Read-only.
Syntax
IsProject As Boolean
True if the specified value for the specified folder property is unique within the current vault. Read-only.
Syntax
IsUniqueValue(PropertyName, Value) As Boolean
ProjectFolderPropertySet.ProjectID value for current project folder. Read-only.
Syntax
LinkedProjectID As String
Returns the name of the current object. Depending on the object type, this property returns the display name of the object or it returns the internal name and may be read-only.
Syntax
Name As String
Remarks
If the current object is a Package, it must be in the Open status to set the value.
If the current object is a User, this property is the short name of the user as stored in the user's Meridian account information and is read-only. This property can be used to specify the recipient's email address and either an empty string or no value set in the Address property. If an email address is specified in Name, it must be surrounded with carets (<>). When used with Microsoft Outlook, the Name property may contain the user's full name or last name and Outlook will attempt to resolve the name to the email address in the default address book.
Meridian user names can be shown in different formats determined by the UserNameFormatserver registry setting.
An object that represents the parent folder of the folder. Read-only.
Syntax
ParentFolder As IASFolder3
An object that represents the parent project folder of the current project object. Read-only.
Syntax
ParentProject As IASFolder3
Relative path of the folder from the root of the vault. Read-only.
Syntax
Path As String
The name of the project type as seen by users. Read-only.
Syntax
ProjectTypeDisplayName As String
The internal name of the current project type object. Read-only.
Syntax
ProjectTypeName As String
The value of the specified (String) folder property.
Syntax
Property(Name) As Variant
An object that represents the security roles that are applied to the current folder object.
For information about the Roles object, see Roles Object. For information about configuring security roles, see Security Roles. For information about assigning security roles to folders, see Assign Security Roles To a Folder.
An object that represents the specified folder sequence.
Important!
Using the vault name as a sequence name can cause errors and possibly crash the Meridian EDM Server service.
For information about the Sequence object, see Sequence Object. For information about using sequences in file names, see File Name Calculation.
Syntax
Sequence(Name) As IASSequence
A server ShareID to get a transaction object from another process. Read-only.
Syntax
ShareID As String
The Display Name value of the folder type. Read-only.
Syntax
TypeDisplayName As String
The Name value of the folder type. Read-only.
Syntax
TypeName As String
The names of the managers of the current workflow object. This property is a string when there is a single user and a string array when multiple users are assigned.
You can test with the function
IsArray(Folder.WorkflowManagers)
whether there are one or multiple users. Read-only.
Syntax
WorkflowManagers As String
Long integer that represents one or more AS_WF_STATE constants. Read-only.
Syntax
WorkFlowState As AS_WF_STATE
A long integer that represents one or more AS_PWF_STATUS constants. Read-only.
Syntax
WorkflowStatus As AS_PWF_STATUS
AutoDocumentType Property