Class CalendarAutomationPeer

Exposes Calendar types to UI automation.

Inheritance
System.Object
DependencyObject
AutomationPeer
FrameworkElementAutomationPeer
CalendarAutomationPeer
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: System.Windows.Automation.Peers
Assembly: OpenSilver.Controls.dll
Syntax
public class CalendarAutomationPeer : FrameworkElementAutomationPeer, IDependencyObject, IMultipleViewProvider, ISelectionProvider, ITableProvider, IGridProvider

Constructors

| Improve this Doc View Source

CalendarAutomationPeer(Calendar)

Initializes a new instance of the CalendarAutomationPeer class.

Declaration
public CalendarAutomationPeer(Calendar owner)
Parameters
Type Name Description
Calendar owner

The Calendar instance to associate with the CalendarAutomationPeer.

Methods

| Improve this Doc View Source

GetAutomationControlTypeCore()

Returns the control type for the Calendar that is associated with this CalendarAutomationPeer. This method is called by GetAutomationControlType.

Declaration
protected override AutomationControlType GetAutomationControlTypeCore()
Returns
Type Description
AutomationControlType

A value of the AutomationControlType enumeration.
Overrides
| Improve this Doc View Source

GetClassNameCore()

Returns the name of the UIElement that is associated with this FrameworkElementAutomationPeer. This method is called by GetClassName.

Declaration
protected override string GetClassNameCore()
Returns
Type Description
System.String

The name of the owner type that is associated with this CalendarAutomationPeer.
Overrides
| Improve this Doc View Source

GetNameCore()

Returns the text label of the Calendar that is associated with this CalendarAutomationPeer. This method is called by GetName.

Declaration
protected override string GetNameCore()
Returns
Type Description
System.String

The text label of the element that is associated with this automation peer.
Overrides
| Improve this Doc View Source

GetPattern(PatternInterface)

Gets the control pattern for this CalendarAutomationPeer.

Declaration
public override object GetPattern(PatternInterface patternInterface)
Parameters
Type Name Description
PatternInterface patternInterface

One of the enumeration values.
Returns
Type Description
System.Object

The object that implements the pattern interface, or null if the specified pattern interface is not implemented by this peer.
Overrides

Explicit Interface Implementations

| Improve this Doc View Source

IGridProvider.ColumnCount

Gets the total number of columns in a grid.

Declaration
int IGridProvider.ColumnCount { get; }
Returns
Type Description
System.Int32

The total number of columns in a grid.
| Improve this Doc View Source

IGridProvider.GetItem(Int32, Int32)

Retrieves the UI automation provider for the specified cell.

Declaration
IRawElementProviderSimple IGridProvider.GetItem(int row, int column)
Parameters
Type Name Description
System.Int32 row

The ordinal number of the row.
System.Int32 column

The ordinal number of the column.
Returns
Type Description
IRawElementProviderSimple

The UI automation provider for the specified cell.
Remarks

Grid coordinates are zero-based. The upper-left cell (or upper-right cell, depending on locale) has coordinates (0,0).

If a cell is empty, a UI Automation provider must still be returned in order to support the ContainingGrid property for that cell. This is possible when the layout of child elements in the grid is similar to a ragged array.

Hidden rows and columns can be loaded in the tree, depending on the provider implementation. Therefore, they will be reflected in the RowCount and ColumnCount properties. If the hidden rows and columns have not yet been loaded, they should not be counted.

| Improve this Doc View Source

IGridProvider.RowCount

Gets the total number of rows in a grid.

Declaration
int IGridProvider.RowCount { get; }
Returns
Type Description
System.Int32

The total number of rows in a grid.
| Improve this Doc View Source

IMultipleViewProvider.CurrentView

Gets the current control-specific view.

Declaration
int IMultipleViewProvider.CurrentView { get; }
Returns
Type Description
System.Int32

The value for the current view of the UI automation element.
| Improve this Doc View Source

IMultipleViewProvider.GetSupportedViews()

Retrieves a collection of control-specific view identifiers.

Declaration
int[] IMultipleViewProvider.GetSupportedViews()
Returns
Type Description
System.Int32[]

A collection of values that identifies the views that are available for a UI automation element.
Remarks

The collection of view identifiers must be identical across instances. View identifier values can be passed to GetViewName.

| Improve this Doc View Source

IMultipleViewProvider.GetViewName(Int32)

Retrieves the name of a control-specific view.

Declaration
string IMultipleViewProvider.GetViewName(int viewId)
Parameters
Type Name Description
System.Int32 viewId

The view identifier.
Returns
Type Description
System.String

A localized name for the view.
Remarks

View identifiers can be retrieved by using GetSupportedViews. The collection of view identifiers must be identical across instances. View names must be suitable for use in text-to-speech, Braille, and other accessible applications.

| Improve this Doc View Source

IMultipleViewProvider.SetCurrentView(Int32)

Sets the current control-specific view.

Declaration
void IMultipleViewProvider.SetCurrentView(int viewId)
Parameters
Type Name Description
System.Int32 viewId

A view identifier.
Remarks

View identifiers can be retrieved by using GetSupportedViews.

| Improve this Doc View Source

ISelectionProvider.CanSelectMultiple

Gets a value indicating whether the UI automation provider allows more than one child element to be selected at the same time.

Declaration
bool ISelectionProvider.CanSelectMultiple { get; }
Returns
Type Description
System.Boolean

True if multiple selection is allowed; otherwise, false.
| Improve this Doc View Source

ISelectionProvider.GetSelection()

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

Declaration
IRawElementProviderSimple[] ISelectionProvider.GetSelection()
Returns
Type Description
IRawElementProviderSimple[]

A collection of UI automation providers.
| Improve this Doc View Source

ISelectionProvider.IsSelectionRequired

Gets a value indicating whether the UI automation provider requires at least one child element to be selected.

Declaration
bool ISelectionProvider.IsSelectionRequired { get; }
Returns
Type Description
System.Boolean

True if selection is required; otherwise, false.
| Improve this Doc View Source

ITableProvider.GetColumnHeaders()

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

Declaration
IRawElementProviderSimple[] ITableProvider.GetColumnHeaders()
Returns
Type Description
IRawElementProviderSimple[]

A collection of UI automation providers.
| Improve this Doc View Source

ITableProvider.GetRowHeaders()

Retrieves a collection of UI automation providers that represents all row headers in the table.

Declaration
IRawElementProviderSimple[] ITableProvider.GetRowHeaders()
Returns
Type Description
IRawElementProviderSimple[]

A collection of UI automation providers.
| Improve this Doc View Source

ITableProvider.RowOrColumnMajor

Gets the primary direction of traversal for the table.

Declaration
RowOrColumnMajor ITableProvider.RowOrColumnMajor { get; }
Returns
Type Description
RowOrColumnMajor

The primary direction of traversal.

Implements

Extension Methods