-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
AutomationElementMode.xml
101 lines (93 loc) · 5.72 KB
/
AutomationElementMode.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
<Type Name="AutomationElementMode" FullName="System.Windows.Automation.AutomationElementMode">
<TypeSignature Language="C#" Value="public enum AutomationElementMode" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed AutomationElementMode extends System.Enum" />
<TypeSignature Language="DocId" Value="T:System.Windows.Automation.AutomationElementMode" />
<TypeSignature Language="VB.NET" Value="Public Enum AutomationElementMode" />
<TypeSignature Language="F#" Value="type AutomationElementMode = " />
<TypeSignature Language="C++ CLI" Value="public enum class AutomationElementMode" />
<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.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Contains values that specify the type of reference to use when returning UI Automation elements. These values are used in the <see cref="P:System.Windows.Automation.CacheRequest.AutomationElementMode" /> property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Full is the default, and specifies that returned elements contain a full reference to the underlying user interface (UI). None specifies that the returned elements have no reference to the underlying UI, and contain only cached information.
Certain operations on elements, such as <xref:System.Windows.Automation.AutomationElement.GetCurrentPropertyValue%2A> or <xref:System.Windows.Automation.AutomationElement.SetFocus%2A>, require a full reference; attempting to perform these on an element that has none results in an <xref:System.InvalidOperationException>.
Using None can be more efficient when only properties are needed, as it avoids the overhead involved in setting up full references.
## Examples
The following example shows how to set the mode on a <xref:System.Windows.Automation.CacheRequest>.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/AndCondition/.ctor/ClientForm.cs" id="Snippet183":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAClient_snip/VisualBasic/ClientForm.vb" id="Snippet183":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.Automation.CacheRequest" />
<related type="Article" href="/dotnet/framework/ui-automation/caching-in-ui-automation-clients">UI Automation Caching Overview</related>
<related type="Article" href="/dotnet/framework/ui-automation/use-caching-in-ui-automation">Use Caching in UI Automation</related>
</Docs>
<Members>
<Member MemberName="Full">
<MemberSignature Language="C#" Value="Full" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Automation.AutomationElementMode Full = int32(1)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Automation.AutomationElementMode.Full" />
<MemberSignature Language="VB.NET" Value="Full" />
<MemberSignature Language="F#" Value="Full = 1" Usage="System.Windows.Automation.AutomationElementMode.Full" />
<MemberSignature Language="C++ CLI" Value="Full" />
<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.AutomationElementMode</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Specifies that returned elements have a full reference to the underlying UI.</summary>
</Docs>
</Member>
<Member MemberName="None">
<MemberSignature Language="C#" Value="None" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Automation.AutomationElementMode None = int32(0)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Automation.AutomationElementMode.None" />
<MemberSignature Language="VB.NET" Value="None" />
<MemberSignature Language="F#" Value="None = 0" Usage="System.Windows.Automation.AutomationElementMode.None" />
<MemberSignature Language="C++ CLI" Value="None" />
<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.AutomationElementMode</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Specifies that returned elements have no reference to the underlying UI and contain only cached information. This mode might be used, for example, to retrieve the names of items in a list box without obtaining references to the items themselves.</summary>
</Docs>
</Member>
</Members>
</Type>