UI Automation Support for the Calendar Control Type

 
System_CAPS_ICON_note.jpg 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 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.

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 ViewContent View
Calendar

 
  • DataGrid

     
    • Header (0 or 1)
    • HeaderItem (0 or 7; quantity depends on how many days are displayed in columns)
    • ListItem (quantity depends on how many days are displayed)
    • Button (0 or 2; for paging calendar view)
Calendar

- ListItem (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.

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 PropertyValueNotes
AutomationIdPropertySee notes.The value of this property needs to be unique across all controls in an application.
BoundingRectanglePropertySee notes.The outermost rectangle that contains the whole control.
ClickablePointPropertySee 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.
ControlTypePropertyCalendarThis value is the same for all UI frameworks.
IsContentElementPropertyTrueThe calendar control is always included in the content view of the UI Automation tree.
IsControlElementPropertyTrueThe calendar control is always included in the control view of the UI Automation tree.
IsKeyboardFocusablePropertySee notes.If the control can receive keyboard focus, it must support this property.
LabeledByPropertySee notes.The label of the document control. Typically, the title of the document is used.
LocalizedControlTypeProperty"calendar"Localized string corresponding to the Calendar control type.
NamePropertySee notes.The calendar control typically gets its name from the current day’s date.

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 PropertySupportNotes
IGridProviderYesThe calendar control always supports the Grid pattern because the days within a month are items that can be navigated spatially.
IScrollProviderDependsMost calendar controls support flipping the view by page. The Scroll pattern is recommended in order to support paging navigation.
ISelectionProviderDependsMost calendar controls retain a specific day, month, or year as a selection of the sub-element. Some calendars are multi-selectable and others only single-selectable.
ITableProviderYesThe calendar control always has a header within its subtree for the days of the week, so the Table pattern must be supported.
IValueProviderNoThe Value control pattern is not necessary for calendar controls because you 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.

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 EventSupportNotes
AutomationFocusChangedEventRequiredNone
BoundingRectangleProperty property-changed event.RequiredNone
IsEnabledProperty property-changed event.RequiredNone
IsOffscreenProperty property-changed event.RequiredNone
LayoutInvalidatedEventRequiredNone
StructureChangedEventRequiredNone
CurrentViewProperty property-changed event.DependsNone
HorizontallyScrollableProperty property-changed event.DependsIf the control supports the Scroll control pattern, it must support this event.
HorizontalScrollPercentProperty property-changed event.DependsIf the control supports the Scroll control pattern, it must support this event.
HorizontalViewSizeProperty property-changed event.DependsIf the control supports the Scroll control pattern, it must support this event.
VerticalScrollPercentProperty property-changed event.DependsIf the control supports the Scroll control pattern, it must support this event.
VerticallyScrollableProperty property-changed event.DependsIf the control supports the Scroll control pattern, it must support this event.
VerticalViewSizeProperty property-changed event.DependsIf the control supports the Scroll control pattern, it must support this event.
InvalidatedEventRequiredNone

Calendar
UI Automation Control Types Overview
UI Automation Overview

Show: