UIAProCalendar Object

This object is supported as a technical preview.

Description

A calendar object in an application that supports UIA Pro.

IMPORTANT

The UIAProCalendar represents controls with Control Type UIA_CalendarControlTypeId = 50001

Operations

The sections below list the built-in methods and properties that you can use as operations for the UIAProCalendar object.

Note: You can also view a list and descriptions of the UIAProCalendar description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Common methods and properties

Common Methods

ActivateDouble-clicks the object to activate it.
Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the specified object property achieves the specified value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
ClickClicks the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Common Method GetROPropertyReturns the current value of the specified description property from the object in the application.
Common Method GetSupportedPatternsReturns an array that contains the patterns supported by the current UI Automation object.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToString

Returns a string that represents the current test object.

TypeSimulates keyboard input on the object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Common Property

Common Property ExistChecks whether the object currently exists in the open application.
Common Property HasSupportedPatternIndicates whether the current UI Automation object supports a specific automation pattern.
Common Property HasSupportedPatternsIndicates whether the current UI Automation object supports all automation patterns.

UIAPro Pattern-Based methods and properties

Expand/Collapse pattern

Method/PropertyDescription
CollapseHides all child nodes, controls, or content of the element.
ExpandDisplays all child nodes, controls, or content of the element.
GetExpandCollapseStateGets the Expand or Collapse state of the element.

Grid pattern

MethodDescription
ActivateCellActivates (double-clicks) the specified cell in the grid.
AddCellToSelectionSelects a cell in addition to previously selected cells.
AddRowToSelectionSelects a row in addition to previously selected rows.
ClickCellClicks the specified cell in the grid.
GetCellRetrieves a UI Automation object representing an item in the grid.
GetCellNameReturns the value of the name property for the specified cell.
GetCellTextReturns the text provided by the cell’s Text pattern.
GetCellValueReturns the value provided by the cell's Value pattern.
GetColumnCountRetrieves the number of columns in the grid.
GetRowCountRetrieves the number of rows in the grid.
SelectCellSelects a cell in the grid.
SelectRowSelects a row in the grid.
SetCellValueSets the specified cell’s value using the Value pattern.

GridItem pattern

MethodDescription
GetColumnIndexRetrieves the zero-based index of the column that contains the grid item.
GetContainingGridRetrieves a UI Automation object that supports Grid pattern and represents the container of the cell or item.
GetRowIndexRetrieves the zero-based index of the row that contains the grid item.
GetSpannedColumnsRetrieves the number of columns spanned by a cell or item.
GetSpannedRowsRetrieves the number of rows spanned by a cell or item.

Invoke pattern

MethodDescription
InvokeInvokes the action of a control, such as a button click.

LegacyIAccessible pattern

MethodDescription
GetChildIdRetrieves the Microsoft Active Accessibility child identifier for the current object.
GetDefaultActionRetrieves the Microsoft Active Accessibility default action for the current object.
GetDescriptionRetrieves the Microsoft Active Accessibility description for the current object.
GetHelpRetrieves the Microsoft Active Accessibility help string for the current object.
GetKeyboardShortcutRetrieves the Microsoft Active Accessibility keyboard shortcut for the current object.
GetNameRetrieves the Microsoft Active Accessibility name for the current object.
GetRoleRetrieves the Microsoft Active Accessibility role for the current object.
GetSelectedChildrenRetrieves the Microsoft Active Accessibility selected children of the current object.
GetStateRetrieves the Microsoft Active Accessibility state for the current object.
GetValueRetrieves the Microsoft Active Accessibility value for the current object.
SelectSelects the element.
SetSecureSets the encrypted Microsoft Active Accessibility value for the current object.
SetValueSets the Microsoft Active Accessibility value for the current object.
PerformDefaultOperationPerforms the default operation on the control.

RangeValue pattern

Method/PropertyDescription
GetLargeChangeGets the control-specific large-change value that is added to or subtracted from the Value of the current UI Automation object.
GetMaximumGets the maximum value supported by the UI Automation object.
GetMinimumGets the minimum value supported by the UI Automation object.
GetSmallChangeGets the control-specific small-change value that is added to or subtracted from the Value of the current UI Automation object.
GetValueGets the current value of the UI Automation object.
Common Property IsReadOnlyIndicates whether the value of a UI Automation object is read-only.
SetValueSets the current value of the UI Automation object.

Scroll pattern

Method/PropertyDescription
Common Property CanScrollHorizontallyIndicates whether the UI Automation element can scroll horizontally.
Common Property CanScrollVerticallyIndicates whether the UI Automation element can scroll vertically.
GetHorizontalScrollPercentGets the current horizontal scroll position.
GetHorizontalViewSizeGets the current horizontal view size.
GetVerticalScrollPercentGets the current vertical scroll position.
GetVerticalViewSizeGets the current vertical view size.

Selection pattern

Method/PropertyDescription
Common Property CanSelectMultipleItemsIndicates whether multiple items in the container can be selected at once.
Common Property IsSelectionRequiredGets a value that specifies whether the container requires at least one child item to be selected.
GetSelectedChildrenRetrieves all selected items from the container.

SelectionItem pattern

Method/PropertyDescription
AddToSelectionSelects the item in addition to the previously selected items.
Common Property IsSelected Indicates whether the item is selected.
RemoveFromSelectionDeselects the current item.
SelectDeselects any selected items and then selects the current item.

Table pattern

MethodDescription
GetColumnHeadersRetrieves a collection of UI Automation objects representing all the column headers in a table.
GetPrimaryTraversalDirectionRetrieves the primary direction of traversal for the table.
GetRowHeadersRetrieves a collection of UI Automation objects representing all the row headers in a table.

TableItem pattern

MethodDescription
GetColumnHeaderItemsRetrieves the column headers associated with a table item or cell.
GetRowHeaderItemsRetrieves the row headers associated with a table item or cell.

Text pattern

MethodDescription
GetTextRetrieves the text of the object.
GetSupportedSelectionModeIndicates the type of text selection that is supported by the control.

Toggle pattern

MethodDescription
GetToggleStateProvides access to the property values of a Toggle Pattern object using its Current or Cached accessors
ToggleCycles through the toggle states of the control.

Value pattern

Method/PropertyDescription
GetValueRetrieves the value of the UI Automation element.
Common Property IsReadOnlyIndicates whether the value of the control is read-only.
SetSecureSets the encrypted value of the UI Automation element.
SetValueSets the value of the UI Automation element.

Window pattern

Method/PropertyDescription
Common Property CanMaximizeIndicates whether the UI Automation element can be maximized.
Common Property CanMinimizeIndicates whether the UI Automation element can be minimized.
Common Property IsModalIndicates whether the UI Automation element is modal.

Back to top

Activate Method

Description

Double-clicks the object to activate it.

Syntax

object.Activate [x],[y]

Arguments

ParameterDescription
x

Optional. A long integer value.

The x-coordinate of the click.

y

Optional. A long integer value.

The y-coordinate of the click.

Return Type

None

Back to top

Click Method

Description

Clicks the object.

Syntax

object.Click [x],[y], [button]

Arguments

ParameterDescription
x

Optional. A long integer value.

The x-coordinate of the click.

y

Optional. A long integer value.

The y-coordinate of the click.

button

Optional. A predefined constant or number.

The mouse button used to perform the click.

Return Type

None

Example

Back to top

GetSupportedPatterns Method

Description

Returns an array that contains the patterns supported by the current UI Automation object.

Syntax

object.GetSupportedPatterns

Return Type

An array

Back to top

HasSupportedPattern Property

Description

Indicates whether the current UI Automation object supports a specific automation pattern.

Syntax

object.HasSupportedPattern(string patternName)

Arguments

ParameterDescription
PatternName

An automation pattern.

Return Type

A value of Boolean type.

Back to top

HasSupportedPatterns Property

Description

Indicates whether the current UI Automation object supports all automation patterns.

Syntax

object.HasSupportedPatterns(string patternName)

Arguments

ParameterDescription
PatternName

Automation patterns.

Return Type

A value of Boolean type.

Back to top

Type Method

Description

Simulates keyboard input on the object.

Syntax

object.Type string

Arguments

ParameterDescription
string

Required. A string.

The characters to enter in the object.

Return Type

None

Back to top

ActivateCell Method

Description

Activates (double-clicks) the specified cell in the grid.

Syntax

object.ActivateCell rowIndex, columnIndex, [x, y]

Arguments

ParameterDescription
rowIndex

Required. An integer.

The cell row index.

columnIndex

Required. An integer.

The cell column index.

x

Optional. An integer.

The x-coordinate of the cell to activate.

y

Optional. An integer.

The y-coordinate of the cell to activate.

Return Type

None

IMPORTANT

This method is available only if you implement the Grid pattern in an object in your application.

Back to top

AddCellToSelection Method

Description

Selects a cell in addition to previously selected cells.

Syntax

object.AddToSelection rowIndex, columnIndex

Arguments

ParameterDescription
rowIndex

Required. An integer.

The cell row index.

columnIndex

Required. An integer.

The cell column index.

Return Type

None

IMPORTANT

This method is available only if you implement the Grid pattern in an object in your application.

Back to top

AddRowToSelection Method

Description

Selects a row in addition to previously selected rows.

Syntax

object.AddToSelection rowIndex

Arguments

ParameterDescription
rowIndex

Required. An integer.

The row to select.

Return Type

None

IMPORTANT

This method is available only if you implement the Grid pattern in an object in your application.

Back to top

AddToSelection Method

Description

Selects the item in addition to the previously selected items.

Syntax

object.AddToSelection

Return Type

None

IMPORTANT

This method is available only if you implement the SelectionItem pattern in an object in your application.

Back to top

CanMaximize Property

Description

Indicates whether the UI Automation element can be maximized.

Syntax

object.CanMaximize

Return Type

A value of Boolean type.

IMPORTANT

This method is available only if you implement the Window pattern in an object in your application.

Back to top

CanMinimize Property

Description

Indicates whether the UI Automation element can be minimized.

Syntax

object.CanMinimize

Return Type

A value of Boolean type.

IMPORTANT

This method is available only if you implement the Window pattern in an object in your application.

Back to top

CanScrollHorizontally Property

Description

Indicates whether the UI Automation element can scroll horizontally.

Syntax

object.CanScrollHorizontally

Return Type

A value of Boolean type.

IMPORTANT

This method is available only if you implement the Scroll pattern in an object in your application.

Back to top

CanScrollVertically Property

Description

Indicates whether the UI Automation element can scroll vertically.

Syntax

object.CanScrollVertically

Return Type

A value of Boolean type.

IMPORTANT

This method is available only if you implement the Scroll pattern in an object in your application.

Back to top

CanSelectMultipleItems Property

Description

Indicates whether multiple items in the container can be selected at once.

Syntax

object.CanSelectMultipleItems

Return Type

A value of Boolean type.

IMPORTANT

This method is available only if you implement the Selection pattern in an object in your application.

Back to top

ClickCell Method

Description

Clicks the specified cell in the grid.

Syntax

object.ClickCell rowIndex,columnIndex, [x, y, button]

Arguments

ParameterDescription
rowIndex

Required. An integer.

The cell row index.

columnIndex

Required. An integer.

The cell column index

x

Required. An integer.

The x-coordinate of the cell to click.

y

Required. An integer.

The y-coordinate of the cell to click.

buttonThe mouse button used to perform the cell click.

Return Type

None

IMPORTANT

This method is available only if you implement the Grid pattern in an object in your application.

Back to top

ParameterDescription
rowIdx
x
y

Collapse Method

Description

Hides all child nodes, controls, or content of the element.

Syntax

object.Collapse

Return Type

None

IMPORTANT

This method is available only if you implement the ExpandCollapse pattern in an object in your application.

Example

Back to top

Expand Method

Description

Displays all child nodes, controls, or content of the element.

Syntax

object.Expand

Return Type

None

IMPORTANT

This method is available only if you implement the ExpandCollapse pattern in your application.

Example

Back to top

GetCell Method

Description

Retrieves a UI Automation object representing an item in the grid.

Syntax

object.GetCell(int rowIndex, int columnIndex)

Arguments

ParameterDescription
rowIndex

Required. An integer.

The cell row index.

columnIndex

Required. An integer.

The cell column index.

Return Type

A UI Automation object.

IMPORTANT

This method is available only if you implement the Grid pattern in your application.

Back to top

GetCellName Method

Description

Returns the value of the name property for the specified cell.

Syntax

object.GetCellName rowIndex, columnIndex

Arguments

ParameterDescription
rowIndex

Required. An integer value.

The cell row index.

columnIndex

Required. An integer value.

The cell column index.

Return Type

The value of the name property for the specified cell.

Back to top

GetCellValue Method

Description

Returns the value provided by the cell's value pattern.

Syntax

object.GetCellValue rowIndex, columnIndex

Arguments

ParameterDescription
rowIndex

Required. An integer value.

The cell row index.

columnIndex

Required. An integer value.

The cell column index.

Return Type

The value of the value property for the specified cell.

Back to top

GetCellText Method

Description

Returns the text provided by the cell's Text pattern.

Syntax

object.GetCellText(int rowIndex, int columnIndex)

Arguments

ParameterDescription
rowIndex

Required. An integer.

The cell row index.

columnIndex

Required. An integer.

The cell column index.

Return Type

A text string.

IMPORTANT

This method is available only if you implement the Grid pattern in your application.

Back to top

GetChildId Method

Description

Retrieves the Microsoft Active Accessibility child identifier for the current object.

Syntax

object.GetChildId

Return Type

An integer.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in your application.

Back to top

GetColumnCount Method

Description

Retrieves the number of columns in the grid.

Syntax

object.GetColumnCount

Return Type

An integer.

IMPORTANT

This method is available only if you implement the Grid pattern in your application.

Back to top

GetColumnHeaders Method

Description

Retrieves a collection of UI Automation objects representing all the column headers in a table.

Syntax

object.GetColumnHeaders

Return Type

A collection of UI Automation objects.

IMPORTANT

This method is available only if you implement the Table pattern in an object in your application.

Back to top

GetColumnHeaderItems Method

Description

Retrieves the column headers associated with a table item or cell.

Syntax

object.GetColumnHeaderItems

Return Type

A collection of UI Automation objects.

IMPORTANT

This method is available only if you implement the TableItem pattern in an object in your application.

Back to top

GetColumnIndex Method

Description

Retrieves the zero-based index of the column that contains the grid item.

Syntax

object.GetColumnIndex

Return Type

An integer.

IMPORTANT

This method is available only if you implement the GridItem pattern in an object in your application.

Back to top

GetContainingGrid Method

Description

Retrieves a UI Automation object that supports the Grid pattern and represents the container of the cell or item.

Syntax

object.GetContainingGrid

Return Type

A UI Automation object.

IMPORTANT

This method is available only if you implement the GridItem pattern in an object in your application.

Back to top

GetDescription Method

Description

Retrieves the Microsoft Active Accessibility description for the current object.

Syntax

object.GetDescription

Return Type

A string.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

GetDefaultAction Method

Description

Retrieves the Microsoft Active Accessibility default action for the current object.

Syntax

object.GetDefaultAction

Return Type

A string.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

GetExpandCollapseState Method

Description

Gets the Expand/Collapse state of the element.

Syntax

object.GetExpandCollapseState

Return Type

Expand/Collapse state.

IMPORTANT

This method is available only if you implement the ExpandCollapse pattern in an object in your application.

Back to top

GetHelp Method

Description

