New to Telerik UI for WPF? Start a free 30-day trial

RadCalendarAutomationPeer

Class

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, IGridProvider

Inheritance: objectRadCalendarAutomationPeer

Implements: IGridProviderIMultipleViewProviderISelectionProviderITableProvider

Constructors

RadCalendarAutomationPeer(RadCalendar)

Initializes a new instance of the RadCalendarAutomationPeer class.

public RadCalendarAutomationPeer(RadCalendar owner)

Parameters:ownerRadCalendar

The owner.

Properties

CanSelectMultiple

bool

Gets a value that specifies whether the UI Automation provider allows more than one child element to be selected concurrently.

public bool CanSelectMultiple { get; }

Property Value:

true if multiple selection is allowed; otherwise false.

ColumnCount

int

Gets the total number of columns in a grid.

public int ColumnCount { get; }

Property Value:

The total number of columns in a grid.

CurrentView

int

Gets the current control-specific view.

public int CurrentView { get; }

Property Value:

The value for the current view of the UI Automation element.

IsSelectionRequired

bool

Gets a value that specifies whether the UI Automation provider requires at least one child element to be selected.

public bool IsSelectionRequired { get; }

Property Value:

true if selection is required; otherwise false.

RowCount

int

Gets the total number of rows in a grid.

public int RowCount { get; }

Property Value:

The total number of rows in a grid.

RowOrColumnMajor

Retrieves the primary direction of traversal for the table.

public RowOrColumnMajor RowOrColumnMajor { get; }

Property Value:

The primary direction of traversal.

Methods

GetAutomationControlTypeCore()

Gets the control type for the UIElement that is associated with this . This method is called by .

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 .

protected override List<AutomationPeer> GetChildrenCore()

Returns:

List<AutomationPeer>

A list of child AutomationPeer elements.

GetClassNameCore()

protected override string GetClassNameCore()

Returns:

string

GetColumnHeaders()

Gets a collection of UI Automation providers that represents all the column headers in a table.

public IRawElementProviderSimple[] GetColumnHeaders()

Returns:

IRawElementProviderSimple[]

A collection of UI Automation providers.

GetHelpTextCore()

protected override string GetHelpTextCore()

Returns:

string

GetItem(int, int)

Retrieves the UI Automation provider for the specified cell.

public IRawElementProviderSimple GetItem(int row, int column)

Parameters:rowint

The ordinal number of the row of interest.

columnint

The ordinal number of the column of interest.

Returns:

IRawElementProviderSimple

The UI Automation provider for the specified cell.

GetItemStatusCore()

protected override string GetItemStatusCore()

Returns:

string

GetLocalizedControlTypeCore()

When overridden in a derived class, is called by .

protected override string GetLocalizedControlTypeCore()

Returns:

string

The type of the control.

GetNameCore()

Gets the text label of the that is associated with this . Called by .

protected override string GetNameCore()

Returns:

string

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 .

public override object GetPattern(PatternInterface patternInterface)

Parameters:patternInterfacePatternInterface

A value from the enumeration.

Returns:

object

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.

public IRawElementProviderSimple[] GetRowHeaders()

Returns:

IRawElementProviderSimple[]

A collection of UI Automation providers.

GetSelection()

Retrieves a UI Automation provider for each child element that is selected.

public IRawElementProviderSimple[] GetSelection()

Returns:

IRawElementProviderSimple[]

A collection of UI Automation providers.

GetSupportedViews()

Retrieves a collection of control-specific view identifiers.

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.

public string GetViewName(int viewId)

Parameters:viewIdint

The view identifier.

Returns:

string

A localized name for the view.

Exceptions:

ArgumentException

viewId is not a member of the supported views collection.

SetCurrentView(int)

Sets the current control-specific view.

public void SetCurrentView(int viewId)

Parameters:viewIdint

A view identifier.

Exceptions:

ArgumentException

viewId is not a member of the supported views collection.