public interface IGridProvider extends IInitable
The IGridProvider interface exposes methods and properties to support UI Automation client access to controls that act as
containers for a collection of child elements. The children of this element must implement IGridItemProvider and be organized
in a two-dimensional logical coordinate system that can be traversed (that is, a UI Automation client can move to adjacent controls)
by using the keyboard.
Implemented on a UI Automation provider that must support the Grid control pattern.
IGridProvider does not enable active manipulation of a grid; ITransformProvider must be implemented for this.
Modifier and Type | Interface and Description |
---|---|
static class |
IGridProvider.GridProviderContext
context object for IGridProvider.
|
Modifier and Type | Method and Description |
---|---|
int |
get_ColumnCount()
Specifies the total number of columns in the grid.
|
int |
get_RowCount()
Specifies the total number of rows in the grid.
|
IUIAElement |
GetItem(int row,
int column)
Retrieves the Microsoft UI Automation provider for the specified cell.
|
initialize
int get_ColumnCount()
Hidden rows and columns, depending on the provider implementation, may be loaded in the logical tree and will therefore be reflected in the IGridProvider::RowCount and IGridProvider::ColumnCount properties. If the hidden rows and columns have not yet been loaded they will not be counted.
int get_RowCount()
Hidden rows and columns, depending on the provider implementation, may be loaded in the logical tree and will therefore be reflected in the IGridProvider::RowCount and IGridProvider::ColumnCount properties. If the hidden rows and columns have not yet been loaded they will not be counted.
IUIAElement GetItem(int row, int column)
Grid coordinates are zero-based with the upper left (or upper right cell depending on locale) having coordinates (0,0).
If a cell is empty a UI Automation provider must still be returned in order to support the ContainingGrid property for that cell. This is possible when the layout of child elements in the grid is similar to a ragged array.
Hidden rows and columns, depending on the provider implementation, may be loaded in the UI Automation tree and will therefore be reflected in the IGridProvider::RowCount and IGridProvider::ColumnCount properties. If the hidden rows and columns have not yet been loaded they should not be counted.
row
- The ordinal number of the row of interest.column
- The ordinal number of the column of interest.