This documentation is archived and is not being maintained.

UserTrackPoint Class

Defines a point, associated with a user event, to be tracked in the potential execution path of a root workflow instance. This class cannot be inherited.

System.Object
  System.Workflow.Runtime.Tracking.UserTrackPoint

Namespace:  System.Workflow.Runtime.Tracking
Assembly:  System.Workflow.Runtime (in System.Workflow.Runtime.dll)

public sealed class UserTrackPoint

The UserTrackPoint type exposes the following members.

  NameDescription
Public methodUserTrackPointInitializes a new instance of the UserTrackPoint class.
Top

  NameDescription
Public propertyAnnotationsGets the collection of annotations associated with the track point.
Public propertyExcludedLocationsGets the collection of locations that should be excluded from the track point by the runtime tracking infrastructure.
Public propertyExtractsGets a collection that specifies data to be extracted from the workflow instance and sent to the tracking service.
Public propertyMatchingLocationsGets the collection of locations that should be included in matching for the track point by the runtime tracking infrastructure.
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 a hash function for a particular type. (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

An activity designer or a workflow designer may use the overloaded Activity.TrackData and ActivityExecutionContext.TrackData methods to instrument the workflow to emit data to the runtime tracking infrastructure as a user event. The data emitted is referred to as user data. Unlike activity status events, and workflow status events, which occur only on status changes, user events can occur at any location that is instrumented in a workflow. There are many reasons to instrument a workflow to emit user events. For example, a workflow designer may want to communicate logical state information about the progress of a workflow, or an activity designer might want to provide an opportunity to activity members at times other than an activity status change.

A UserTrackPoint defines a point of interest in the potential execution path of a root workflow instance associated with a user event. A UserTrackPoint contains locations that are included in matching, locations that are excluded from matching, and any additional data that should be extracted from the workflow instance when the track point is matched. You can add a UserTrackPoint to TrackingProfile.UserTrackPoints to instruct the runtime tracking infrastructure to send a UserTrackingRecord to the tracking service when the track point is matched. The user data is returned in UserTrackingRecord.UserData. A single UserTrackPoint may be matched at multiple points in the workflow instance.

A UserTrackingLocation contains match conditions for a location associated with a user event in the potential execution path of a workflow instance. You can add UserTrackingLocation objects to MatchingLocations to define locations that should be included in matching for the track point. Similarly, you can add UserTrackingLocation objects to ExcludedLocations to define locations that should be excluded from matching for the track point.

You can add ActivityDataTrackingExtract objects and WorkflowDataTrackingExtract objects to Extracts to specify data that should be extracted from the workflow instance when the track point is matched. The extracted data will be returned in UserTrackingRecord.Body.

You can add to Annotations to specify additional information associated with the track point. These annotations will be returned in UserTrackPoint.Annotations.

For an example of how to use this class, see the Tracking Using User Track Points Sample.

.NET Framework

Supported in: 4, 3.5, 3.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Show: