Class StartInstanceEventArgs

This class is used with InstanceStarting when a new workflow instance is about to be started

System.Object

System.EventArgs

StartInstanceEventArgs

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()

Version: 8.11.0

public class StartInstanceEventArgs : EventArgs

Initializes a new instance of the StartInstanceEventArgs class.

public StartInstanceEventArgs(WorkflowDefinition definition, IDictionary<string, object> namedValueArgs)

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

Gets or sets a value indicating whether to cancel the instance from being started

public bool Cancel { get; set; }

Type	Description
System.Boolean	`true` if action should be cancelled; otherwise, `false`.

Gets or sets a message for why the action was cancelled

public string CancelReason { get; set; }

Type	Description
System.String	The reason why the action was cancelled

Use this to pass start arguments to the workflow instance that is about to be created

public IDictionary<string, object> NamedValueArgs { get; }

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	The named value args.

passed objects should be serializable

Gets the workflow definition that an instance will be created of.

public WorkflowDefinition WorkflowDefinition { get; }

Type	Description
WorkflowDefinition	The workflow definition.