Retrieves the Microsoft Active Accessibility help string for the current object.

Syntax

object.GetHelp

Return Type

A help string.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

GetHorizontalScrollPercent Method

Description

Gets the current horizontal scroll position.

Syntax

object.GetHorizontalScrollPercent

Return Type

A value of Double type.

IMPORTANT

This method is available only if you implement the Scroll pattern in an object in your application.

Back to top

GetHorizontalViewSize Method

Description

Gets the current horizontal view size.

Syntax

object.GetHorizontalViewSize

Return Type

A value of Double type.

IMPORTANT

This method is available only if you implement the Scroll pattern in an object in your application.

Back to top

GetKeyboardShortcut Method

Description

Retrieves the Microsoft Active Accessibility keyboard shortcut for the current object.

Syntax

object.GetKeyboardShortcut

Return Type

A string.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

GetLargeChange Method

Description

Gets the control-specific large-change value that is added to or subtracted from the Value of the current UI Automation object.

Syntax

object.GetLargeChange

Return Type

A value of Double type.

IMPORTANT

This method is available only if you implement the RangeValue pattern in an object in your application.

Back to top

GetMaximum Method

Description

Gets the maximum value supported by the UI Automation object.

Syntax

object.GetMaximum

Return Type

A value of Double type.

IMPORTANT

This method is available only if you implement the RangeValue pattern in an object in your application.

Back to top

GetMinimum Method

Description

Gets the minimum value supported by the UI Automation object.

Syntax

object.GetMinimum

Return Type

A value of Double type.

IMPORTANT

This method is available only if you implement the RangeValue pattern in an object in your application.

Back to top

GetName Method

Description

Retrieves the Microsoft Active Accessibility name for the current object.

Syntax

object.GetName

Return Type

A string.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

GetPrimaryTraversalDirection Method

Description

Retrieves the primary direction of traversal for the table.

Syntax

object.GetPrimaryTraversalDirection

Return Type

The table traversal direction.

IMPORTANT

This method is available only if you implement the Table pattern in an object in your application.

Back to top

GetRole Method

Description

Retrieves the Microsoft Active Accessibility role for the current object.

Syntax

object.GetRole

Return Type

An accessible role.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

GetRowHeaders Method

Description

Retrieves a collection of UI Automation objects representing all the row headers in a table.

Syntax

object.GetRowHeaders

Return Type

A collection of UI Automation objects.

IMPORTANT

This method is available only if you implement the Table pattern in an object in your application.

Back to top

GetRowHeaderItems Method

Description

Retrieves the row headers associated with a table item or cell.

Syntax

object.GetRowHeaderItems

Return Type

A collection of UI Automation objects.

IMPORTANT

This method is available only if you implement the TableItem pattern in an object in your application.

Back to top

GetRowCount Method

Description

Retrieves the number of rows in the grid.

Syntax

object.GetRowCount

Return Type

An integer

IMPORTANT

This method is available only if you implement the Grid pattern in an object in your application.

Back to top

GetRowIndex Method

Description

Retrieves the zero-based index of the row that contains the grid item.

Syntax

object.GetRowIndex

Return Type

An integer

IMPORTANT

This method is available only if you implement the GridItem pattern in an object in your application.

Back to top

GetSelectedChildren Method

Description

Retrieves the Microsoft Active Accessibility selected children of the current object.

Syntax

object.GetSelectedChildren

Return Type

A UI Automation object.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

GetSelectedChildren Method

Description

Retrieves all selected items from the container.

Syntax

object.GetSelectedChildren

Return Type

A UI Automation object.

IMPORTANT

This method is available only if you implement the Selection pattern in an object in your application.

Back to top

GetSmallChange Method

Description

Gets the control-specific small-change value that is added to or subtracted from the Value of the current UI Automation object.

Syntax

object.GetSmallChange

Return Type

A value of Double type.

IMPORTANT

This method is available only if you implement the RangeValue pattern in an object in your application.

Back to top

GetSpannedColumns Method

Description

Retrieves the number of columns spanned by a cell or item.

Syntax

object.GetSpannedColumns

Return Type

An integer

IMPORTANT

This method is available only if you implement the GridItem pattern in an object in your application.

Back to top

GetSpannedRows Method

Description

Retrieves the number of rows spanned by a cell or item.

Syntax

object.GetSpannedRows

Return Type

An integer.

IMPORTANT

This method is available only if you implement the GridItem pattern in an object in your application.

Back to top

GetState Method

Description

Retrieves the Microsoft Active Accessibility state for the current object.

Syntax

object.GetState

Return Type

The accessibility state.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

GetSupportedSelectionMode Method

Description

Indicates the type of text selection that is supported by the control.

Syntax

object.GetSupportedSelectionMode

Return Type

The text selection mode.

IMPORTANT

This method is available only if you implement the Text pattern in an object in your application.

Back to top

GetText Method

Description

Retrieves the text of the object.

Syntax

object.GetText

Return Type

A string with the text of an object.

IMPORTANT

This method is available only if you implement the Text pattern in an object in your application.

Back to top

GetToggleState Method

Description

Provides access to the property values of a Toggle Pattern object using its Current or Cached accessors.

Syntax

object.GetToggleState

Return Type

The toggle state.

IMPORTANT

This method is available only if you implement the Toggle pattern in an object in your application.

Back to top

GetValue Method

Description

Retrieves the value of the UI Automation element.

Syntax

object.GetValue

Return Type

A string

IMPORTANT

This method is available only if you implement the Value pattern in an object in your application.

Back to top

GetValue Method

Description

Gets the current value of the UI Automation object.

Syntax

object.GetValue

Return Type

A string.

IMPORTANT

This method is available only if you implement the RangeValue pattern in an object in your application.

Back to top

GetValue Method

Description

Retrieves the Microsoft Active Accessibility value for the current object.

Syntax

object.GetValue

Return Type

A string.

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

GetVerticalScrollPercent Method

Description

Gets the current vertical scroll position.

Syntax

object.GetVerticalScrollPercent

Return Type

A value of Double type.

IMPORTANT

This method is available only if you implement the Scroll pattern in an object in your application.

Back to top

GetVerticalViewSize Method

Description

Gets the current vertical view size.

Syntax

object.GetVerticalViewSize

Return Type

A value of Double type.

IMPORTANT

This method is available only if you implement the Scroll pattern in an object in your application.

Back to top

Invoke Method

Description

Invokes the action of a control, such as a button click.

Syntax

object.Invoke

Return Type

None

IMPORTANT

This method is available only if you implement the Invoke pattern in an object in your application.

Back to top

IsModal Property

Description

Indicates whether the UI Automation element is modal.

Syntax

object.IsModal

Return Type

A Boolean type value.

IMPORTANT

This property is available only if you implement the Window pattern in an object in your application.

Back to top

IsSelectionRequired Property

Description

Gets a value that specifies whether the container requires at least one child item to be selected.

Syntax

object.IsSelectionRequired

Return Type

A value of Boolean type.

IMPORTANT

This property is available only if you implement the Selection pattern in an object in your application.

Back to top

IsReadOnly Property

Description

Indicates whether the value of the control is read-only.

Syntax

object.IsReadOnly

Return Type

A value of Boolean type.

IMPORTANT

This property is available only if you implement the Value pattern in an object in your application.

Back to top

IsSelected Property

Description

Indicates whether an object is selected.

Syntax

object.IsSelected

Return Type

A value of Boolean type.

IMPORTANT

This method is available only if you implement the SelectionItem pattern in an object in your application.

Back to top

IsReadOnly Property

Description

Indicates whether the value of a UI Automation object is read-only.

Syntax

object.IsReadOnly

Return Type

A value of Boolean type.

IMPORTANT

This method is available only if you implement the RangeValue pattern in an object in your application.

Back to top

PerformDefaultOperation Method

Description

Performs the default operation on the control.

Syntax

object.PerformDefaultOperation

Return Type

None

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

RemoveFromSelection Method

Description

Deselects the current item.

Syntax

object.RemoveFromSelection

Return Type

None

IMPORTANT

This method is available only if you implement the SelectionItem pattern in an object in your application.

Back to top

Select Method

Description

Deselects any selected items and then selects the current item.

Syntax

object.Select

Return Type

None

IMPORTANT

This method is available only if you implement the SelectionItem pattern in an object in your application.

Back to top

Select Method

Description

Selects the element.

Syntax

object.Select(SelectOptions selectionOptions)

Arguments

ParameterDescription
selectionOptions

The flag to use when selecting the element.

Return Type

None

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

SelectCell Method

Description

Selects a cell in the grid.

Syntax

object.SelectCell rowIndex, columnIndex

Arguments

ParameterDescription
rowIndex

Required. An integer.

The cell row index.

columnIndex

Required. An integer.

The cell column index.

Return Type

None

IMPORTANT

This method is available only if you implement the Grid pattern in an object in your application.

Back to top

SelectRow Method

Description

Selects a row in the table.

Syntax

object.SelectRow rowIndex

Arguments

ParameterDescription
rowIndex

Required. An integer.

The row to select.

Return Type

None

IMPORTANT

This method is available only if you implement the Grid pattern in an object in your application.

Back to top

SetCellValue Method

Description

Sets the specified cell’s value using the Value pattern.

Syntax

object.SetCellValue(int rowIndex, int columnIndex, string cellValue)

Arguments

ParameterDescription
rowIndex

Required. An integer.

The cell row index.

columnIndex

Required. An integer.

The cell column index.

cellValueThe value to be set for the specified cell.

Return Type

None

IMPORTANT

This method is available only if you implement the Grid pattern in an object in your application.

Back to top

SetValue Method (LegacyIAccessible)

Description

Sets the Microsoft Active Accessibility value for the current object.

Syntax

object.SetValue(string valueToSet)

Return Type

None

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

SetValue Method

Description

Sets the current value of the UI Automation object.

Syntax

object.SetValue (double valueToSet)

Return Type

None

IMPORTANT

This method is available only if you implement the RangeValue pattern in an object in your application.

Back to top

SetScrollPercent Method

Description

Sets the horizontal and vertical scroll position as a percentage of the total content area within the automation element.

Syntax

object.SetScrollPercent horizontalPercent, verticalPercent

Arguments

ParameterDescription
horizontalPercent

Required. A Double value.

The percentage of the total horizontal content area.

verticalPercent

Required. A Double value.

The percentage of the total vertical content area.

Return Type

None

IMPORTANT

  • This method is available only if you implement the Scroll pattern in an object in your application.
  • This method is only useful when the content area of the object is larger than the visible region of the object.

Back to top

SetSecure Method

Description

Sets the encrypted Microsoft Active Accessibility value for the current object.

Syntax

object.LegacyIAccessiblePattern.SetSecureValue Text

Arguments

ParameterDescription
Text

Required. A string.

Return Type

None

IMPORTANT

This method is available only if you implement the LegacyIAccessible pattern in an object in your application.

Back to top

SetSecure Method

Description

Sets the encrypted value of the UI Automation element.

Syntax

object.ValuePattern.SetSecureValue Text

Arguments

ParameterDescription
Text

Required. A string.

Return Type

None

IMPORTANT

This method is available only if you implement the Value pattern in an object in your application.

Back to top

SetValue Method

Description

Sets the value of the UI Automation element.

Syntax

object.SetValue(string valueToSet)

Arguments

ParameterDescription
valueToSet

Required. A string.

The value to set.

Return Type

None

IMPORTANT

This method is available only if you implement the Value pattern in an object in your application.

Back to top

Toggle Method

Description

Cycles through the toggle states of the control.

Syntax

object.Toggle

Return Type

None

IMPORTANT

This method is available only if you implement the Toggle pattern in an object in your application.

Back to top

See also: