-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Handle.xml
183 lines (177 loc) · 11.1 KB
/
Handle.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
<Type Name="Handle" FullName="System.Activities.Handle">
<TypeSignature Language="C#" Value="public abstract class Handle" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Handle extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Activities.Handle" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Handle" />
<TypeSignature Language="F#" Value="type Handle = class" />
<TypeSignature Language="C++ CLI" Value="public ref class Handle abstract" />
<AssemblyInfo>
<AssemblyName>System.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 type that has its lifetime controlled by the workflow runtime.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Types derived from <xref:System.Activities.Handle> have their lifetimes controlled by the workflow runtime. For workflow variables of handle types, the runtime uses the required parameterless constructor to create an instance of the type, assigns it to the <xref:System.Activities.Variable>, and calls <xref:System.Activities.Handle.OnInitialize%2A> when initializing the environment. When the variable goes out of scope, <xref:System.Activities.Handle.OnUninitialize%2A> is called.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Handle ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Handle.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 Handle();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Activities.Handle" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Classes that derive from <xref:System.Activities.Handle> must provide a parameterless constructor.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ExecutionPropertyName">
<MemberSignature Language="C#" Value="public string ExecutionPropertyName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ExecutionPropertyName" />
<MemberSignature Language="DocId" Value="P:System.Activities.Handle.ExecutionPropertyName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExecutionPropertyName As String" />
<MemberSignature Language="F#" Value="member this.ExecutionPropertyName : string" Usage="System.Activities.Handle.ExecutionPropertyName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ExecutionPropertyName { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name to be used by this <see cref="T:System.Activities.Handle" /> when added to an activity's execution properties.</summary>
<value>The name of derived type as provided by <see cref="P:System.Type.FullName" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnInitialize">
<MemberSignature Language="C#" Value="protected virtual void OnInitialize (System.Activities.HandleInitializationContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnInitialize(class System.Activities.HandleInitializationContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Handle.OnInitialize(System.Activities.HandleInitializationContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub OnInitialize (context As HandleInitializationContext)" />
<MemberSignature Language="F#" Value="abstract member OnInitialize : System.Activities.HandleInitializationContext -> unit
override this.OnInitialize : System.Activities.HandleInitializationContext -> unit" Usage="handle.OnInitialize context" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void OnInitialize(System::Activities::HandleInitializationContext ^ context);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Activities.HandleInitializationContext" />
</Parameters>
<Docs>
<param name="context">The environment in which the handle is being created.</param>
<summary>Called by the workflow runtime when the environment that contains the <see cref="T:System.Activities.Handle" /> is initialized.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnUninitialize">
<MemberSignature Language="C#" Value="protected virtual void OnUninitialize (System.Activities.HandleInitializationContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnUninitialize(class System.Activities.HandleInitializationContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Handle.OnUninitialize(System.Activities.HandleInitializationContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub OnUninitialize (context As HandleInitializationContext)" />
<MemberSignature Language="F#" Value="abstract member OnUninitialize : System.Activities.HandleInitializationContext -> unit
override this.OnUninitialize : System.Activities.HandleInitializationContext -> unit" Usage="handle.OnUninitialize context" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void OnUninitialize(System::Activities::HandleInitializationContext ^ context);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Activities.HandleInitializationContext" />
</Parameters>
<Docs>
<param name="context">The environment in which the handle was created.</param>
<summary>Called by the workflow runtime when the <see cref="T:System.Activities.Variable" /> for the <see cref="T:System.Activities.Handle" /> goes out of scope.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Owner">
<MemberSignature Language="C#" Value="public System.Activities.ActivityInstance Owner { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Activities.ActivityInstance Owner" />
<MemberSignature Language="DocId" Value="P:System.Activities.Handle.Owner" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Owner As ActivityInstance" />
<MemberSignature Language="F#" Value="member this.Owner : System.Activities.ActivityInstance" Usage="System.Activities.Handle.Owner" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Activities::ActivityInstance ^ Owner { System::Activities::ActivityInstance ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<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>
</Attributes>
<ReturnValue>
<ReturnType>System.Activities.ActivityInstance</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Activities.ActivityInstance" /> that contains the <see cref="T:System.Activities.Variable" /> that contains the <see cref="T:System.Activities.Handle" />.</summary>
<value>The activity instance that contains the <see cref="T:System.Activities.Variable" /> that contains the <see cref="T:System.Activities.Handle" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ThrowIfUninitialized">
<MemberSignature Language="C#" Value="protected void ThrowIfUninitialized ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void ThrowIfUninitialized() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Handle.ThrowIfUninitialized" />
<MemberSignature Language="VB.NET" Value="Protected Sub ThrowIfUninitialized ()" />
<MemberSignature Language="F#" Value="member this.ThrowIfUninitialized : unit -> unit" Usage="handle.ThrowIfUninitialized " />
<MemberSignature Language="C++ CLI" Value="protected:
 void ThrowIfUninitialized();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Throws an <see cref="T:System.InvalidOperationException" /> if the <see cref="T:System.Activities.Handle" /> has not been initialized.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Activities.Handle.ThrowIfUninitialized%2A> gives custom handle derived class authors a convenient method to call from any methods or properties of the derived class that are not valid if the <xref:System.Activities.Handle> is uninitialized.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>