Folder Object Methods
The Folder object methods affect the current folder object.
ApplyPropertyValues Method
Saves the current property values to the current folder object.
Syntax
ApplyPropertyValues()
Parameters
This method accepts no parameters.
ChangeFolderType Method
Changes the folder type of the current folder object.
Syntax
ChangeFolderType(NewFoldertype As String)
| Name | Description |
|---|---|
|
NewFolderType |
The name of the new folder type. |
Remarks
For events to occur for this method, the ChangeFolderTypeEvents setting in the [ScriptEvents] section on the Application Integration tab of Application Settings in Configurator must be set to Y (default).
ConvertToProject Method
Converts the current folder object to a specified project folder.
Syntax
ConvertToProject (ProjectDefinitionName As String)
| Name | Description |
|---|---|
|
ProjectDefinitionName |
The name of the project definition. |
CopyProperties Method
Copies all of the property values of the current folder to a specified folder except for an optional array of property names.
Syntax
CopyProperties(PropertySetName As String, TargetFolder As Folder, [ExcludeProperties] As String)
| Name | Description |
|---|---|
|
PropertySetName |
Name of the property set to copy. |
|
TargetFolder |
Folder object to which to copy the properties. |
|
ExcludeProperties |
Optional one dimension array of a property names to exclude from copying. |
Remarks
The following example copies all properties in the property set MyPropSet to the specified folder object except for the properties named Prop1 and Prop2.
Folder.CopyProperties "MyPropSet", Folder, Array("Prop1", "Prop2")
Delete Method
ExecTransition Method
Executes the specified project workflow transition for the current folder object.
Syntax
ExecTransition(WorkflowTransition As IASWorkflowTransition, [Comments As String], [Managers As String])
| Name | Description |
|---|---|
|
WorkflowTransition |
An object that represents the project workflow transition to run. |
|
Comments |
Optional comments to append to the comment log. |
|
Managers |
Optional user names to assign as the new workflow managers. |
Remarks
For events to occur for this method, the PrjWFEvents setting in the [ScriptEvents] section on the Application Integration tab of Application Settings in Configurator must be set to Y(default).
FindDocuments Method
Used to search the documents in a folder.
Syntax
FindDocuments (Wildcard As String, [DocumentTypes], [PropertyFilters], [LogicalOR As Boolean = False], [SearchScope As Integer = AS_SEARCHSCOPE_CURRENTFOLDER) As IASDocuments
| Name | Description |
|---|---|
|
SearchScope |
There are two constants that can be used for this parameter: AS_SEARCHSCOPE_CURRENTFOLDER or AS_SEARCHSCOPE_RECURSIVE.
|
GetExpectedTransitionResult Method
Returns the expected result of executing the specified project workflow transition for the current folder object.
Syntax
GetExpectedTransitionResult(Transition As IASWorkflowTransition) As AS_WORKFLOW_TRANS_RES
| Name | Description |
|---|---|
|
Transition |
An object that represents the project workflow transition to run. |
Remarks
Returns a long integer that is equivalent to one or more of the AS_WORKFLOW_TRANS_RES constants that represents the expected results. Use this method to determine the current consensus status of parallel workflows.
GetSubFolder Method
Returns a folder object that represents a subfolder of the current folder object.
Syntax
GetSubFolder(Name As String, [TypeName As String], [Options As Long = 0]) As IASFolder6
Return Value
A Folder object.
Remarks
Pass the AS_NFO_CREATE_IFNOTEXIST constant to this method to create a new subfolder equivalent to the NewFolder method.
For the wizard events to occur for this method, the NewWizardEvents setting in the [ScriptEvents] section on the Application Integration tab of Application Settings in Configurator must be set to Y. The default is N.
GetSubFolderNames Method
Gets the names of the subfolders of the current folder object.
Syntax
GetSubFolderNames([FolderType As String])
| Name | Description |
|---|---|
|
FolderType |
Optional folder type of the subfolders to return. |
Return Value
An array of subfolder names.
GetUsersWithRole Method
Gets all users with a specified security role for the current folder.
Syntax
GetUsersWithRole (Role As String)
| Name | Description |
|---|---|
|
Role |
The name of the role for which to get users. |
Return Value
An array of strings containing the user names.
Interlock Method
Returns the result of evaluating the specified interlock.
Syntax
Interlock(InterlockName As String, [InterlockLocationRLOCK_LOCATION = AS_WFIL_PARENT_PROJECT], [DefaultResult As Boolean = False]) As Boolean
| Name | Description |
|---|---|
|
InterlockName |
The name of the interlock to evaluate. |
|
InterlockLocation |
The location of the interlock to evaluate expressed as one of the AS_WFINTERLOCK_LOCATION constants. |
|
DefaultResult |
A value to return by default if the interlock is not satisfied. |
LinkToPortal Method
Links the Meridian project to a Meridian Portal project
Syntax
LinkToPortal()
Parameters
This method accepts no parameters.
MoveTo Method
Moves the current folder to the specified folder.
Syntax
MoveTo(TargetFolder As IASFolder3, [Options As Long = 0], [Comments])
| Name | Description |
|---|---|
|
TargetFolder |
An object that represents the folder to which to move the current document object. |
|
Options |
An optional long integer that represents the move options. One or more of the AS_MOVE_OPTIONS constants. |
NewFolder Method
Creates a new subfolder of the current folder object.
Syntax
NewFolder(FolderName As String, TypeName As String, [Options As Long = 0]) As IASFolder
Return Value
A Folder object.
Remarks
The AS_NFO_CREATE_IFNOTEXIST constant can also be passed to the GetSubFolder method to create a new subfolder.
The AS_NFO_SHOWWIZARD is not supported in PowerWeb.
ReassignWorkflowManagers Method
Reassigns the workflow definition managers of the current folder object.
Syntax
ReassignWorkflowManagers(Managers, [Comments])
| Name | Description |
|---|---|
|
Managers |
The user names of the new workflow managers. |
|
Comments |
Optional comments to add to the document's Comments property. |
Remarks
For events to occur for this method, the PrjWFEvents setting in the [ScriptEvents] section on the Application Integration tab of Application Settings in Configurator must be set to Y (default).
Reroute Method
Reroutes the current folder object to a specified project workflow state.
Syntax
Reroute(WorkFlowState, [Comments], [Managers])
| Name | Description |
|---|---|
|
WorkFlowState |
The name of the state to which to reroute the folder. |
|
Comments |
Optional comments to add to the folder's Comments property. |
|
Managers |
Optional user names of the new workflow managers. |
ResetPropertyValues Method
Resets the properties of the current folder object.
Syntax
ResetPropertyValues()
Parameters
This method accepts no parameters.
