/
WorkflowDataTrackingExtract.xml
172 lines (158 loc) · 12.4 KB
/
WorkflowDataTrackingExtract.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<Type Name="WorkflowDataTrackingExtract" FullName="System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract">
<TypeSignature Language="C#" Value="public class WorkflowDataTrackingExtract : System.Workflow.Runtime.Tracking.TrackingExtract" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit WorkflowDataTrackingExtract extends System.Workflow.Runtime.Tracking.TrackingExtract" />
<TypeSignature Language="DocId" Value="T:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract" />
<TypeSignature Language="VB.NET" Value="Public Class WorkflowDataTrackingExtract
Inherits TrackingExtract" />
<TypeSignature Language="F#" Value="type WorkflowDataTrackingExtract = class
 inherit TrackingExtract" />
<TypeSignature Language="C++ CLI" Value="public ref class WorkflowDataTrackingExtract : System::Workflow::Runtime::Tracking::TrackingExtract" />
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Workflow.Runtime.Tracking.TrackingExtract</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Serializable]</AttributeName>
<AttributeName Language="F#">[<System.Serializable>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Specifies a property or a field to be extracted from the root activity of the workflow and sent to the tracking service together with and an associated collection of annotations when a track point is matched.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
A <xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract> specifies a property or a field to be extracted from the root activity of a workflow. You can add a <xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract> to either <xref:System.Workflow.Runtime.Tracking.UserTrackPoint.Extracts%2A?displayProperty=nameWithType> or <xref:System.Workflow.Runtime.Tracking.ActivityTrackPoint.Extracts%2A?displayProperty=nameWithType> to instruct the runtime tracking infrastructure to extract the member from the root activity of the workflow when the runtime tracking infrastructure matches an <xref:System.Workflow.Runtime.Tracking.ActivityTrackPoint> or a <xref:System.Workflow.Runtime.Tracking.UserTrackPoint>. The runtime tracking infrastructure puts the extracted data and any associated annotations in the <xref:System.Workflow.Runtime.Tracking.ActivityTrackingRecord> or the <xref:System.Workflow.Runtime.Tracking.UserTrackingRecord> that it returns to the tracking service.
Set <xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Member%2A> to specify the field or property for the runtime tracking infrastructure to extract from the root activity. You can associate additional information with the extracted data by adding to <xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Annotations%2A>.
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WorkflowDataTrackingExtract ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 WorkflowDataTrackingExtract();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If you use the parameterless constructor you must explicitly set <xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Member%2A> to a value different from a null reference (`Nothing` in Visual Basic) in your code.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WorkflowDataTrackingExtract (string member);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string member) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (member As String)" />
<MemberSignature Language="F#" Value="new System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract : string -> System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract" Usage="new System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract member" />
<MemberSignature Language="C++ CLI" Value="public:
 WorkflowDataTrackingExtract(System::String ^ member);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="member" Type="System.String" />
</Parameters>
<Docs>
<param name="member">The dot delineated name of the field or property of the root activity that should be extracted and sent to the tracking service.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract" /> class by using the specified name of a member of the root activity.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Member%2A?displayProperty=nameWithType> is initialized to the `string` specified by `member`.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="member" /> is a null reference (<see langword="Nothing" /> in Visual Basic).</exception>
</Docs>
</Member>
<Member MemberName="Annotations">
<MemberSignature Language="C#" Value="public override System.Workflow.Runtime.Tracking.TrackingAnnotationCollection Annotations { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Workflow.Runtime.Tracking.TrackingAnnotationCollection Annotations" />
<MemberSignature Language="DocId" Value="P:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Annotations" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Annotations As TrackingAnnotationCollection" />
<MemberSignature Language="F#" Value="member this.Annotations : System.Workflow.Runtime.Tracking.TrackingAnnotationCollection" Usage="System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Annotations" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Workflow::Runtime::Tracking::TrackingAnnotationCollection ^ Annotations { System::Workflow::Runtime::Tracking::TrackingAnnotationCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Workflow.Runtime.Tracking.TrackingAnnotationCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the collection of annotations associated with the extracted data.</summary>
<value>The <see cref="T:System.Workflow.Runtime.Tracking.TrackingAnnotationCollection" /> associated with the activity property or field to be extracted. The default is an empty collection.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Annotations are `strings` that you define that contain information to associate with the extracted data. When a track point is matched, the runtime tracking infrastructure includes both the extracted data and the annotation collection in the tracking record that it sends to the tracking service. You can add to <xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Annotations%2A> to associate additional information with the extracted data.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Member">
<MemberSignature Language="C#" Value="public override string Member { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Member" />
<MemberSignature Language="DocId" Value="P:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Member" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property Member As String" />
<MemberSignature Language="F#" Value="member this.Member : string with get, set" Usage="System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Member" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ Member { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Runtime</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the field or the property to be extracted from the root activity when a track point is matched.</summary>
<value>A dot delineated name that specifies a field or a property of the root activity. The default is a null reference (<see langword="Nothing" /> in Visual Basic).</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Member%2A> can be set to specify a field or property of the root activity; a member of such a field or property; or a single element of a field or property (or a member of either) that implements the <xref:System.Collections.IEnumerable> interface. For example, if the root activity has a `string` property named "MyString" and you want the runtime tracking infrastructure to return its length, you can set <xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Member%2A> to "MyString.length". Alternatively, to return the second char in "MyString", you can set <xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Member%2A> to "MyString[1]".
> [!NOTE]
> <xref:System.Workflow.Runtime.Tracking.WorkflowDataTrackingExtract.Member%2A> must be the real name of a property on the activity type. This name may be different from what you see in the designer because the designer supports the ability to localize and map property names.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>