Export (0) Print
Expand All

UserTrackingLocation Class

Note: This API is now obsolete.

Defines an activity-qualified location that corresponds to a user event in the potential execution path of a root workflow instance. This class cannot be inherited.

System.Object
  System.Workflow.Runtime.Tracking.UserTrackingLocation

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

[SerializableAttribute]
[ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public sealed class UserTrackingLocation

The UserTrackingLocation type exposes the following members.

  NameDescription
Public methodUserTrackingLocation()Initializes a new instance of the UserTrackingLocation class.
Public methodUserTrackingLocation(String)Initializes a new instance of the UserTrackingLocation class by using the unqualified name of the common language runtime (CLR) type of the user data.
Public methodUserTrackingLocation(Type)Initializes a new instance of the UserTrackingLocation class using the common language runtime (CLR) type of the user data.
Public methodUserTrackingLocation(String, String)Initializes a new instance of the UserTrackingLocation class by using the unqualified name of the common language runtime (CLR) type of the user data and the unqualified name of the CLR type of the activity from which the user data must be emitted.
Public methodUserTrackingLocation(String, Type)Initializes a new instance of the UserTrackingLocation class by using the unqualified name of the common language runtime (CLR) type of the user data and the CLR type of the activity from which the user data must be emitted.
Public methodUserTrackingLocation(Type, String)Initializes a new instance of the UserTrackingLocation class by using the common language runtime (CLR) type of the user data and unqualified name of the CLR type of the activity from which the user data must be emitted.
Public methodUserTrackingLocation(Type, Type)Initializes a new instance of the UserTrackingLocation class by using the common language runtime (CLR) type of the user data and the CLR type of the activity from which the user data must be emitted.
Top

  NameDescription
Public propertyActivityTypeGets or sets the common language runtime (CLR) type of the activity from which the user data must be emitted to be tracked.
Public propertyActivityTypeNameGets or sets the unqualified name of the common language runtime (CLR) type of the activity from which the user data must be emitted to be tracked.
Public propertyArgumentTypeGets or sets the common language runtime (CLR) type of the user data to be tracked.
Public propertyArgumentTypeNameGets or sets the unqualified name of the common language runtime (CLR) type of the user data to be tracked.
Public propertyConditionsGets a collection of conditions that are used to qualify the activity from which the user data must be emitted to be tracked.
Public propertyKeyNameGet or sets the name with which the user data must be associated for the UserTrackingLocation to be matched.
Public propertyMatchDerivedActivityTypesGets or sets a value that indicates whether the user data should be tracked when it is emitted from activities derived from the activity type specified by ActivityType or ActivityTypeName.
Public propertyMatchDerivedArgumentTypesThe User tracking location is a way to filter user tracked data. The user can filter by the type of the user tracked data by specifying the ArgumentType or ArgumentTypeName. Setting the MatchDerrivedArgumentTypes Boolean value to true specifies that the user tracked data can be of type ArgumentType/ArgumentTypeName or a type derived from the ArgumentType/ArgumentTypeName.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (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.

An activity designer or a workflow designer may use any of 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 activity or workflow status changes, user events can occur at any location that is instrumented in a workflow. A UserTrackingLocation defines the matching parameters for such a location by specifying the type of the user data, the type of the activity from which it must be emitted, a collection of conditions that can more precisely qualify an instance or instances of this activity, an optional key name with which the user data must be associated, whether derived types of the user data should be matched, and whether user data emitted from activities derived from the type of the specified activity should be matched.

NoteNote

A single UserTrackingLocation may refer to more than one actual location in the potential execution path of a workflow instance.

You may add a UserTrackingLocation to either UserTrackPoint.MatchingLocations or UserTrackPoint.ExcludedLocations in order to define the match parameters for a UserTrackPoint in a TrackingProfile.

There are three general conditions which must be met in the following order for the UserTrackingLocation to be matched by the runtime tracking infrastructure: the activity that has emitted a user event must match the set of activities specified by ActivityType, ActivityTypeName, Conditions, and MatchDerivedActivityTypes; the key, if one exists, associated with the user data must match KeyName; and, the type of the user data emitted by the user event must match the set of user data types specified by ArgumentType, ArgumentTypeName, and MatchDerivedArgumentTypes. Only if all three of these conditions are met, does the runtime tracking infrastructure consider the UserTrackingLocation matched.

To configure a UserTrackingLocation, you must set either ArgumentTypeName or ArgumentType to specify the type of the user data to be matched and either ActivityTypeName or ActivityType to specify the type of the activity from which the user data must be emitted to be matched. You may add ActivityTrackingCondition objects to Conditions to more completely qualify the activity from which the user data must be emitted. You may set MatchDerivedArgumentTypes to specify that user data derived from the user data type specified by ArgumentTypeName or ArgumentType should be matched, and you may set MatchDerivedActivityTypes to specify that user data emitted from activities derived from the activity type specified by ActivityTypeName or ActivityType should be matched.

You may set KeyName to specify that only user data associated with the specified key name should be matched for this UserTrackingLocation. If KeyName is a null reference (Nothing in Visual Basic), the runtime tracking structure will not try to match the key associated with the user data.

.NET Framework

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

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.
Show:
© 2014 Microsoft