-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
WorkflowCreationContext.xml
251 lines (242 loc) · 18.3 KB
/
WorkflowCreationContext.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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<Type Name="WorkflowCreationContext" FullName="System.ServiceModel.Activities.WorkflowCreationContext">
<TypeSignature Language="C#" Value="public class WorkflowCreationContext" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WorkflowCreationContext extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.Activities.WorkflowCreationContext" />
<TypeSignature Language="VB.NET" Value="Public Class WorkflowCreationContext" />
<TypeSignature Language="F#" Value="type WorkflowCreationContext = class" />
<TypeSignature Language="C++ CLI" Value="public ref class WorkflowCreationContext" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.DataContract]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataContract>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a context that is set up during workflow activation using the workflow hosting endpoint to handle arguments, and receive workflow completion notifications.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WorkflowCreationContext ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Activities.WorkflowCreationContext.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 WorkflowCreationContext();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initiates a new instance of the <see cref="T:System.ServiceModel.Activities.WorkflowCreationContext" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateOnly">
<MemberSignature Language="C#" Value="public bool CreateOnly { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CreateOnly" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Activities.WorkflowCreationContext.CreateOnly" />
<MemberSignature Language="VB.NET" Value="Public Property CreateOnly As Boolean" />
<MemberSignature Language="F#" Value="member this.CreateOnly : bool with get, set" Usage="System.ServiceModel.Activities.WorkflowCreationContext.CreateOnly" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool CreateOnly { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.DataMember]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataMember>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates if the workflow instance should be suspended or run after creation.</summary>
<value>
<see langword="true" /> if the workflow instance is suspended after it is created ; <see langword="false" /> if the workflow is run after it is created.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsCompletionTransactionRequired">
<MemberSignature Language="C#" Value="public bool IsCompletionTransactionRequired { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsCompletionTransactionRequired" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Activities.WorkflowCreationContext.IsCompletionTransactionRequired" />
<MemberSignature Language="VB.NET" Value="Public Property IsCompletionTransactionRequired As Boolean" />
<MemberSignature Language="F#" Value="member this.IsCompletionTransactionRequired : bool with get, set" Usage="System.ServiceModel.Activities.WorkflowCreationContext.IsCompletionTransactionRequired" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsCompletionTransactionRequired { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.DataMember]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataMember>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the <see cref="M:System.ServiceModel.Activities.WorkflowCreationContext.OnBeginWorkflowCompleted(System.Activities.ActivityInstanceState,System.Collections.Generic.IDictionary{System.String,System.Object},System.Exception,System.TimeSpan,System.AsyncCallback,System.Object)" /> method is called in a transaction.</summary>
<value>
<see langword="true" /> if a completion transaction is required; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnAbort">
<MemberSignature Language="C#" Value="protected internal virtual void OnAbort ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance void OnAbort() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Activities.WorkflowCreationContext.OnAbort" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overridable Sub OnAbort ()" />
<MemberSignature Language="F#" Value="abstract member OnAbort : unit -> unit
override this.OnAbort : unit -> unit" Usage="workflowCreationContext.OnAbort " />
<MemberSignature Language="C++ CLI" Value="protected public:
 virtual void OnAbort();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Aborts the <see cref="T:System.ServiceModel.Activities.WorkflowCreationContext" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to implement the <xref:System.ServiceModel.Activities.WorkflowCreationContext.OnAbort%2A> method.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfcreationcontext/cs/program.cs" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginWorkflowCompleted">
