Class StartInstanceEventArgs
This class is used with InstanceStarting when a new workflow instance is about to be started
Inheritance
System.Object
System.EventArgs
StartInstanceEventArgs
Inherited Members
System.EventArgs.Empty
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: 7.19.2Syntax
public class StartInstanceEventArgs : EventArgsConstructors
StartInstanceEventArgs(WorkflowDefinition, IDictionary<String, Object>)
Initializes a new instance of the StartInstanceEventArgs class.
Declaration
public StartInstanceEventArgs(WorkflowDefinition definition, IDictionary<string, object> namedValueArgs)Parameters
| Type | Name | Description |
|---|---|---|
| WorkflowDefinition | definition | The definition that an instance is to be started of |
| System.Collections.Generic.IDictionary<System.String, System.Object> | namedValueArgs | The start parameters that will be passed to instance |
Properties
Cancel
Gets or sets a value indicating whether to cancel the instance from being started
Declaration
public bool Cancel { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
CancelReason
Gets or sets a message for why the action was cancelled
Declaration
public string CancelReason { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The reason why the action was cancelled |
NamedValueArgs
Use this to pass start arguments to the workflow instance that is about to be created
Declaration
public IDictionary<string, object> NamedValueArgs { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Object> | The named value args. |
Remarks
passed objects should be serializable
WorkflowDefinition
Gets the workflow definition that an instance will be created of.
Declaration
public WorkflowDefinition WorkflowDefinition { get; }Property Value
| Type | Description |
|---|---|
| WorkflowDefinition | The workflow definition. |
