ClassRadCalendarAutomationPeer
This class is an implementation of the automation peer for the RadCalendar control. It enables UI Automation by exposing properties and patterns required for accessibility. This includes supporting multiple views, selection capabilities, and grid-like behavior for child elements. The class implements several automation provider interfaces such as IMultipleViewProvider, ISelectionProvider, ITableProvider, and IGridProvider to facilitate diverse automation functionalities including retrieving selected items, row and column counts, and navigation capabilities within the calendar control. In addition, it handles the management of view modes and localized control types, ensuring that appropriate names and values are provided for accessibility tools.
Definition
Namespace:Telerik.Windows.Automation.Peers
Assembly:Telerik.Windows.Controls.Input.dll
Syntax:
public class RadCalendarAutomationPeer : FrameworkElementAutomationPeer, IMultipleViewProvider, ISelectionProvider, ITableProvider, IGridProviderInheritance: objectRadCalendarAutomationPeer
Implements:
Constructors
RadCalendarAutomationPeer(RadCalendar)
Initializes a new instance of the RadCalendarAutomationPeer class.
Declaration
public RadCalendarAutomationPeer(RadCalendar owner)Parameters
owner
The owner.
Properties
CanSelectMultiple
Gets a value that specifies whether the UI Automation provider allows more than one child element to be selected concurrently.
Declaration
public bool CanSelectMultiple { get; }Property Value
true if multiple selection is allowed; otherwise false.
ColumnCount
Gets the total number of columns in a grid.
Declaration
public int ColumnCount { get; }Property Value
The total number of columns in a grid.
CurrentView
Gets the current control-specific view.
Declaration
public int CurrentView { get; }Property Value
The value for the current view of the UI Automation element.
IsSelectionRequired
Gets a value that specifies whether the UI Automation provider requires at least one child element to be selected.
Declaration
public bool IsSelectionRequired { get; }Property Value
true if selection is required; otherwise false.
RowCount
Gets the total number of rows in a grid.
Declaration
public int RowCount { get; }Property Value
The total number of rows in a grid.
RowOrColumnMajor
Retrieves the primary direction of traversal for the table.
Declaration
public RowOrColumnMajor RowOrColumnMajor { get; }Property Value
RowOrColumnMajor
The primary direction of traversal.
Methods
GetAutomationControlTypeCore()
Gets the control type for the UIElement that is associated with this . This method is called by .
Declaration
protected override AutomationControlType GetAutomationControlTypeCore()Returns
AutomationControlType
The enumeration value.
GetChildrenCore()
Gets the collection of child elements of the UIElement that is associated with this . This method is called by .
Declaration
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists")]
protected override List<AutomationPeer> GetChildrenCore()Returns
List<AutomationPeer>
A list of child AutomationPeer elements.
GetColumnHeaders()
Gets a collection of UI Automation providers that represents all the column headers in a table.
Declaration
public IRawElementProviderSimple[] GetColumnHeaders()Returns
IRawElementProviderSimple[]
A collection of UI Automation providers.
GetItem(int, int)
Retrieves the UI Automation provider for the specified cell.
GetLocalizedControlTypeCore()
When overridden in a derived class, is called by .
Declaration
protected override string GetLocalizedControlTypeCore()Returns
The type of the control.
GetNameCore()
Gets the text label of the that is associated with this . Called by .
Declaration
protected override string GetNameCore()Returns
The text label of the element that is associated with this automation peer.
GetPattern(PatternInterface)
Gets the control pattern for the UIElement that is associated with this .
Declaration
public override object GetPattern(PatternInterface patternInterface)Parameters
patternInterface
PatternInterface
A value from the enumeration.
Returns
An object that implements the
interface if patternInterface is ;
otherwise, null.
GetRowHeaders()
Retrieves a collection of UI Automation providers that represents all row headers in the table.
Declaration
public IRawElementProviderSimple[] GetRowHeaders()Returns
IRawElementProviderSimple[]
A collection of UI Automation providers.
GetSelection()
Retrieves a UI Automation provider for each child element that is selected.
Declaration
public IRawElementProviderSimple[] GetSelection()Returns
IRawElementProviderSimple[]
A collection of UI Automation providers.
GetSupportedViews()
Retrieves a collection of control-specific view identifiers.
Declaration
public int[] GetSupportedViews()Returns
int[]
A collection of values that identifies the views available for a UI Automation element.
GetViewName(int)
Retrieves the name of a control-specific view.
Declaration
public string GetViewName(int viewId)Parameters
viewId
The view identifier.
Returns
A localized name for the view.
Exceptions
viewId is not a member of the supported views collection.
SetCurrentView(int)
Sets the current control-specific view.
Declaration
public void SetCurrentView(int viewId)Parameters
viewId
A view identifier.
Exceptions
viewId is not a member of the supported views collection.