UIARadioButton Object

Description

A radio button object in an application that supports UIAutomation.

IMPORTANT

The UIARadioButton object is based on controls with Control Type UIA_RadioButtonControlTypeId = 50013

Operations

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

Note: You can also view a list and descriptions of the UIARadioButton 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.

Methods

Common Methods and Properties

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.
Method DragPerforms the 'drag' part of a drag and drop operation.
Method DropPerforms the 'drop' part of a drag and drop operation.
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 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.
GetVisibleTextReturns the text from the specified area.
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.
SetFocusActivates the selected object and brings it into focus.
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.
SelectSelects a radio button by clicking on it.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the object.

UIAutomation Pattern-Based Methods and Properties

Note: The methods in this table are sorted by supported pattern name, not alphabetically.

MethodSupported Pattern (A-Z)Description
CanExpandExpandCollapseIndicates whether an object can expand or not.
CollapseExpandCollapseCollapses the specified item.
ExpandExpandCollapseExpands the selected item.
IsExpandedExpandCollapseIndicates whether an object is expanded or not.
ActivateCellGridMakes a selected cell active by clicking in it.
AddCellToSelectionGridSelects a cell in addition to previously selected cells.
AddRowToSelectionGrid

Selects a row and adds it to previously selected rows.

ClickCellGridClicks a specific cell in the object.
ClickItemInvoke

Clicks the specified date in the object.

ClickRowGridClicks a specific row in the object.
Common Property GetCellNameGridReturns the value of the name property for the specified cell.
Common Property GetCellValueGridReturns the value of the value property for the specified cell.
GetRowsGrid

Returns a list of all the rows in the object.

RemoveCellFromSelectionGridRemoves a selected cell from the list of selected cell (while keeping other cells selected).
RemoveRowFromSelectionGridRemoves a row from the list of selected rows(while keeping other rows selected).
SelectRowGridSelects a row in the table.
ClickInvokeClicks a clickable point in the application.
CanDecrementRangeValueIndicates whether the current value is the minimum.
CanIncrementRangeValueIndicates whether the current value is the maximum.
DecrementRangeValueLowers the value of the item in the specified object by one step.
IncrementRangeValueRaises the value of the item in the specified object by one step.
IsReadOnlyRangeValueIndicates whether the object is read-only.
LargeChangeRangeValueIndicates whether the change was a large change or not.
MaximumRangeValueIndicates the maximum value of the object.
MinimumRangeValueIndicates the minimum value of the object.
SmallChangeRangeValueIndicates whether the change was a small change or not.
SetValueRangeValue
Value
Sets the value of the object.
ValueRangeValueThe value of the object.
HorizontalScrollPercentScrollSpecifies the amount of horizontal scroll percent.
HorizontallyScrollableScrollSpecifies whether the object is scrollable in the horizontal direction.
HorizontalViewSizeScrollSpecifies the amount of viewable space horizontally.
ScrollScroll

Scrolls the item in the specified direction for the given distance.

ScrollDownScrollScrolls the item downward.
ScrollRightScrollScrolls the object right.
ScrollUpScrollScrolls the object upwards.
ScrollLeftScrollScrolls the item left.
SetScrollPercentScroll

Sets the percentage by which you should scroll the object.

VerticalScrollPercentScrollSpecifies the amount of vertical scroll percent.
VerticallyScrollableScrollSpecifies whether the object is scrollable in the vertical direction.
VerticalViewSizeScrollSpecifies the amount of viewable space vertically.
ScrollIntoViewScrollItemScrolls the specified object to be visible.
AddToSelectionSelectionAdds the selected item to the group of previously selected set of items.
GetSelectionSelectionReturns the collection of selected items.
RemoveFromSelectionSelectionRemoves an item from the set of selected items.
SelectSelectionSelects one item from the object.
AddToSelectionSelectionItem

Selects a cell in addition to previously selected cells.

IsSelectedSelectionItemIndicates whether an object is selected or not.
RemoveFromSelectionSelectionItem

Removes an item from the set of selected items.

SelectSelectionItemSelects one item from the object.
ColumnHeadersTableReturns a list of all column headers in the object.
GetColumnHeadersTableReturns a list of all the column headers in the object.
GetRowHeadersTableReturns a list of all the row headers in the object.
RowHeadersTableReturns a list of all row headers in the object.
RowOrColumnMajorTableIndicates whether the data in the object should be read primarily by row or column.
GetColumnHeaderItemsTableItemReturns a list of all the column headers in the object.
GetRowHeaderItemsTableItemReturns a list of all the row headers in the object.
GetTextTextRetrieves the text of the object.
TextTextThe text in the object.
SetToggleSets the state of the object.
StateToggleReturns the toggle state of the object.
MoveTransformMoves the object.
ResizeTransformResizes the object.
RotateTransform

Rotates the object.

IsReadOnlyValueIndicates if the object is read-only or not.
SetValueValueSets the value of the control.
ValueValueThe value of the object.
CloseWindowCloses the object.
IsMaximizedWindowIndicates whether the object is maximized at present.
IsMinimizedWindowIndicates whether the object is minimized at present.
IsReadyForInteractionWindowIndicates whether the object is ready for use.
MaximizeWindowEnlarges the object to its maximum size.
MinimizeWindowMinimizes the object.
RestoreWindowDisplays the object in its previous position.

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

Drag Method

Description

Performs the 'drag' part of a drag and drop operation.

Syntax

object.Drag [X], [Y], [BUTTON]

Arguments

ParameterDescription
X Optional. An integer value.
The x-coordinate within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
Y Optional. An integer value.
The y-coordinate within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON Optional. A predefined constant or number.
The mouse button used to drag the object.
Default value = micLeftBtn

Return Type

None

Examples

Back to top

Drop Method

Description

Performs the 'drop' part of a drag and drop operation.

Syntax

object.Drop [X], [Y], [BUTTON]

Arguments

ParameterDescription
X Optional. An integer value.
The x-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
Y Optional. An integer value.
The y-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON Optional. A predefined constant or number.
The mouse button that is released to drop the object.
Default value = micLeftBtn

Return Type

None

Examples

Back to top

GetVisibleText Method

Description

Returns the text from the specified area.

Syntax

object.GetVisibleText [left], [top], [right], [bottom]

Arguments

ParameterDescription
left

Optional. A long integer value.

The coordinate for the left side of the area from which to select the text.

top

Optional. A long integer value.

The coordinate for the top side of the area from which to select the text.

right

Optional. A long integer value.

The coordinate for the right side of the area from which to select the text.

bottom

Optional. A long integer value.

The coordinate for the bottom side of the area from which to select the text.

Return Type

The text of the object in the specified area.

Back to top

SetFocus Method

Description

Activates the selected object and brings it into focus.

Syntax

object.SetFocus

Return Type

None

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

Back to top

Select Method

Description

Selects a radio button by clicking on it.

Syntax

object.Select

Return Type

None

Back to top

GetCellName Method

Description

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

Syntax

object.GetCellName rowIdx, colIdx

Arguments

ParameterDescription
rowIdx

Required. A long integer value.

The row of the cell from which to retrieve the value.

colIdx

Required. A long integer value.

The column of the cell from which to retrieve the value.

Return Type

The value of the name property for the specified cell.

Back to top

GetCellValue Method

Description

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

Syntax

object.GetCellValue rowIdx, colIdx

Arguments

ParameterDescription
rowIdx

Required. A long integer value.

The row of the cell from which to retrieve the value.

colIdx

Required. A long integer value.

The column of the cell from which to retrieve the value.

Return Type

The value of the value property for the specified cell.

Back to top

ActivateCell Method

Description

Makes a selected cell active by clicking in it.

Syntax

object.ActivateCell rowIdx, columnIdx, [x, y]

Arguments

ParameterDescription
rowIdx

Required. An integer.

The row in which the cell to select is found.

colIdx

Required. A variant.

The column to select. You can specify the column name or the index of the column.

Note: Using the column name for this argument is supported only if the Table pattern is implemented for the control.

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 (Selection Pattern)

Description

Selects a cell in addition to previously selected cells.

Syntax

object.AddToSelection rowIdx, columnIdx

Arguments

ParameterDescription
rowIdx

Required. An integer.

The row in which the cell to select is found.

colIdx

Required. A variant.

The column to select. You can specify the column name or the index of the column.

Note: Using the column name for this argument is supported only if the Table pattern is implemented for the control.

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 and adds it to previously selected rows.

Syntax

object.AddToSelection rowIdx

Arguments

ParameterDescription
rowIdx

Required. An integer.

The row in which the cell to select is found.

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

Adds the selected item to the group of previously selected set of items.

Syntax

object.AddToSelection Item

Arguments

ParameterDescription
Item

Required. A string

The item to select.

Return Type

None

IMPORTANT

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

Example

Back to top

AddToSelection Method (SelectionItem Pattern)

Description

Adds the selected item to the group of previously selected set of 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

CanExpand Property

Description

Indicates whether an object can expand or not.

Syntax

object.CanExpand

Return Type

A string indicating whether the object can be expanded

IMPORTANT

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

Back to top

CanDecrement Property

Description

Checks whether the current value is the minimum or not.

Syntax

object.CanDecrement

Return Type

A string indicating whether the value is the minimum or not..

IMPORTANT

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

Back to top

CanIncrement Property

Description

Checks whether the current value is the maximum

Syntax

object.CanIncrement

Return Type

A string indicating whether the current value is the maximum or not.

IMPORTANT

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

Back to top

ClickCell Method

Description

Clicks a specific cell in the object.

Syntax

object.ClickCell rowIdx,colIdx, [x, y]

Arguments

ParameterDescription
rowIdx

Required. An integer.

The row in which the cell to select is found.

colIdx

Required. A variant.

The column to select. You can specify the column name or the index of the column.

Note: Using the column name for this argument is supported only if the Table pattern is implemented for the control.

x

Required. An integer.

The x-coordinate of the click.

y

Required. An integer.

The y-coordinate of the 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

ClickItem Method

Description

Clicks the specified date in the object.

Syntax

object.ClickItem[date]

Arguments

ParameterDescription
date

Required. A string.

The date to click.

Return Type

None

Example

Back to top

ClickRow Method

Description

Clicks a specific row in the object.

Syntax

object.ClickCell rowIdx, [x, y]

Arguments

ParameterDescription
rowIdx

Required. An integer.

The row in which the cell to select is found.

x

Required. An integer.

The x-coordinate of the click.

y

Required. An integer.

The y-coordinate of the 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

Close Method

Description

Closes the object.

Syntax

object.Close

Return Type

None

IMPORTANT

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

Back to top

Click Method

Description

Clicks a clickable point in the application.

Syntax

object.Click [x, y, button]

Arguments

ParameterDescription
x

Required. An integer.

The x-coordinate of the click.

y

Required. An integer.

The y-coordinate of the click.

Button

The mouse button used to make the click.

Possible values include:

  • L = left button
  • R = right button
  • M = middle button
  • 0 = left button
  • 1 = right button
  • 2 = middle button

Return Type

None

IMPORTANT

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

Example

Back to top

Collapse Method

Description

Collapses the specified item.

Syntax

object.Collapse Item

Arguments

ParameterDescription
Item

Required. A variant.

The name of the tree node. The node value (with quotes) or numeric index (without quotes) can denote the node. The first node in a tree is numbered 0. You must specify the full path to the tree node, using ; as the separator to indicate the node hierarchy.

Return Type

None

IMPORTANT

  • This method is available only if you implement the ExpandCollapse pattern in an object in your application.
  • If your object is a container object, you do not need the method's parameters.

Example

Back to top

ColumnHeaders Property

Description

Returns a list of column headers in the object.

Syntax

object.ColumnHeaders

Return Type

A string with the column headers, separated by semicolons (;).

IMPORTANT

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

Back to top

Decrement Method

Description

Lowers the value of the item in the specified object by one step.

Syntax

object.Decrement

Return Type

None

IMPORTANT

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

Back to top

Expand Method

Description

Expands the selected item.

Syntax

object.Expand Item

Arguments

ParameterDescription
Item

Required. A variant.

The name of the tree node. The node value (with quotes) or numeric index (without quotes) can denote the node. The first node in a tree is numbered 0. You must specify the full path to the tree node, using ; as the separator to indicate the node hierarchy.

Return Type

None

IMPORTANT

  • This method is available only if you implement the ExpandCollapse pattern in your application.
  • If the object is a container object, the Item parameter is not required.

Example

Back to top

GetColumnHeaders Method

Description

Returns a list of all the column headers in the object.

Syntax

object.GetColumnHeaders

Return Type

A list of all column header names in the object.

IMPORTANT

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

Back to top

GetColumnHeaderItems Method

Description

Returns a list of all the column headers in the object.

Syntax

object.GetColumnHeaderItems

Return Type

A list of all column header names in the object.

IMPORTANT

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

Back to top

GetRows Method

Description

Returns a list of all the rows in the object.

Syntax

object.GetRows

Return Type

An array of all rows in the object.

IMPORTANT

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

Back to top

GetRowHeaders Method

Description

Returns a list of all the row headers in the object.

Syntax

object.GetRowHeaders

Return Type

A list of all row header names in the object.

IMPORTANT

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

Back to top

GetRowHeaderItems Method

Description

Returns a list of all the row headers in the object.

Syntax

object.GetRowHeaderItems

Return Type

A list of all row header names in the object.

IMPORTANT

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

Back to top

GetSelection Method

Description

Returns the collection of selected items.

Syntax

object.GetSelection

Return Type

A list of selected items.

IMPORTANT

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

Back to top

GetText Method

Description

Retrieves the text of the object.

Syntax

object.GetText

Return Type

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

HorizontalScroll Percent

Description

Specifies the amount of horizontal scroll percent.

Syntax

object.HorizontalScrollPercent

Return Type

An integer indicating the percent.

IMPORTANT

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

Back to top

HorizontallyScrollable Property

Description

Specfies whether an object is scrollable in the horizontal direction.

Syntax

object.HorizontallyScroolable

Return Type

A string indicating if the object is scrollable or not.

IMPORTANT

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

Back to top

HorizontalViewSize Property

Description

Specifies the amount of viewable space horizon

Syntax

object.HorizontalViewSize

Return Type

An integer specifying the amount of viewable size horizontally.

IMPORTANT

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

Back to top

Increment Method

Description

Raises the value of the item in the specified object by one step.

Syntax

object.Increment

Return Type

None

IMPORTANT

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

Back to top

IsExpanded Property

Description

Indicates whether an object is expanded or not.

Syntax

object.IsExpanded

Return Type

A string indicating whether the object is expanded

IMPORTANT

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

Back to top

IsMaximized Property

Description

Indicates whether the object is maximized at present.

Syntax

object.IsMaximized

Return Type

A string indicating if the object is maximized.

IMPORTANT

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

Back to top

IsMinimized Property

Description

Indicates whether the object is minimized at present.

Syntax

object.IsMinimized

Return Type

A string indicating whether the object is minimized.

IMPORTANT

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

Back to top

IsReadOnly Property

Description

Indicates whether the object is readonly or not.

Syntax

object.IsReadOnly

Return Type

A string indicating if the object is read-only.

IMPORTANT

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

Back to top

IsReadyForInteraction Property

Description

Indicates whether the object is ready for use.

Syntax

object.IsReadyForInteraction

Return Type

A string indicating whether the object is ready.

IMPORTANT

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

Back to top

IsSelected Property

Description

Indicates whether an object is selected or not.

Syntax

object.IsSelected

Return Type

A string indicating if the object is selected or not..

IMPORTANT

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

Back to top

Maximize Method

Description

Enlarges the object to its maximum size.

Syntax

object.Maximize

Return Type

None

IMPORTANT

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

Example

Back to top

LargeChange Property

Description

Indicates whether the change was a large change or not.

Syntax

object.LargeChange

Return Type

A string indicating if the change was large

IMPORTANT

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

Back to top

Maximum Property

Description

The maximum value of the object

Syntax

object.Maximum

Return Type

A string containing the maximum value.

IMPORTANT

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

Back to top

Minimum Property

Description

The minimum value of the object.

Syntax

object.Minimum

Return Type

A string containing the minimum value.

IMPORTANT

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

Back to top

Minimize Method

Description

Minimizes the object.

Syntax

object.Minimize

Return Type

None

IMPORTANT

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

Example

Back to top

Move Method

Description

Moves the object.

Syntax

object.Move x, y

Arguments