<MemberSignature Language="C#" Value="protected internal virtual IAsyncResult OnBeginWorkflowCompleted (System.Activities.ActivityInstanceState completionState, System.Collections.Generic.IDictionary<string,object> workflowOutputs, Exception terminationException, TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance class System.IAsyncResult OnBeginWorkflowCompleted(valuetype System.Activities.ActivityInstanceState completionState, class System.Collections.Generic.IDictionary`2<string, object> workflowOutputs, class System.Exception terminationException, valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Activities.WorkflowCreationContext.OnBeginWorkflowCompleted(System.Activities.ActivityInstanceState,System.Collections.Generic.IDictionary{System.String,System.Object},System.Exception,System.TimeSpan,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overridable Function OnBeginWorkflowCompleted (completionState As ActivityInstanceState, workflowOutputs As IDictionary(Of String, Object), terminationException As Exception, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="abstract member OnBeginWorkflowCompleted : System.Activities.ActivityInstanceState * System.Collections.Generic.IDictionary<string, obj> * Exception * TimeSpan * AsyncCallback * obj -> IAsyncResult
override this.OnBeginWorkflowCompleted : System.Activities.ActivityInstanceState * System.Collections.Generic.IDictionary<string, obj> * Exception * TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="workflowCreationContext.OnBeginWorkflowCompleted (completionState, workflowOutputs, terminationException, timeout, callback, state)" />
<MemberSignature Language="C++ CLI" Value="protected public:
 virtual IAsyncResult ^ OnBeginWorkflowCompleted(System::Activities::ActivityInstanceState completionState, System::Collections::Generic::IDictionary<System::String ^, System::Object ^> ^ workflowOutputs, Exception ^ terminationException, TimeSpan timeout, AsyncCallback ^ callback, System::Object ^ state);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="completionState" Type="System.Activities.ActivityInstanceState" />
<Parameter Name="workflowOutputs" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
<Parameter Name="terminationException" Type="System.Exception" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="completionState">The state of the workflow instance.</param>
<param name="workflowOutputs">A collection of key/value pairs that contain output generated by the workflow instance.</param>
<param name="terminationException">If present, an error that caused the workflow to terminate.</param>
<param name="timeout">The time interval during which the asynchronous operation must complete.</param>
<param name="callback">The location in an application to which control returns when the asynchronous operation completes.</param>
<param name="state">User-defined state.</param>
<summary>Begins an asynchronous operation to perform workflow instance completion notification. This method is called when the workflow instance associated with this <see cref="T:System.ServiceModel.Activities.WorkflowCreationContext" /> completes. Derived classes can override this operation to perform custom actions on workflow instance completion.</summary>
<returns>The status of the asynchronous operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows how to implement the <xref:System.ServiceModel.Activities.WorkflowCreationContext.OnBeginWorkflowCompleted%2A> method.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfcreationcontext/cs/program.cs" id="Snippet0":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="OnEndWorkflowCompleted">
<MemberSignature Language="C#" Value="protected internal virtual void OnEndWorkflowCompleted (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance void OnEndWorkflowCompleted(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Activities.WorkflowCreationContext.OnEndWorkflowCompleted(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overridable Sub OnEndWorkflowCompleted (result As IAsyncResult)" />
<MemberSignature Language="F#" Value="abstract member OnEndWorkflowCompleted : IAsyncResult -> unit
override this.OnEndWorkflowCompleted : IAsyncResult -> unit" Usage="workflowCreationContext.OnEndWorkflowCompleted result" />
<MemberSignature Language="C++ CLI" Value="protected public:
 virtual void OnEndWorkflowCompleted(IAsyncResult ^ result);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">The status of the asynchronous operation.</param>
<summary>Completes an asynchronous operation that notifies workflow instance completion associated with this <see cref="T:System.ServiceModel.Activities.WorkflowCreationContext" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows a simple implementation of the <xref:System.ServiceModel.Activities.WorkflowCreationContext.OnEndWorkflowCompleted%2A> method. Notice that the base class <xref:System.ServiceModel.Activities.WorkflowCreationContext.OnAbort%2A> method is called.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfcreationcontext/cs/program.cs" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="WorkflowArguments">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,object> WorkflowArguments { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, object> WorkflowArguments" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Activities.WorkflowCreationContext.WorkflowArguments" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property WorkflowArguments As IDictionary(Of String, Object)" />
<MemberSignature Language="F#" Value="member this.WorkflowArguments : System.Collections.Generic.IDictionary<string, obj>" Usage="System.ServiceModel.Activities.WorkflowCreationContext.WorkflowArguments" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IDictionary<System::String ^, System::Object ^> ^ WorkflowArguments { System::Collections::Generic::IDictionary<System::String ^, System::Object ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the arguments passed to the newly created workflow instance.</summary>
<value>A dictionary of key/value pair arguments to the workflow instance.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>