AI OnAI Off

Class WorkflowPageEventArgs

Used in communication between host and Workflow activities. Represents an event from DataFactory.

Inheritance
System.Object
WorkflowPageEventArgs
Namespace: EPiServer.WorkflowFoundation.Activities
Assembly: EPiServer.WorkflowFoundation.dll
Version: 8.11.0
Syntax
public class WorkflowPageEventArgs : ExternalDataEventArgs
Remarks

The cached item of type PageEventArgs can be recieved from CacheService using System.IServiceProvider (can be recieved e.g. by overriding Initialize on Workflow class).

Examples

Shows how Cache service can be used

Constructors

WorkflowPageEventArgs(WorkflowPageEvent, PageReference, PageReference, String, Guid)

Initializes a new instance of the WorkflowPageEventArgs class.

Declaration
public WorkflowPageEventArgs(WorkflowPageEvent eventType, PageReference pageLink, PageReference targetLink, string cacheKey, Guid workflowInstanceId)
Parameters
Type Name Description
WorkflowPageEvent eventType

Type of the event.
PageReference pageLink

The page link that relates to this event
PageReference targetLink

The target that relates to this event
System.String cacheKey

The cache key to the cached PageEventArgs class
System.Guid workflowInstanceId

The workflow instance id.
Remarks

The cached item of type PageEventArgs can be recieved from CacheService using System.IServiceProvider (can be recieved e.g. by overriding Initialize on Workflow class).

Examples

Shows how Cache service can be used

Properties

CacheKey

Gets the cache key, can be used to store a none serializable object.

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

The cache key.
Remarks

The cached item of type PageEventArgs can be recieved from CacheService using System.IServiceProvider (can be recieved e.g. by overriding Initialize on Workflow class).

Examples

Shows how Cache service can be used

EventType

Gets the type of the triggering event.

Declaration
public WorkflowPageEvent EventType { get; }
Property Value
Type Description
WorkflowPageEvent

The type of the event.
Remarks

corresponds to page event in DataFactory

The id from the PageLink property on the associated PageEventArgs

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

The id from the TargetLink property on the associated PageEventArgs

Declaration
public PageReference TargetLink { get; }
Property Value
Type Description
PageReference