WorkflowState Object

The WorkflowState object represents a state in a workflow definition. The WorkflowState object is available to the Document and Folder (if the Advanced Project Workflow Module is installed) objects.

WorkflowState Object Properties

The WorkflowState object provides the following properties, all of which are read-only.

ClosedDisplayName Property

The name of the workflow state as seen by users. Read-only.

Syntax

DisplayName As String

ClosedName Property

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.

ClosedType Property

The type of the workflow state expressed as one of the  AS_WORKFLOW_STATE_TYPE constants. Read-only.

Syntax

Type As AS_WORKFLOW_STATE_TYPE

ClosedWorkflow Property

The parent workflow object. Read-only.

Syntax

Workflow As IASWorkflow

2024