IGridProvider
IGridProvider
IGridProvider
IGridProvider
Interface
Definition
Exposes methods and properties to support access by a Microsoft UI Automation client to controls that act as containers for a collection of child elements. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Grid.
public : interface IGridProviderpublic interface IGridProviderPublic Interface IGridProvider// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
This pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see Grid Control Pattern.
IGridProvider isn't implemented by any existing Windows Runtime automation peers. Notably, IGridProvider doesn't exist for the Grid layout container, or for GridView. The interface exists so that custom control authors can support the automation pattern in a custom control, and implement their automation support using the same Windows Runtime managed or C++ API as they use to define control logic or other automation support.
Use GridPatternIdentifiers if you want to reference the IGridProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.
Properties
ColumnCount ColumnCount ColumnCount ColumnCount
Gets the total number of columns in a grid.
public : int ColumnCount { get; }public int ColumnCount { get; }Public ReadOnly Property ColumnCount As int// This API is not available in Javascript.
- Value
- int int int int
The total number of columns in a grid.
Methods
GetItem(Int32, Int32) GetItem(Int32, Int32) GetItem(Int32, Int32) GetItem(Int32, Int32)
Retrieves the UI Automation provider for the specified cell.
public : IRawElementProviderSimple GetItem(int row, int column)public IRawElementProviderSimple GetItem(Int32 row, Int32 column)Public Function GetItem(row As Int32, column As Int32) As IRawElementProviderSimple// This API is not available in Javascript.
- row
- int Int32 Int32 Int32
The ordinal number of the row that contains the cell.
- column
- int Int32 Int32 Int32
The ordinal number of the column that contains the cell.
The UI Automation provider for the specified cell.