ParameterDescription
x

Required. A variant.

The x-coordinate to which to move the object.

y

Required. A variant.

The y-coordinate to which to move the object.

Return Type

None

IMPORTANT

  • This method is available only if you implement the Transform pattern in an object in your application.
  • An object cannot be moved so that its resulting screen location would be completely outside the coordinates of its container and inaccessible to keyboard or mouse.

Example

Back to top

ReadOnly Property

Description

Indicates whether the object is readonly or not.

Syntax

object.ReadOnly

Return Type

A string indicating if the object is read-only.

IMPORTANT

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

Back to top

RemoveFromSelection Method (Selection Pattern)

Description

Removes an item from the set of selected items.

Syntax

object.RemoveFromSelection Item

Arguments

ParameterDescription
Item

Required. A string

The item for which to clear a selection.

Return Type

None

IMPORTANT

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

Back to top

RemoveFromSelection Method (SelectionItem Pattern)

Description

Removes an item from the set of selected items.

Syntax

object.RemoveFromSelection Item

Arguments

ParameterDescription
Item

Required. A string

The item for which to clear a selection.

Return Type

None

IMPORTANT

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

Back to top

RemoveCellFromSelection Method

Description

Removes a selected cell from the list of selected cell (while keeping other cells selected).

Syntax

object.RemoveCellFromSelection rowIdx, colIdx

Arguments

ParameterDescription
rowIdx

Required. An integer.

The row in which the cell to remove is located.

colIdx

Required. A variant.

The column to select. You can specify the column name or the index of the column.

Note: Using the column name for this argument is supported only if the Table pattern is implemented for the control.

Return Type

None

IMPORTANT

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

Back to top

RemoveRowFromSelection Method

Description

Removes a row from the list of selected rows(while keeping other rows selected).

Syntax

object.RemoveRowFromSelection rowIdx

Arguments

ParameterDescription
rowIdx

Required. An integer.

The row in which the cell to remove is located.

Return Type

None

IMPORTANT

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

Back to top

Resize Method

Description

Resizes the object.

Syntax

object.Resize width, height

Arguments

ParameterDescription
width

Required. An integer.

The width to which to resize the object, in pixels.

height

Required. An integer.

The height to which to resize the object, in pixels.

Return Type

None

IMPORTANT

  • This method is available only if you implement the Transform pattern in an object in your application.
  • An object cannot be resized or rotated so that its resulting screen location would be completely outside the coordinates of its container and inaccessible to keyboard or mouse.

Example

Back to top

Restore Method

Description

Displays the object in its previous position.

Syntax

object.Restore

Return Type

None

IMPORTANT

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

Example

Back to top

Rotate Method

Description

Rotates the object.

Syntax

object.Rotate degrees

Arguments

ParameterDescription
degrees

Required. An integer.

The number of degrees to which to rotate the object. A positive number rotates clockwise; a negative number rotates counterclockwise.

Return Type

None

IMPORTANT

  • This method is available only if you implement the Transform pattern in an object in your application.
  • An object cannot be rotated so that its resulting screen location would be completely outside the coordinates of its container and inaccessible to keyboard or mouse.

Back to top

RowHeaders Property

Description

Returns a list of all row headers in the object.

Syntax

object.RowHeaders

Return Type

A string containing all the headers in the object, separated by semicolons (;)

IMPORTANT

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

Back to top

RowOrColumnMajor Property

Description

Indicates whether the data in the object should be read primarily by row or column.

Syntax

object.RowOrColumnMajor

Return Type

A string indicating which way to read the data.

IMPORTANT

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

Back to top

Scroll Method

Description

Scrolls the item in the specified direction for the given distance.

Syntax

object.Scroll horiztonalAmount, [verticalAmount]

Arguments

ParameterDescription
horizontalAmount

Required. An integer.

The horizontal distance to scroll the object. You can supply one of the following values:

  • 0 = move the scroll bar left in large amounts
  • 1 = scroll the scroll bar left in small amounts
  • 2 = no scroll
  • 3 = move the scroll bar right in large amounts
  • 4 = move the scroll bar right in small amounts
verticalAmount

Optional. An integer.

The vertical distance to scroll the object. You can supply one of the following values:

  • 0 = scroll right in large amounts
  • 1 = scroll upwards in small amounts
  • 2 = no scroll
  • 3 = scroll downwards in large amounts
  • 4 = scroll downwards in small amounts

Return Type

None

IMPORTANT

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

Back to top

ScrollDown Method

Description

Scrolls the item downward.

Syntax

object.ScrollDown

Return Type

None

IMPORTANT

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

Back to top

ScrollLeft Method

Description

Scrolls the item left.

Syntax

object.ScrollLeft

Return Type

None

IMPORTANT

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

Back to top

ScrollRight Method

Description

Scrolls the object right.

Syntax

object.ScrollRight

Return Type

None

IMPORTANT

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

Back to top

ScrollUp Method

Description

Scrolls the object upwards.

Syntax

object.ScrollUp

Return Type

None

IMPORTANT

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

Back to top

ScrollIntoView Method

Description

Scrolls the specified object to be visible.

Syntax

object.ScrollIntoView

Return Type

None

IMPORTANT

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

Back to top

Select Method

Description

Selects one item from the object.

Syntax

object.Select Item

Arguments

ParameterDescription
Item

Required. A variant

The item to select.

Return Type

None

IMPORTANT

  • This method is available only if you implement the Selection or SelectionItem pattern in an object in your application.
  • If the current element is not selected, this method clears any selected items and then selects the current element. If the current element is already selected, this method does nothing.

Back to top

SelectCell Method

Description

Selects a specific cell in the object.

Syntax

object.SelectCell rowIdx, colIdx

Arguments

ParameterDescription
rowIdx

Required. A integer.

The row to select.

colIdx

Required. A variant.

The column to select. You can specify the column name or the index of the column.

Note: Using the column name for this argument is supported only if the Table pattern is implemented for the control.

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 rowIdx

Arguments

ParameterDescription
rowIdx

Required. A 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

Set Method

Description

Sets the state of the object.

Syntax

object.Set State

Arguments

ParameterDescription
state

Required. A variant

The state of the object. The value can be a string or a numeric value:

  • On
  • Off
  • Indeterminate
  • 0 (Off)
  • 1 (On)
  • 2 (Indeterminate)

Return Type

None

IMPORTANT

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

Example

Back to top

SetValue Method

Description

Sets the value of the object.

Syntax

object.SetValue Value

Arguments

ParameterDescription
state

Required. A string

The state to set in the object.

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 control.

Syntax

object.SetScrollPercent horizontalPercent, verticalPercent

Arguments

ParameterDescription
horizontalPercent

Required. An integer.

The percent by which to scroll the object horizontally.

verticalPercent

Required. An integer.

The percent by which to scroll the object vertically.

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

SetValue Method

Description

Sets the value of the control.

Syntax

object.SetValue Value

Arguments

ParameterDescription
value

Required. A string..

The value to set in the object.

Return Type

None

Back to top

SmallChange Property

Description

Indicates whether a change is a small change or not.

Syntax

object.SmallChange

Return Type

A string indicating if the change was small.

IMPORTANT

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

Back to top

State Property

Description

Returns the toggle state of the object.

Syntax

object.State

Return Type

A string indicating the toggle state of the object.

Possible values:

  • Off
  • On
  • Indeterminate

IMPORTANT

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

Back to top

Text Property

Description

The text in the object.

Syntax

object.Text

Return Type

A string containing the object's text.

IMPORTANT

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

Back to top

Value Property

Description

The value of the object.

Syntax

object.Value

Return Type

A string containing the object's value.

IMPORTANT

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

Back to top

VerticalScrollPercent Property

Description

Specifies the amount of vertical scroll percent

Syntax

object.VerticalScrollPercent

Return Type

A integer indicating the amount of vertical scroll percent

IMPORTANT

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

Back to top

VerticallyScrollable Property

Description

Indicates whether the object is scrollable in the vertical direction

Syntax

object.VerticallyScrollable

Return Type

A string indicating if you can scroll the object vertically or not.

IMPORTANT

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

Back to top

VerticalViewSize Property

Description

Specifies the amount of viewable space vertically.

Syntax

object.VerticalViewSize

Return Type

An integer indicating the amount of viewable size vertically.

IMPORTANT

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

See also: