IAMDocumentWorkflow interface

You are here: COM API reference > Server objects > IAMDocumentWorkflow interface

IAMDocumentWorkflow interface

This interface for AMDocument objects is used to manage document type workflow. Document workflow functionality is only available when Work Isolation Mode has been disabled. This interface applies to the predefined workflow states and transitions available with document types. For workflow definitions, the IAMDocumentConfigurableWorkflow interface should be used.

Members (IAMDocumentWorkflow)
Name	Description
ChangeState method	Moves document to the next workflow state
Comment property	The last line added to the document log
GetPossibleStateUsers method	Reserved. See “About reserved objects, methods, and properties.”
InitState property	Reserved. See “About reserved objects, methods, and properties.”
Log property	The content of the document log
Manager property	The name of the current workflow manager
PossibleNextStates property	Returns a combination of DWF_STATES constants for the states to which the user can move the document
ReleaseDocument method	Reserved. See “About reserved objects, methods, and properties.”
Revoke method	Revokes the document to the last released revision
Status property	The current workflow state. See DWF_STATES constants.
StatusText property	A description of the current workflow state
TodoAction property	A description of the action associated with the current workflow state
TodoPerson property	The name of the current To Do person

Members (IAMDocumentWorkflow2)
Name	Description
AddComment method	Sets the Comment property of the document log.
AddToLog method	Do not use this method.
AddToLogWithComment method	Do not use this method.
AddToLogWithTimeStamp method	Sets the Comment property and adds the text to the document log.
CanChangeTodoPerson property	True if the user is allowed to forward the document.
ChangeTodoPerson method	Forwards the document to another user.
ClearLog method	Empties the document log.

Members (IAMDocumentWorkflow3)
Name	Description
SetStateToReleased method	Releases the document from workflow

Remarks

This interface is implemented by the AMDocument object.

Example

Public Sub AddTextToDocumentLog(doc As AMDocument, Text As String)
    Dim wf As IAMDocumentWorkFlow3
    Set wf = doc
    wf.AddToLog Text
End Sub