Edit

Share via

SetStateEventArgs Class

  • Reference

Definition

Namespace:
System.Workflow.Activities
Assembly:
System.Workflow.Activities.dll

Caution

The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*

Represents a class that is used as an argument to set the state of a StateMachineWorkflowActivity.

public ref class SetStateEventArgs : EventArgs
[System.Runtime.InteropServices.ComVisible(false)]
[System.Serializable]
public class SetStateEventArgs : EventArgs
[System.Runtime.InteropServices.ComVisible(false)]
[System.Serializable]
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public class SetStateEventArgs : EventArgs
[<System.Runtime.InteropServices.ComVisible(false)>]
[<System.Serializable>]
type SetStateEventArgs = class
    inherit EventArgs
[<System.Runtime.InteropServices.ComVisible(false)>]
[<System.Serializable>]
[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type SetStateEventArgs = class
    inherit EventArgs
Public Class SetStateEventArgs
Inherits EventArgs
Inheritance
Object
EventArgs
SetStateEventArgs
Attributes
ComVisibleAttribute SerializableAttribute ObsoleteAttribute

Remarks

Note

This material discusses types and namespaces that are obsolete. For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

The StateMachineWorkflowActivity allows for setting the state from the host application. This enables the host application to override the current state of a state machine. This can be accomplished by enqueuing an instance of the SetStateEventArgs class to the WorkflowQueue named by the constant StateMachineWorkflowActivity.SetStateQueueName.

A simpler way to accomplish this is to use the SetState method in the StateMachineWorkflowInstance class.

You can use the SetState method to perform a SetState operation from the host, or you can do it yourself by enqueuing an event to the state machine workflow as shown in the following example.

public void SetState(string targetStateName)  
{  
      if (targetStateName == null)  
      {  
            throw new ArgumentNullException("targetStateName");  
      }  
      SetStateEventArgs args1 = new SetStateEventArgs(targetStateName);  
      this.WorkflowInstance.EnqueueItemOnIdle("SetStateQueue", args1, null, null);  
}

The state machine workflow uses a special queue called SetStateQueue to listen to these special events.

Constructors

SetStateEventArgs(String)

Initializes a new instance of the SetStateEventArgs class.

Properties

TargetStateName

Gets the state to set the StateActivity to.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also