The BCDocumentWorkflow type exposes the following members.

Methods

  NameDescription
Public methodAddComment Obsolete.
Sets a Comment property value.
Public methodAddToLog
Appends a text message to the document log.
Public methodAddToLogWithComment
Appends a text message to the document log.
Public methodAddToLogWithTimeStamp
Appends a text message to the document log.
Public methodAssignManagers(IEnumerable<(Of <<'(String>)>>))
Assigns workflow managers for the document.
Public methodAssignManagers(IEnumerable<(Of <<'(String>)>>), String)
Assigns workflow managers for the document.
Public methodAssignToDoPersons(IEnumerable<(Of <<'(String>)>>))
Assigns workflow to-do persons for the document.
Public methodAssignToDoPersons(IEnumerable<(Of <<'(String>)>>), String)
Assigns workflow to-do persons for the document.
Public methodAvailableTransitions()()()()
Returns the collection of available workflow transition objects.
Public methodAvailableTransitions(BCWorkflowDef)
Starts the workflow and returns the collection of available workflow transition objects.
Public methodChangeState
Moves a document to another workflow state.
Public methodChangeTodoPerson
Forwards a document to another user.
Public methodClearLog
Clears all the content from the document log.
Public methodCreateNewRevision()()()()
Creates a new revision for the document.
Public methodCreateNewRevision(String)
Creates a new revision for the document.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecuteTransition(BCWorkflowTransition)
Executes a workflow transition.
Public methodExecuteTransition(BCWorkflowTransition, String)
Executes a workflow transition.
Public methodExecuteTransition(BCWorkflowTransition, String, IEnumerable<(Of <<'(String>)>>), IEnumerable<(Of <<'(String>)>>))
Executes a workflow transition.
Public methodExpectedTransitionResult
Returns an expected result of the specified transition.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetPossibleStateUsers(DocumentWorkflowFlags)
Returns an array containing the user and user group names that have privileges in the specified state.
Public methodGetPossibleStateUsers(DocumentWorkflowFlags, Boolean, Boolean)
Returns an array containing user work list name and user full name for users that have privileges in specified given state.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitState
Initialize a new document to the given state.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMigrate(BCWorkflowDef)
Migrates the document to a new configurable workflow.
Public methodMigrate(BCWorkflowDef, BCWorkflowState)
Migrates the document to a new configurable workflow.
Public methodMigrate(BCWorkflowDef, BCWorkflowState, String)
Migrates the document to a new configurable workflow.
Public methodRerouteToState(BCWorkflowState)
Reroutes the document in a workflow to a new state.
Public methodRerouteToState(BCWorkflowState, String)
Reroutes the document in workflow to a new state.
Public methodRerouteToState(BCWorkflowState, String, IEnumerable<(Of <<'(String>)>>))
Reroutes the document in workflow to a new state.
Public methodRerouteToState(BCWorkflowState, String, IEnumerable<(Of <<'(String>)>>), Boolean)
Reroutes the document in workflow to a new state.
Public methodRevoke
Revokes the document to the last released revision.
Public methodRevokeWorkflow()()()()
Revokes the document from workflow.
Public methodRevokeWorkflow(String)
Revokes the document from workflow.
Public methodSetStateToReleased
Releases the document from the workflow.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)

Properties

  NameDescription
Public propertyCanChangeTodoPerson
Gets a value indicating whether a user is allowed to forward the document.
Public propertyComment
Gets or sets the text message of a document log comment (the last added line).
Public propertyDocument
Gets the document the workflow manages.
Public propertyLog
Gets the content of the document log.
Public propertyManager
Gets or sets the user name of the current workflow manager.
Public propertyManagers
Gets the array of user names of the current managers.
Public propertyPossibleNextStates
Gets possible states to which a user can move the document.
Public propertyStatus
Gets the current workflow state.
Public propertyStatusText
Gets the description of the current workflow state.
Public propertyTodoAction
Gets the description of the action associated with the current workflow state.
Public propertyTodoPerson
Gets or sets the user name of the current to-do person.
Public propertyTodoPersons
Gets the array of user names of the current to-do persons.
Public propertyWorkflowDef
Gets the current workflow definition of the document.
Public propertyWorkflowState
Gets the current workflow state of the document.

See Also