-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
SetStateActivity.xml
232 lines (214 loc) · 15.8 KB
/
SetStateActivity.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
<Type Name="SetStateActivity" FullName="System.Workflow.Activities.SetStateActivity">
<TypeSignature Language="C#" Value="public sealed class SetStateActivity : System.Workflow.ComponentModel.Activity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SetStateActivity extends System.Workflow.ComponentModel.Activity" />
<TypeSignature Language="DocId" Value="T:System.Workflow.Activities.SetStateActivity" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SetStateActivity
Inherits Activity" />
<TypeSignature Language="F#" Value="type SetStateActivity = class
 inherit Activity" />
<TypeSignature Language="C++ CLI" Value="public ref class SetStateActivity sealed : System::Workflow::ComponentModel::Activity" />
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Workflow.ComponentModel.Activity</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Designer(typeof(System.Workflow.Activities.SetStateDesigner), typeof(System.ComponentModel.Design.IDesigner))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Designer(typeof(System.Workflow.Activities.SetStateDesigner), typeof(System.ComponentModel.Design.IDesigner))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.ToolboxItem(typeof(System.Workflow.ComponentModel.Design.ActivityToolboxItem))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.ToolboxItem(typeof(System.Workflow.ComponentModel.Design.ActivityToolboxItem))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Drawing.ToolboxBitmap(typeof(System.Workflow.Activities.SetStateActivity), "Resources.SetStateActivity.png")]</AttributeName>
<AttributeName Language="F#">[<System.Drawing.ToolboxBitmap(typeof(System.Workflow.Activities.SetStateActivity), "Resources.SetStateActivity.png")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(false)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.ComVisible(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.SetStateValidator))]</AttributeName>
<AttributeName Language="F#">[<System.Workflow.ComponentModel.Compiler.ActivityValidator(typeof(System.Workflow.Activities.SetStateValidator))>]</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>Provides the transition to a <see cref="T:System.Workflow.Activities.StateActivity" /> in a state machine workflow. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)]
The <xref:System.Workflow.Activities.SetStateActivity> can be used only in state machine workflows.
The <xref:System.Workflow.Activities.SetStateActivity> provides transitions only to leaf <xref:System.Workflow.Activities.StateActivity> activities (a <xref:System.Workflow.Activities.StateActivity> that does not contain other <xref:System.Workflow.Activities.StateActivity> activities).
The <xref:System.Workflow.Activities.SetStateActivity> only provides transitions between two <xref:System.Workflow.Activities.StateActivity> classes and does not support <xref:System.Workflow.Activities.StateActivity> to parent <xref:System.Workflow.Activities.StateActivity> transitions or any other combination.
The <xref:System.Workflow.Activities.SetStateActivity> has to be a leaf node within the activity tree of an event handler.
There can be more than one <xref:System.Workflow.Activities.SetStateActivity> but all the activities must be leaf nodes.
<xref:System.Workflow.Activities.SetStateActivity> is always the last activity in the run path of a <xref:System.Workflow.Activities.EventDrivenActivity> activity.
For more information, see the [Simple State Machine](https://msdn.microsoft.com/library/1974edbd-253d-4e01-9095-38ff9c3e749e) sample.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms734685(v=vs.90)">Using the SetState Activity</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Activities.SetStateActivity" /> class.</summary>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms734685(v=vs.90)">Using the SetState Activity</related>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SetStateActivity ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Activities.SetStateActivity.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SetStateActivity();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</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.Activities.SetStateActivity" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example shows how to create a new instance of the <xref:System.Workflow.Activities.SetStateActivity> class. This code example is part of the SimpleStateMachineWorkflow SDK Sample from the StateMachineWorkflow.cs file. For more information, see [Simple State Machine](https://msdn.microsoft.com/library/1974edbd-253d-4e01-9095-38ff9c3e749e).
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets38.cs" id="Snippet310":::
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms734685(v=vs.90)">Using the SetState Activity</related>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SetStateActivity (string name);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Activities.SetStateActivity.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String)" />
<MemberSignature Language="F#" Value="new System.Workflow.Activities.SetStateActivity : string -> System.Workflow.Activities.SetStateActivity" Usage="new System.Workflow.Activities.SetStateActivity name" />
<MemberSignature Language="C++ CLI" Value="public:
 SetStateActivity(System::String ^ name);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The user-defined name of the activity.</param>
<summary>Initializes a new instance of the <see cref="T:System.Workflow.Activities.SetStateActivity" /> class using the name of the activity.</summary>
<remarks>To be added.</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms734685(v=vs.90)">Using the SetState Activity</related>
</Docs>
</Member>
<Member MemberName="Execute">
<MemberSignature Language="C#" Value="protected override System.Workflow.ComponentModel.ActivityExecutionStatus Execute (System.Workflow.ComponentModel.ActivityExecutionContext executionContext);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance valuetype System.Workflow.ComponentModel.ActivityExecutionStatus Execute(class System.Workflow.ComponentModel.ActivityExecutionContext executionContext) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Workflow.Activities.SetStateActivity.Execute(System.Workflow.ComponentModel.ActivityExecutionContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function Execute (executionContext As ActivityExecutionContext) As ActivityExecutionStatus" />
<MemberSignature Language="F#" Value="override this.Execute : System.Workflow.ComponentModel.ActivityExecutionContext -> System.Workflow.ComponentModel.ActivityExecutionStatus" Usage="setStateActivity.Execute executionContext" />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Workflow::ComponentModel::ActivityExecutionStatus Execute(System::Workflow::ComponentModel::ActivityExecutionContext ^ executionContext);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Workflow.ComponentModel.ActivityExecutionStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="executionContext" Type="System.Workflow.ComponentModel.ActivityExecutionContext" />
</Parameters>
<Docs>
<param name="executionContext">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TargetStateName">
<MemberSignature Language="C#" Value="public string TargetStateName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TargetStateName" />
<MemberSignature Language="DocId" Value="P:System.Workflow.Activities.SetStateActivity.TargetStateName" />
<MemberSignature Language="VB.NET" Value="Public Property TargetStateName As String" />
<MemberSignature Language="F#" Value="member this.TargetStateName : string with get, set" Usage="System.Workflow.Activities.SetStateActivity.TargetStateName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ TargetStateName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Editor(typeof(System.Workflow.Activities.StateDropDownEditor), typeof(System.Drawing.Design.UITypeEditor))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Editor(typeof(System.Workflow.Activities.StateDropDownEditor), typeof(System.Drawing.Design.UITypeEditor))>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the name of the target state.</summary>
<value>The name of the target stream.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example shows how to create a new instance of the <xref:System.Workflow.Activities.SetStateActivity> class and use it implement a simple state machine to transition between 3 states, and set the value of the <xref:System.Workflow.Activities.SetStateActivity.TargetStateName%2A> property. This code example is part of the SimpleStateMachineWorkflow SDK Sample from the StateMachineWorkflow.cs file. For more information, see [Simple State Machine](https://msdn.microsoft.com/library/1974edbd-253d-4e01-9095-38ff9c3e749e).
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wf_samples/cs/snippets19.cs" id="Snippet183":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wf_samples/vb/snippets19.vb" id="Snippet183":::
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms734685(v=vs.90)">Using the SetState Activity</related>
</Docs>
</Member>
<Member MemberName="TargetStateNameProperty">
<MemberSignature Language="C#" Value="public static readonly System.Workflow.ComponentModel.DependencyProperty TargetStateNameProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Workflow.ComponentModel.DependencyProperty TargetStateNameProperty" />
<MemberSignature Language="DocId" Value="F:System.Workflow.Activities.SetStateActivity.TargetStateNameProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly TargetStateNameProperty As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable TargetStateNameProperty : System.Workflow.ComponentModel.DependencyProperty" Usage="System.Workflow.Activities.SetStateActivity.TargetStateNameProperty" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Workflow::ComponentModel::DependencyProperty ^ TargetStateNameProperty;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Workflow.Activities</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Workflow.ComponentModel.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Represents the <see cref="T:System.Workflow.ComponentModel.DependencyProperty" /> that targets the <see cref="P:System.Workflow.Activities.SetStateActivity.TargetStateName" /> property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
[!INCLUDE[DependencyPropertyRemark](~/includes/dependencypropertyremark-md.md)]
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms734685(v=vs.90)">Using the SetState Activity</related>
</Docs>
</Member>
</Members>
</Type>