Folder Class

This object represents a Folder, and is derived from the ContentObject class. All properties and methods from the ContentObject are supported for this object, plus the properties below.

Properties

PROPERTY NAME

 DATA TYPE

DESCRIPTION

ID

 String

The ID of this specific form instance

Name

 String

The text name of this specific form instance

PID

 String

The Partition ID of the partition where this form resides

CreateTime

 DateTime

The date/time of this specific form instance’s creation

UpdateTime

 DateTime

The most recent date/time that a user changed this specific form instance

CreateUID

 String

The User ID of the user which created this specific form instance

UpdateUID

 String

The User ID of the user who most recently update this specific form instance

Methods

Link

This API will create the complete folder path for the specific input.

Parameters

BP: The Process Director BP Object

PartitionID: The ID of the partition to use.

Path: The complete path to of the folder structure to create.

Returns

Folder: The newly created folder.

Example

// Normally not used directly
var oFolder = Folder.CreatePath(bp, CurrentPartition, "/folder1/folder2");

Link

This API will create a new folder in the specified parent.

Parameters

BP: The Process Director BP Object

ParentID: The ID of the parent.

FolderName: The name of the new folder to create.

Returns

Folder: The newly created folder.

Example

// Normally not used directly
var oFolder = Folder.CreateNewFolder(bp, SomeParentID, "New Folder");

Link

This API will create a sub folder under the current folder

Parameters

FolderName: The name of the folder to create.

Returns

Folder: The newly created folder.

Example

var oFolder = Folder.CreateNewFolder(bp, SomeParentID, "New Folder");
var NewFolder = oFolder.CreateSubFolder("Subfolder Name");

Link

This API will get a Folder from the specified ID.

Parameters

BP: The Process Director BP Object.

FID: The ID of the folder to retrieve.

Returns

Folder: The actual folder or null if not found.

Example

Var oFolder = Folder.GetFolderByID (bp, "FolderID");

Link

This API will get a Folder object from the specified Folder Path.

Parameters

BP: The Process Director BP Object

PID: The Partition ID or name.

PathName: The complete path of folder to retrieve.

Returns

Folder: Will return null if partition isn't found.

Example

var oFolder = Folder.GetFolderByPathName (bp, CurrentPartition, "/folder1/folder2");