Calendar Control Type
This topic provides information about Microsoft UI Automation support for the Calendar control type. A calendar control allows the 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 where the UI framework/platform integrates UI Automation support for control types and control patterns.
This topic contains the following sections.
Typical Tree Structure
The following table depicts a typical control and content view of the UI Automation tree that pertains to calendar controls and describes what can be contained in each view. For more information about the UI Automation tree, see UI Automation Tree Overview.
| Control View | Content View |
|---|---|
|
|
Calendar controls can be represented in many different forms within the user interface. The only controls guaranteed to be in the control view of the UI Automation tree are the data grid, header, header item, and list item controls.
Relevant Properties
The following table lists the UI Automation properties whose value or definition is especially relevant to the Calendar control type. For more information about UI Automation properties, see Retrieving Properties from UI Automation Elements.
| UI Automation Property | Value | Notes |
|---|---|---|
| UIA_AutomationIdPropertyId | See notes. | The value of this property must be unique among all peer elements in the raw view of the UI Automation tree. |
| UIA_BoundingRectanglePropertyId | See notes. | The outermost rectangle that contains the whole control. |
| UIA_ClickablePointPropertyId | See notes. | Supported if there is a bounding rectangle. If not every point within the bounding rectangle is clickable, and the element performs specialized hit testing, override and provide a clickable point. |
| UIA_ControlTypePropertyId | Calendar | This value is the same for all UI frameworks. |
| UIA_IsContentElementPropertyId | TRUE | The calendar control is always included in the content view of the UI Automation tree. |
| UIA_IsControlElementPropertyId | TRUE | The calendar control is always included in the control view of the UI Automation tree. |
| UIA_IsKeyboardFocusablePropertyId | See notes. | If the control can receive keyboard focus, it must support this property. |
| UIA_LabeledByPropertyId | See notes. | The value of this property should be the label of the document control. Typically, the title of the document is used. |
| UIA_LocalizedControlTypePropertyId | See notes. | Localized string corresponding to the Calendar control type. The default value is "calendar" for en-US or English (United States). |
| UIA_NamePropertyId | See notes. | The calendar control typically gets its name from the current date. |
Required 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 | Required | The calendar control always supports the Grid control pattern because the days within a month are items that can be navigated spatially. |
| IScrollProvider | Depends | Most calendar controls support flipping the view by page. The Scroll control pattern is recommended in order to support paging navigation. |
| ISelectionProvider | Depends | Most of calendar controls retain a specific day, month, or year as a selection of the subelement. Some calendars are multi-selectable and other only single-selectable. Calendar control with selectable subelements should support the Selection control pattern. |
| ITableProvider | Required | Because the calendar control always has a header within its subtree for the days of the week, the Table control pattern must be supported. |
| IValueProvider | No | The Value control pattern is not necessary for calendar controls because the element cannot set the value directly on the control. If a specific date is associated with the control, the information should be provided by the Selection control pattern. |
Required Events
The following table lists the UI Automation events that calendar controls are required to support. For more information on events, see UI Automation Events Overview.
| UI Automation Event | Notes |
|---|---|
| UIA_AutomationFocusChangedEventId | |
| UIA_BoundingRectanglePropertyId property-changed event. | |
| UIA_IsEnabledPropertyId property-changed event. | If the control supports the IsEnabled property, it must support this event. |
| UIA_IsOffscreenPropertyId property-changed event. | If the control supports the IsOffscreen property, it must support this event. |
| UIA_LayoutInvalidatedEventId | |
| UIA_MultipleViewCurrentViewPropertyId property-changed event. | If the control supports the CurrentView property of the MultipleView control pattern, it must support this event. |
| UIA_StructureChangedEventId | |
| UIA_ScrollHorizontallyScrollablePropertyId property-changed event. | If the control supports the Scroll control pattern, it must support this event. |
| UIA_ScrollHorizontalScrollPercentPropertyId property-changed event. | If the control supports the Scroll control pattern, it must support this event. |
| UIA_ScrollHorizontalViewSizePropertyId property-changed event. | If the control supports the Scroll control pattern, it must support this event. |
| UIA_ScrollVerticalScrollPercentPropertyId property-changed event. | If the control supports the Scroll control pattern, it must support this event. |
| UIA_ScrollVerticallyScrollablePropertyId property-changed event. | If the control supports the Scroll control pattern, it must support this event. |
| UIA_ScrollVerticalViewSizePropertyId property-changed event. | If the control supports the Scroll control pattern, it must support this event. |
| UIA_Selection_InvalidatedEventId |
Related topics