UI Automation Support for the Calendar Control Type

This topic provides information about UI Automation support for the Calendar control type. In UI Automation, a control type is a set of conditions that a control must meet in order to use the ControlTypeProperty property. The conditions include specific guidelines for UI Automation tree structure, UI Automation property values, control patterns, and UI Automation events.

Calendar controls allow a user to easily determine the date and select other dates.

The following sections define the required UI Automation tree structure, properties, control patterns, and events for the Calendar control type. The UI Automation requirements apply to all calendar controls, whether Windows Presentation Foundation (WPF), Win32, or Windows Forms.

This topic contains the following sections.

• Required UI Automation Tree Structure
• Required UI Automation Properties
• Required UI Automation Control Patterns
• Required UI Automation Events
• Related Topics

Required UI Automation Tree Structure

The following table depicts the control view and the content view of the UI Automation tree that pertains to calendar controls and describes what can be contained in each view. For more information on the UI Automation tree, see UI Automation Tree Overview.

Control View	Content View
Calendar Data Grid Header (child of Data Grid) Header Item (child of Header; quantity depends on how many days are displayed) List Item (child of Header; quantity depends on how many days are displayed) Button (child of Data Grid; 0 or 2)	Calendar List Item (quantity depends on how many days are displayed)

Calendar controls can be represented in many different forms within the user interface. The only guaranteed controls to be in the control view of the UI Automation tree are the data grid, header, header item, and list item controls.

Required UI Automation Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to the calendar controls. For more information on UI Automation properties, see UI Automation Properties for Clients.

---

UI Automation Property	Value	Notes
AutomationIdProperty	See notes.	The value of this property needs to be unique across all controls in an application.
BoundingRectangleProperty	See notes.	The outermost rectangle that contains the whole control.
ClickablePointProperty	See notes.	Supported if there is a bounding rectangle. If not every point within the bounding rectangle is clickable, and you perform specialized hit testing, then override and provide a clickable point.
ControlTypeProperty	Calendar	This value is the same for all UI frameworks.
IsContentElementProperty	True	The calendar control is always included in the content view of the UI Automation tree.
IsControlElementProperty	True	The calendar control is always included in the control view of the UI Automation tree.
IsKeyboardFocusableProperty	See notes.	If the control can receive keyboard focus, it must support this property.
LabeledByProperty	See notes.	If there is a static text label, then this property must expose a reference to that control.
LocalizedControlTypeProperty	"calendar"	Localized string corresponding to the Calendar control type.
NameProperty	See notes.	The calendar control typically gets its name from the current day’s date.

Required UI Automation Control Patterns

The following table lists the UI Automation control patterns required to be supported by all calendar controls. For more information on control patterns, see UI Automation Control Patterns Overview.

Control Pattern/Pattern Property	Support/Value	Notes
IGridProvider	Yes	The calendar control always supports the Grid pattern because the days within a month are items that can be navigated spatially.
IScrollProvider	Depends	The ability to scroll the calendar depends on whether it allows navigation to other months without changing the state of the control.
ISelectionProvider	Yes	All calendar controls contain items representing days of the week that are selectable. Some calendars are multi-selectable and other only single-selectable.
ITableProvider	Yes	The calendar control always has a header within its subtree for the days of the week, so the Table pattern must be supported.
IValueProvider	No	The Value pattern is not necessary for calendar controls because you cannot set the value directly on the control. All of the information is provided by the Selection pattern.

Required UI Automation Events

The following table lists the UI Automation events required to be supported by all calendar controls. For more information about events, see UI Automation Events Overview.

---

UI Automation Event	Support/Value	Notes
AutomationFocusChangedEvent	Required	None
BoundingRectangleProperty property-changed event.	Required	None
IsEnabledProperty property-changed event.	Required	None
IsOffscreenProperty property-changed event.	Required	None
LayoutInvalidatedEvent	Required	None
StructureChangedEvent	Required	None
CurrentViewProperty property-changed event.	Depends	None
HorizontallyScrollableProperty property-changed event.	Depends	If the control supports the Scroll control pattern, it must support this event.
HorizontalScrollPercentProperty property-changed event.	Depends	If the control supports the Scroll control pattern, it must support this event.
HorizontalViewSizeProperty property-changed event.	Depends	If the control supports the Scroll control pattern, it must support this event.
VerticalScrollPercentProperty property-changed event.	Depends	If the control supports the Scroll control pattern, it must support this event.
VerticallyScrollableProperty property-changed event.	Depends	If the control supports the Scroll control pattern, it must support this event.
VerticalViewSizeProperty property-changed event.	Depends	If the control supports the Scroll control pattern, it must support this event.
InvalidatedEvent	Required	None

See Also

Reference

Calendar

Concepts

UI Automation Control Types Overview
UI Automation Overview