-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
TogglePattern.xml
234 lines (208 loc) · 15 KB
/
TogglePattern.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
<Type Name="TogglePattern" FullName="System.Windows.Automation.TogglePattern">
<TypeSignature Language="C#" Value="public class TogglePattern : System.Windows.Automation.BasePattern" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TogglePattern extends System.Windows.Automation.BasePattern" />
<TypeSignature Language="DocId" Value="T:System.Windows.Automation.TogglePattern" />
<TypeSignature Language="VB.NET" Value="Public Class TogglePattern
Inherits BasePattern" />
<TypeSignature Language="F#" Value="type TogglePattern = class
 inherit BasePattern" />
<TypeSignature Language="C++ CLI" Value="public ref class TogglePattern : System::Windows::Automation::BasePattern" />
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Automation.BasePattern</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a control that can cycle through a set of states and maintain a state once set.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Automation.Provider.IToggleProvider" />
<related type="Article" href="/dotnet/framework/ui-automation/ui-automation-control-patterns-overview">UI Automation Control Patterns Overview</related>
<related type="Article" href="/dotnet/framework/ui-automation/ui-automation-control-patterns-for-clients">UI Automation Control Patterns for Clients</related>
</Docs>
<Members>
<Member MemberName="Cached">
<MemberSignature Language="C#" Value="public System.Windows.Automation.TogglePattern.TogglePatternInformation Cached { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Automation.TogglePattern/TogglePatternInformation Cached" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.TogglePattern.Cached" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Cached As TogglePattern.TogglePatternInformation" />
<MemberSignature Language="F#" Value="member this.Cached : System.Windows.Automation.TogglePattern.TogglePatternInformation" Usage="System.Windows.Automation.TogglePattern.Cached" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Automation::TogglePattern::TogglePatternInformation Cached { System::Windows::Automation::TogglePattern::TogglePatternInformation get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Automation.TogglePattern+TogglePatternInformation</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the cached UI Automation property values for this <see cref="T:System.Windows.Automation.TogglePattern" />.</summary>
<value>A structure containing the cached UI Automation property values for the control pattern.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Cached property values must have been previously requested using a <xref:System.Windows.Automation.CacheRequest>. Use <xref:System.Windows.Automation.TogglePattern.Current%2A> to get the current value of a property.
For information on the properties available and their use, see <xref:System.Windows.Automation.TogglePattern.TogglePatternInformation>.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The requested property is not in the cache.</exception>
</Docs>
</Member>
<Member MemberName="Current">
<MemberSignature Language="C#" Value="public System.Windows.Automation.TogglePattern.TogglePatternInformation Current { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Automation.TogglePattern/TogglePatternInformation Current" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.TogglePattern.Current" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Current As TogglePattern.TogglePatternInformation" />
<MemberSignature Language="F#" Value="member this.Current : System.Windows.Automation.TogglePattern.TogglePatternInformation" Usage="System.Windows.Automation.TogglePattern.Current" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Automation::TogglePattern::TogglePatternInformation Current { System::Windows::Automation::TogglePattern::TogglePatternInformation get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Automation.TogglePattern+TogglePatternInformation</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current UI Automation property values for this <see cref="T:System.Windows.Automation.TogglePattern" />.</summary>
<value>A structure containing the current UI Automation property values for the control pattern.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This pattern must be from an <xref:System.Windows.Automation.AutomationElement> with an <xref:System.Windows.Automation.AutomationElementMode.Full> reference in order to get current values. If the <xref:System.Windows.Automation.AutomationElement> was obtained using <xref:System.Windows.Automation.AutomationElementMode.None>, it contains only cached data, and attempting to get the current value of any property raises an exception. Use <xref:System.Windows.Automation.TogglePattern.Cached%2A> to get the cached value of a property that was previously specified using a <xref:System.Windows.Automation.CacheRequest>.
For information on the properties available and their use, see <xref:System.Windows.Automation.TogglePattern.TogglePatternInformation>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Pattern">
<MemberSignature Language="C#" Value="public static readonly System.Windows.Automation.AutomationPattern Pattern;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.Automation.AutomationPattern Pattern" />
<MemberSignature Language="DocId" Value="F:System.Windows.Automation.TogglePattern.Pattern" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Pattern As AutomationPattern " />
<MemberSignature Language="F#" Value=" staticval mutable Pattern : System.Windows.Automation.AutomationPattern" Usage="System.Windows.Automation.TogglePattern.Pattern" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::Automation::AutomationPattern ^ Pattern;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Automation.AutomationPattern</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="T:System.Windows.Automation.TogglePattern" /> control pattern.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in <xref:System.Windows.Automation.TogglePatternIdentifiers>.
The pattern identifier is passed to methods such as <xref:System.Windows.Automation.AutomationElement.GetCurrentPattern%2A> to retrieve the control pattern of interest from the specified <xref:System.Windows.Automation.AutomationElement>.
## Examples
In the following example, a <xref:System.Windows.Automation.TogglePattern> control pattern is obtained from an <xref:System.Windows.Automation.AutomationElement>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TogglePattern+TogglePatternInformation/ToggleState/UIATogglePattern_snippets.cs" id="Snippet101":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet101":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Toggle">
<MemberSignature Language="C#" Value="public void Toggle ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Toggle() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Automation.TogglePattern.Toggle" />
<MemberSignature Language="VB.NET" Value="Public Sub Toggle ()" />
<MemberSignature Language="F#" Value="member this.Toggle : unit -> unit" Usage="togglePattern.Toggle " />
<MemberSignature Language="C++ CLI" Value="public:
 void Toggle();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Cycles through the toggle states of an <see cref="T:System.Windows.Automation.AutomationElement" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A control will cycle through its <xref:System.Windows.Automation.ToggleState> in this order: <xref:System.Windows.Automation.ToggleState.On>, <xref:System.Windows.Automation.ToggleState.Off> and, if supported, <xref:System.Windows.Automation.ToggleState.Indeterminate>.
## Examples
In the following example, a <xref:System.Windows.Automation.TogglePattern> control pattern is obtained from an <xref:System.Windows.Automation.AutomationElement> and is subsequently used to toggle the <xref:System.Windows.Automation.AutomationElement>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TogglePattern+TogglePatternInformation/ToggleState/UIATogglePattern_snippets.cs" id="Snippet101":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet101":::
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TogglePattern+TogglePatternInformation/ToggleState/UIATogglePattern_snippets.cs" id="Snippet102":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet102":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToggleStateProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.Automation.AutomationProperty ToggleStateProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.Automation.AutomationProperty ToggleStateProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Automation.TogglePattern.ToggleStateProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly ToggleStateProperty As AutomationProperty " />
<MemberSignature Language="F#" Value=" staticval mutable ToggleStateProperty : System.Windows.Automation.AutomationProperty" Usage="System.Windows.Automation.TogglePattern.ToggleStateProperty" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::Automation::AutomationProperty ^ ToggleStateProperty;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationClient</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Automation.AutomationProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Automation.TogglePattern.TogglePatternInformation.ToggleState" /> property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in <xref:System.Windows.Automation.TogglePatternIdentifiers>.
An <xref:System.Windows.Automation.AutomationElement> must cycle through its <xref:System.Windows.Automation.ToggleState> in this order: <xref:System.Windows.Automation.ToggleState.On>, <xref:System.Windows.Automation.ToggleState.Off> and, if supported, <xref:System.Windows.Automation.ToggleState.Indeterminate>.
## Examples
In the following example, a root element is passed to a function that returns a collection of automation elements that are descendants of the root and satisfy a set of property conditions.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/TogglePattern+TogglePatternInformation/ToggleState/UIATogglePattern_snippets.cs" id="Snippet100":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIATogglePattern_snip/VisualBasic/UIATogglePattern_snippets.vb" id="Snippet100":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>