IGridItemProvider interface

Applies to Windows and Windows Phone

Exposes methods and properties to support access by a Microsoft UI Automation client to individual child controls of containers that implement IGridProvider. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.GridItem.

Syntax


public interface IGridItemProvider

Attributes

[Version(0x06020000)]
[WebHostHidden()]

Members

The IGridItemProvider interface has these types of members:

Properties

The IGridItemProvider interface has these properties.

PropertyAccess typeDescription

Column

Read-onlyGets the ordinal number of the column that contains the cell or item.

ColumnSpan

Read-onlyGets the number of columns that are spanned by a cell or item.

ContainingGrid

Read-onlyGets a UI Automation provider that implements IGridProvider and that represents the container of the cell or item.

Row

Read-onlyGets the ordinal number of the row that contains the cell or item.

RowSpan

Read-onlyGets the number of rows spanned by a cell or item.

 

Remarks

This pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see GridItem Control Pattern.

IGridItemProvider isn't implemented by any existing Windows Runtime automation peers. Notably, IGridItemProvider doesn't exist for the elements contained in a Grid and using the Grid as a layout container, or for GridViewItem. 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++ APIs as they use to define control logic or other automation support.

Use GridItemPatternIdentifiers if you want to reference the IGridItemProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Provider
Windows::UI::Xaml::Automation::Provider [C++]

Metadata

Windows.winmd

See also

IGridProvider
GridItemPatternIdentifiers
IGridItemProvider (COM interface)
Custom automation peers
GridItem Control Pattern

 

 

Show:
© 2014 Microsoft