-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ITransformProvider.xml
319 lines (288 loc) · 21 KB
/
ITransformProvider.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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<Type Name="ITransformProvider" FullName="System.Windows.Automation.Provider.ITransformProvider">
<TypeSignature Language="C#" Value="public interface ITransformProvider" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ITransformProvider" FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;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;windowsdesktop-3.0;windowsdesktop-3.1;windowsdesktop-5.0;windowsdesktop-6.0;windowsdesktop-7.0" />
<TypeSignature Language="DocId" Value="T:System.Windows.Automation.Provider.ITransformProvider" />
<TypeSignature Language="VB.NET" Value="Public Interface ITransformProvider" />
<TypeSignature Language="F#" Value="type ITransformProvider = interface" />
<TypeSignature Language="C++ CLI" Value="public interface class ITransformProvider" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ITransformProvider" FrameworkAlternate="windowsdesktop-8.0;windowsdesktop-9.0" />
<AssemblyInfo>
<AssemblyName>UIAutomationProvider</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>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;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.Runtime.InteropServices.ComVisible(true)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.ComVisible(true)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;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.Runtime.InteropServices.Guid("6829ddc4-4f91-4ffa-b86f-bd3e2987cb4c")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.Guid("6829ddc4-4f91-4ffa-b86f-bd3e2987cb4c")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;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.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Exposes methods and properties to support UI Automation client access to controls that can be moved, resized, or rotated within a two-dimensional space.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Implemented on a UI Automation provider that must support the <xref:System.Windows.Automation.TransformPattern> control pattern.
Support for this control pattern is not limited to objects on the desktop. This control pattern must also be implemented by the children of a container object as long as the children can be moved, resized, or rotated freely within the boundaries of the container.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Automation.TransformPattern" />
<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/server-side-ui-automation-provider-implementation">Server-side UI Automation Provider Implementation</related>
<related type="Article" href="/dotnet/framework/ui-automation/client-side-ui-automation-provider-implementation">Client-side UI Automation Provider Implementation</related>
<related type="Article" href="/dotnet/framework/ui-automation/support-control-patterns-in-a-ui-automation-provider">Support Control Patterns in a UI Automation Provider</related>
<related type="Article" href="/dotnet/framework/ui-automation/implementing-the-ui-automation-transform-control-pattern">Implementing the UI Automation Transform Control Pattern</related>
</Docs>
<Members>
<Member MemberName="CanMove">
<MemberSignature Language="C#" Value="public bool CanMove { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanMove" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.Provider.ITransformProvider.CanMove" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CanMove As Boolean" />
<MemberSignature Language="F#" Value="member this.CanMove : bool" Usage="System.Windows.Automation.Provider.ITransformProvider.CanMove" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool CanMove { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationProvider</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 control can be moved.</summary>
<value>
<see langword="true" /> if the element can be moved; otherwise <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows an implementation of this method for a control that can be moved.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/ITransformProvider/CanMove/TransformFragment.cs" id="Snippetcanmove":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAITransformProvider_snip/visualbasic/transformfragment.vb" id="Snippetcanmove":::
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/ui-automation/implementing-the-ui-automation-transform-control-pattern">Implementing the UI Automation Transform Control Pattern</related>
</Docs>
</Member>
<Member MemberName="CanResize">
<MemberSignature Language="C#" Value="public bool CanResize { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanResize" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.Provider.ITransformProvider.CanResize" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CanResize As Boolean" />
<MemberSignature Language="F#" Value="member this.CanResize : bool" Usage="System.Windows.Automation.Provider.ITransformProvider.CanResize" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool CanResize { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationProvider</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 UI Automation element can be resized.</summary>
<value>
<see langword="true" /> if the element can be resized; otherwise <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows an implementation of this method for a control that can be resized.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/ITransformProvider/CanMove/TransformFragment.cs" id="Snippetcanresize":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAITransformProvider_snip/visualbasic/transformfragment.vb" id="Snippetcanresize":::
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/ui-automation/implementing-the-ui-automation-transform-control-pattern">Implementing the UI Automation Transform Control Pattern</related>
</Docs>
</Member>
<Member MemberName="CanRotate">
<MemberSignature Language="C#" Value="public bool CanRotate { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanRotate" />
<MemberSignature Language="DocId" Value="P:System.Windows.Automation.Provider.ITransformProvider.CanRotate" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CanRotate As Boolean" />
<MemberSignature Language="F#" Value="member this.CanRotate : bool" Usage="System.Windows.Automation.Provider.ITransformProvider.CanRotate" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool CanRotate { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationProvider</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 control can be rotated.</summary>
<value>
<see langword="true" /> if the element can be rotated; otherwise <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example shows an implementation of this method for a control that cannot be rotated.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/ITransformProvider/CanMove/TransformFragment.cs" id="Snippetcanrotate":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAITransformProvider_snip/visualbasic/transformfragment.vb" id="Snippetcanrotate":::
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/ui-automation/implementing-the-ui-automation-transform-control-pattern">Implementing the UI Automation Transform Control Pattern</related>
</Docs>
</Member>
<Member MemberName="Move">
<MemberSignature Language="C#" Value="public void Move (double x, double y);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Move(float64 x, float64 y) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Automation.Provider.ITransformProvider.Move(System.Double,System.Double)" />
<MemberSignature Language="VB.NET" Value="Public Sub Move (x As Double, y As Double)" />
<MemberSignature Language="F#" Value="abstract member Move : double * double -> unit" Usage="iTransformProvider.Move (x, y)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Move(double x, double y);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationProvider</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>
<Parameter Name="x" Type="System.Double" />
<Parameter Name="y" Type="System.Double" />
</Parameters>
<Docs>
<param name="x">Absolute screen coordinates of the left side of the control.</param>
<param name="y">Absolute screen coordinates of the top of the control.</param>
<summary>Moves the control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An object cannot be moved, resized, or rotated such that its resulting screen location would be completely outside the coordinates of its container and inaccessible to keyboard or mouse. For example, when a top-level window is moved completely off-screen or a child object is moved outside the boundaries of the container's viewport. In these cases the object is placed as close to the requested screen coordinates as possible with the top or left coordinates overridden to be within the container boundaries.
## Examples
The following example shows one possible implementation of this method for a custom control that can be moved.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/ITransformProvider/CanMove/TransformFragment.cs" id="Snippetmove":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAITransformProvider_snip/visualbasic/transformfragment.vb" id="Snippetmove":::
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">If the <see cref="P:System.Windows.Automation.Provider.ITransformProvider.CanMove" /> property is false.</exception>
<related type="Article" href="/dotnet/framework/ui-automation/implementing-the-ui-automation-transform-control-pattern">Implementing the UI Automation Transform Control Pattern</related>
</Docs>
</Member>
<Member MemberName="Resize">
<MemberSignature Language="C#" Value="public void Resize (double width, double height);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Resize(float64 width, float64 height) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Automation.Provider.ITransformProvider.Resize(System.Double,System.Double)" />
<MemberSignature Language="VB.NET" Value="Public Sub Resize (width As Double, height As Double)" />
<MemberSignature Language="F#" Value="abstract member Resize : double * double -> unit" Usage="iTransformProvider.Resize (width, height)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Resize(double width, double height);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationProvider</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>
<Parameter Name="width" Type="System.Double" />
<Parameter Name="height" Type="System.Double" />
</Parameters>
<Docs>
<param name="width">The new width of the window, in pixels.</param>
<param name="height">The new height of the window, in pixels.</param>
<summary>Resizes the control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When called on a control that supports split panes, this method can have the side effect of resizing other contiguous panes.
An object cannot be moved, resized, or rotated such that its resulting screen location would be completely outside the coordinates of its container and inaccessible to keyboard or mouse. For example, when a top-level window is moved completely off-screen or a child object is moved outside the boundaries of the container's viewport. In these cases the object is placed as close to the requested screen coordinates as possible with the top or left coordinates overridden to be within the container boundaries.
## Examples
The following example shows one possible implementation of this method for a custom control that can be resized.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/ITransformProvider/CanMove/TransformFragment.cs" id="Snippetresize":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAITransformProvider_snip/visualbasic/transformfragment.vb" id="Snippetresize":::
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">If the <see cref="P:System.Windows.Automation.Provider.ITransformProvider.CanResize" /> property is false.</exception>
<related type="Article" href="/dotnet/framework/ui-automation/implementing-the-ui-automation-transform-control-pattern">Implementing the UI Automation Transform Control Pattern</related>
</Docs>
</Member>
<Member MemberName="Rotate">
<MemberSignature Language="C#" Value="public void Rotate (double degrees);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Rotate(float64 degrees) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Automation.Provider.ITransformProvider.Rotate(System.Double)" />
<MemberSignature Language="VB.NET" Value="Public Sub Rotate (degrees As Double)" />
<MemberSignature Language="F#" Value="abstract member Rotate : double -> unit" Usage="iTransformProvider.Rotate degrees" />
<MemberSignature Language="C++ CLI" Value="public:
 void Rotate(double degrees);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>UIAutomationProvider</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>
<Parameter Name="degrees" Type="System.Double" />
</Parameters>
<Docs>
<param name="degrees">The number of degrees to rotate the control. A positive number rotates clockwise; a negative number rotates counterclockwise.</param>
<summary>Rotates the control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An object cannot be moved, resized or rotated such that its resulting screen location would be completely outside the coordinates of its container and inaccessible to keyboard or mouse. For example, when a top-level window is moved completely off-screen or a child object is moved outside the boundaries of the container's viewport. In these cases the object is placed as close to the requested screen coordinates as possible with the top or left coordinates overridden to be within the container boundaries.
## Examples
The following example shows one possible implementation of this method for a custom control that cannot be rotated.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Automation.Provider/ITransformProvider/CanMove/TransformFragment.cs" id="Snippetrotate":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/UIAITransformProvider_snip/visualbasic/transformfragment.vb" id="Snippetrotate":::
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">If the <see cref="P:System.Windows.Automation.Provider.ITransformProvider.CanRotate" /> property is false.</exception>
<related type="Article" href="/dotnet/framework/ui-automation/implementing-the-ui-automation-transform-control-pattern">Implementing the UI Automation Transform Control Pattern</related>
</Docs>
</Member>
</Members>
</Type>