-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
TogglePattern+TogglePatternInformation.xml
74 lines (68 loc) · 5 KB
/
TogglePattern+TogglePatternInformation.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
<Type Name="TogglePattern+TogglePatternInformation" FullName="System.Windows.Automation.TogglePattern+TogglePatternInformation">
<TypeSignature Language="C#" Value="public struct TogglePattern.TogglePatternInformation" />
<TypeSignature Language="ILAsm" Value=".class nested public sequential ansi sealed beforefieldinit TogglePattern/TogglePatternInformation extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Windows.Automation.TogglePattern.TogglePatternInformation" />
<TypeSignature Language="VB.NET" Value="Public Structure TogglePattern.TogglePatternInformation" />
<TypeSignature Language="F#" Value="type TogglePattern.TogglePatternInformation = struct" />
<TypeSignature Language="C++ CLI" Value="public: value class TogglePattern::TogglePatternInformation" />
<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.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides access to the property values of a <see cref="T:System.Windows.Automation.TogglePattern" /> object using its <see cref="P:System.Windows.Automation.TogglePattern.Current" /> or <see cref="P:System.Windows.Automation.TogglePattern.Cached" /> accessors.</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>
<related type="Article" href="/dotnet/framework/ui-automation/use-caching-in-ui-automation">Use Caching in UI Automation</related>
</Docs>
<Members>
<Member MemberName="ToggleState">
<MemberSignature Language="C#" Value="public System.Windows.Automation.ToggleState ToggleState { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Automation.ToggleState ToggleState" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.TogglePattern.TogglePatternInformation.ToggleState" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ToggleState As ToggleState" />
<MemberSignature Language="F#" Value="member this.ToggleState : System.Windows.Automation.ToggleState" Usage="System.Windows.Automation.TogglePattern.TogglePatternInformation.ToggleState" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Automation::ToggleState ToggleState { System::Windows::Automation::ToggleState 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.ToggleState</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the toggle state of the <see cref="T:System.Windows.Automation.AutomationElement" />.</summary>
<value>The <see cref="T:System.Windows.Automation.ToggleState" /> of the <see cref="T:System.Windows.Automation.AutomationElement" />. The default value is <see cref="F:System.Windows.Automation.ToggleState.Indeterminate" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
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>