AI OnAI Off

Class WorkflowDefinitionInstance

Represents an running instance of a workflow definition

Inheritance
System.Object
WorkflowDefinitionInstance
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.WorkflowFoundation
Assembly: EPiServer.WorkflowFoundation.dll
Version: 8.11.0
Syntax
public class WorkflowDefinitionInstance : IItem, IDeepCopy<WorkflowDefinitionInstance>
Remarks

implements IItem to make it possible to persist in Object Store

Constructors

WorkflowDefinitionInstance(Guid, WorkflowDefinition, String, PageReference)

Initializes a new instance.

Declaration
public WorkflowDefinitionInstance(Guid instanceId, WorkflowDefinition definition, string initiator, PageReference pRef)
Parameters
Type Name Description
System.Guid instanceId

The instance id.
WorkflowDefinition definition

the name of the definition this instance is of
System.String initiator

The initiator.
PageReference pRef

page that triggered Workflow
Remarks

Should not be created directly. It is created implicitly by calls to IInstanceHandler.StartInstance

Properties

DefinitionId

Gets the definition id.

Declaration
public Guid DefinitionId { get; }
Property Value
Type Description
System.Guid

The definition id.

DefinitionName

Name of the definition

Declaration
public string DefinitionName { get; }
Property Value
Type Description
System.String

History

Retrieve all history items

Declaration
public ReadOnlyCollection<HistoryItem> History { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<HistoryItem>

Id

Object store identity

Declaration
public object Id { get; }
Property Value
Type Description
System.Object

Initiator

Gets the initiator May not be set if instance is started automatically

Declaration
public string Initiator { get; }
Property Value
Type Description
System.String

The initiator.

InstanceId

The id of this instance

Declaration
public Guid InstanceId { get; }
Property Value
Type Description
System.Guid

Name

Object store name

Declaration
public string Name { get; }
Property Value
Type Description
System.String

PageLanguageID

Specifies if workflow instance is tied to a secific language for a page

Declaration
public string PageLanguageID { get; set; }
Property Value
Type Description
System.String

The page this instance is considered related to. If instance was automatically started according to DataFactory event this is set to that page. Can also be set from AssociateWithPage activity.

Declaration
public PageReference PageLink { get; set; }
Property Value
Type Description
PageReference

SystemInstance

Gets the wrapped system instance

Declaration
public WorkflowInstance SystemInstance { get; }
Property Value
Type Description
System.Workflow.Runtime.WorkflowInstance

The system instance.

Type

The compiled type of the Workflow

Declaration
public Type Type { get; }
Property Value
Type Description
System.Type

TypeFullName

Gets the full name of the type, including assembly.

Declaration
public string TypeFullName { get; }
Property Value
Type Description
System.String

The full name of the type.

UserData

Gets an IDictionary that makes it possible to associate custom data with this instance

Declaration
public IDictionary<string, object> UserData { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks

objects stored must be serializable. If custom types is used their schema should be registered with Object store

Methods

AddHistoryItem(HistoryItem)

Adds an occurance to the list of history occurances for this instance

Declaration
public void AddHistoryItem(HistoryItem item)
Parameters
Type Name Description
HistoryItem item

occurance to add

DeepCopy()

makes a deep copy of the instance

Declaration
public WorkflowDefinitionInstance DeepCopy()
Returns
Type Description
WorkflowDefinitionInstance

A copy of instance

Implements