Share via


IGridProvider::GetItem Method

Retrieves the UI Automation provider for the specified cell.

Syntax

HRESULT GetItem(      
    int row,
    int column,
    IRawElementProviderSimple **pRetVal
);

Parameters

  • row
    [in] The ordinal number of the row of interest.
  • column
    [in] The ordinal number of the column of interest.
  • pRetVal
    [out, retval] The address of a variable that receives a pointer to a UI Automation provider for the specified cell or a null reference (Nothing in Microsoft Visual Basic .NET) if the cell is empty.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

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 IGridItemProvider::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 Microsoft 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.

See Also

UI Automation Providers Overview