SetStateEventArgs Class

Note: This API is now obsolete.

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

System.Object
  System.EventArgs
    System.Workflow.Activities.SetStateEventArgs

Namespace:  System.Workflow.Activities
Assembly:  System.Workflow.Activities (in System.Workflow.Activities.dll)

'Declaration
<SerializableAttribute> _
<ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")> _
<ComVisibleAttribute(False)> _
Public Class SetStateEventArgs _
	Inherits EventArgs

The SetStateEventArgs type exposes the following members.

  NameDescription
Public methodSetStateEventArgsInitializes a new instance of the SetStateEventArgs class.
Top

  NameDescription
Public propertyTargetStateNameGets the state to set the StateActivity to.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

NoteNote

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.

.NET Framework

Supported in: 4, 3.5, 3.0
Obsolete (compiler warning) in 4.5.2
Obsolete (compiler warning) in 4.5.1
Obsolete (compiler warning) in 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft