Implementing the UI Automation ScrollItem Control Pattern
Note
This documentation is intended for .NET Framework developers who want to use the managed UI Automation classes defined in the System.Windows.Automation namespace. For the latest information about UI Automation, see Windows Automation API: UI Automation.
This topic introduces guidelines and conventions for implementing the IScrollItemProvider, including information about properties, methods, and events. Links to additional references are listed at the end of the topic.
The ScrollItemPattern control pattern is used to support individual child controls of containers that implement IScrollProvider. This control pattern acts as a communication channel between a child control and its container to ensure that the container can change the currently visible content (or region) within its viewport to display the child control. For examples of controls that implement this control pattern, see Control Pattern Mapping for UI Automation Clients.
Implementation Guidelines and Conventions
When implementing the Scroll Item control pattern, note the following guidelines and conventions:
- Items contained within a Window or Canvas control are not required to implement the IScrollItemProvider interface. As an alternative, however, they must expose a valid location for the BoundingRectangleProperty. This will allow a UI Automation client application to use the ScrollPattern control pattern methods on the container to display the child item.
Required Members for IScrollItemProvider
The following method is required for implementing the IScrollProvider interface.
| Required members | Member type | Notes |
|---|---|---|
| ScrollIntoView | - Method | None |
This control pattern has no associated properties or events.
Exceptions
Providers must throw the following exceptions.
| Exception Type | Condition |
|---|---|
| InvalidOperationException | If an item cannot be scrolled into view: - ScrollIntoView |