-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
SelectionPattern+SelectionPatternInformation.xml
159 lines (144 loc) · 10.4 KB
/
SelectionPattern+SelectionPatternInformation.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
<Type Name="SelectionPattern+SelectionPatternInformation" FullName="System.Windows.Automation.SelectionPattern+SelectionPatternInformation">
<TypeSignature Language="C#" Value="public struct SelectionPattern.SelectionPatternInformation" />
<TypeSignature Language="ILAsm" Value=".class nested public sequential ansi sealed beforefieldinit SelectionPattern/SelectionPatternInformation extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Windows.Automation.SelectionPattern.SelectionPatternInformation" />
<TypeSignature Language="VB.NET" Value="Public Structure SelectionPattern.SelectionPatternInformation" />
<TypeSignature Language="F#" Value="type SelectionPattern.SelectionPatternInformation = struct" />
<TypeSignature Language="C++ CLI" Value="public: value class SelectionPattern::SelectionPatternInformation" />
<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.SelectionPattern" /> object using its <see cref="P:System.Windows.Automation.SelectionPattern.Current" /> or <see cref="P:System.Windows.Automation.SelectionPattern.Cached" /> accessors.</summary>
<remarks>To be added.</remarks>
<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="CanSelectMultiple">
<MemberSignature Language="C#" Value="public bool CanSelectMultiple { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanSelectMultiple" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.SelectionPattern.SelectionPatternInformation.CanSelectMultiple" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CanSelectMultiple As Boolean" />
<MemberSignature Language="F#" Value="member this.CanSelectMultiple : bool" Usage="System.Windows.Automation.SelectionPattern.SelectionPatternInformation.CanSelectMultiple" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool CanSelectMultiple { bool 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.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that specifies whether the container allows more than one child element to be selected concurrently.</summary>
<value>
<see langword="true" /> if the control supports multiple selection; otherwise <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property can be dynamic For example, in rare cases, a control might allow multiple items to be selected on initialization, but subsequently allow only single selections to be made.
## Examples
In the following example, a <xref:System.Windows.Automation.SelectionPattern> control pattern is obtained from an <xref:System.Windows.Automation.AutomationElement> and subsequently used to retrieve property values.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet101":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet101":::
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet104":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet104":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetSelection">
<MemberSignature Language="C#" Value="public System.Windows.Automation.AutomationElement[] GetSelection ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Windows.Automation.AutomationElement[] GetSelection() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Automation.SelectionPattern.SelectionPatternInformation.GetSelection" />
<MemberSignature Language="VB.NET" Value="Public Function GetSelection () As AutomationElement()" />
<MemberSignature Language="F#" Value="member this.GetSelection : unit -> System.Windows.Automation.AutomationElement[]" Usage="selectionPatternInformation.GetSelection " />
<MemberSignature Language="C++ CLI" Value="public:
 cli::array <System::Windows::Automation::AutomationElement ^> ^ GetSelection();" />
<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.Windows.Automation.AutomationElement[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Retrieves all items in the selection container that are selected.</summary>
<returns>The collection of selected items. The default is an empty array.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
In the following example, a collection of <xref:System.Windows.Automation.AutomationElement>s representing the selected items in a selection container is obtained.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet1025":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet1025":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsSelectionRequired">
<MemberSignature Language="C#" Value="public bool IsSelectionRequired { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsSelectionRequired" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.SelectionPattern.SelectionPatternInformation.IsSelectionRequired" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsSelectionRequired As Boolean" />
<MemberSignature Language="F#" Value="member this.IsSelectionRequired : bool" Usage="System.Windows.Automation.SelectionPattern.SelectionPatternInformation.IsSelectionRequired" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsSelectionRequired { bool 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.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that specifies whether the container requires at least one child item to be selected.</summary>
<value>
<see langword="true" /> if the control requires at least one item to be selected; otherwise <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property can be dynamic. For example, the initial state of a control might not have any items selected by default, indicating that <xref:System.Windows.Automation.Provider.ISelectionProvider.IsSelectionRequired%2A> is `false`. However, after an item is selected, the control must always have at least one item selected.
## Examples
In the following example, a <xref:System.Windows.Automation.SelectionPattern> control pattern is obtained from an <xref:System.Windows.Automation.AutomationElement> and subsequently used to retrieve property values.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet101":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet101":::
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation/SelectionPattern+SelectionPatternInformation/CanSelectMultiple/UIASelectionPattern_snippets.cs" id="Snippet104":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIASelectionPattern_snip/VisualBasic/UIASelectionPattern_snippets.vb" id="Snippet104":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>