UIACheckBox Object

Description

A checkbox object in an application that supports UIAutomation.

IMPORTANT

The UIACheckBox is based on controls with Control Type UIA_CheckBoxControlTypeId = 50002

Operations

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

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

Activate	Double-clicks the object to activate it.
CaptureBitmap	Saves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Check	Checks whether the actual value of an item matches the expected value.
CheckProperty	Checks whether the specified object property achieves the specified value within the specified timeout.
ChildObjects	Returns the collection of child objects contained within the object.
Click	Clicks the object.
Drag	Performs the 'drag' part of a drag and drop operation.
Drop	Performs the 'drop' part of a drag and drop operation.
GetAllROProperties	Returns the collection of properties and current values from the object in the application.
GetROProperty	Returns the current value of the specified description property from the object in the application.
GetTOProperties	Returns the collection of properties and values used to identify the object.
GetTOProperty	Returns the value of the specified description property from the test object description.
GetVisibleText	Returns the text from the specified area.
Output	Retrieves the current value of an item and stores it in a specified location.
RefreshObject	Instructs UFT One to re-identify the object in the application the next time a step refers to this object.
SetFocus	Activates the selected object and brings it into focus.
SetTOProperty	Sets the value of the specified description property in the test object description.
ToString	Returns a string that represents the current test object.
Type	Simulates keyboard input on the object.
WaitProperty	Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Exist	Checks whether the object currently exists in the open application.
Object	Accesses the native methods and properties of the object.

UIAutomation Pattern-Based Methods and Properties

Method	Supported Pattern (A-Z)	Description
CanExpand	ExpandCollapse	Indicates whether an object can expand or not.
Collapse	ExpandCollapse	Collapses the specified item.
Expand	ExpandCollapse	Expands the selected item.
IsExpanded	ExpandCollapse	Indicates whether an object is expanded or not.
ActivateCell	Grid	Makes a selected cell active by clicking in it.
AddCellToSelection	Grid	Selects a cell in addition to previously selected cells.
AddRowToSelection	Grid	Selects a row and adds it to previously selected rows.
ClickCell	Grid	Clicks a specific cell in the object.
ClickItem	Invoke	Clicks the specified date in the object.
ClickRow	Grid	Clicks a specific row in the object.
GetCellName	Grid	Returns the value of the name property for the specified cell.
GetCellValue	Grid	Returns the value of the value property for the specified cell.
GetRows	Grid	Returns a list of all the rows in the object.
RemoveCellFromSelection	Grid	Removes a selected cell from the list of selected cell (while keeping other cells selected).
RemoveRowFromSelection	Grid	Removes a row from the list of selected rows(while keeping other rows selected).
SelectRow	Grid	Selects a row in the table.
Click	Invoke	Clicks a clickable point in the application.
CanDecrement	RangeValue	Indicates whether the current value is the minimum.
CanIncrement	RangeValue	Indicates whether the current value is the maximum.
Decrement	RangeValue	Lowers the value of the item in the specified object by one step.
Increment	RangeValue	Raises the value of the item in the specified object by one step.
IsReadOnly	RangeValue	Indicates whether the object is read-only.
LargeChange	RangeValue	Indicates whether the change was a large change or not.
Maximum	RangeValue	Indicates the maximum value of the object.
Minimum	RangeValue	Indicates the minimum value of the object.
SmallChange	RangeValue	Indicates whether the change was a small change or not.
SetValue	RangeValue	Sets the value of the object.
Value	RangeValue	The value of the object.
HorizontalScrollPercent	Scroll	Specifies the amount of horizontal scroll percent.
HorizontallyScrollable	Scroll	Specifies whether the object is scrollable in the horizontal direction.
HorizontalViewSize	Scroll	Specifies the amount of viewable space horizontally.
Scroll	Scroll	Scrolls the item in the specified direction for the given distance.
ScrollDown	Scroll	Scrolls the item downward.
ScrollRight	Scroll	Scrolls the object right.
ScrollUp	Scroll	Scrolls the object upwards.
ScrollLeft	Scroll	Scrolls the item left.
SetScrollPercent	Scroll	Sets the percentage by which you should scroll the object.
VerticalScrollPercent	Scroll	Specifies the amount of vertical scroll percent.
VerticallyScrollable	Scroll	Specifies whether the object is scrollable in the vertical direction.
VerticalViewSize	Scroll	Specifies the amount of viewable space vertically.
ScrollIntoView	ScrollItem	Scrolls the specified object to be visible.
AddToSelection	Selection	Adds the selected item to the group of previously selected set of items.
GetSelection	Selection	Returns the collection of selected items.
RemoveFromSelection	Selection	Removes an item from the set of selected items.
Select	Selection	Selects one item from the object.
AddToSelection	SelectionItem	Selects a cell in addition to previously selected cells.
IsSelected	SelectionItem	Indicates whether an object is selected or not.
RemoveFromSelection	SelectionItem	Removes an item from the set of selected items.
Select	SelectionItem	Selects one item from the object.
ColumnHeaders	Table	Returns a list of all column headers in the object.
GetColumnHeaders	Table	Returns a list of all the column headers in the object.
GetRowHeaders	Table	Returns a list of all the row headers in the object.
RowHeaders	Table	Returns a list of all row headers in the object.
RowOrColumnMajor	Table	Indicates whether the data in the object should be read primarily by row or column.
GetColumnHeaderItems	TableItem	Returns a list of all the column headers in the object.
GetRowHeaderItems	TableItem	Returns a list of all the row headers in the object.
GetText	Text	Retrieves the text of the object.
Text	Text	The text in the object.
Set	Toggle	Sets the state of the object.
State	Toggle	Returns the toggle state of the object.
Move	Transform	Moves the object.
Resize	Transform	Resizes the object.
Rotate	Transform	Rotates the object.
IsReadOnly	Value	Indicates if the object is read-only or not.
SetValue	Value	Sets the value of the control.
SetSecure	Value	Sets the encoded value of the control.
Value	Value	The value of the object.
Close	Window	Closes the object.
IsMaximized	Window	Indicates whether the object is maximized at present.
IsMinimized	Window	Indicates whether the object is minimized at present.
IsReadyForInteraction	Window	Indicates whether the object is ready for use.
Maximize	Window	Enlarges the object to its maximum size.
Minimize	Window	Minimizes the object.
Restore	Window	Displays 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

Return Type

None

Back to top

Click Method

Description

Clicks the object.

Syntax

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

Arguments

Return Type

None

Example

Click Objects in the Application

'The following example clicks different objects.

UIAWindow("Telerik UI for WinForms").UIAObject("radRibbonBar1").UIAButton("Button").Click
wait 1
UIAWindow("Telerik UI for WinForms").UIAObject("radRibbonBar1").Click 150, 40, 1
Wait 1
UIAWindow("Telerik UI for WinForms").UIAObject("radRibbonBar1").Click 150, 40, "L"
wait 1

Click on a Tree Item Added to an Object

'The following example clicks on a list item added to a UIAObject.

UIAWindow("Telerik UI for WinForms").UIAList("radCheckedListBox1").UIAObject("<html><span style='font-size:1").Click

Back to top

Drag Method

Description

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

Syntax

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

Arguments

Return Type

None

Examples

Drag and Drop an Object

'The following example drags and drops an object in the application.

UIAWindow("MainWindow").UIATab("leftTab").UIAObject("Left Tab 3").Drag
UIAWindow("MainWindow").UIATab("rightTab").UIAObject("Right Tab 6").Drop
UIAWindow("MainWindow").UIATab("rightTab").UIAObject("Left Tab 3").Drag
UIAWindow("MainWindow").UIATab("leftTab").UIAObject("Left Tab 6").Drop

Drag and Drop an Object with Relative Coordinates

'The following example drags and drops an object in the application.

UIAWindow("MainWindow").UIATab("leftTab").Drag 15,15
UIAWindow("MainWindow").UIATab("rightTab").Drop 120, 150

Back to top

Drop Method

Description

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

Syntax

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

Arguments

Return Type

None

Examples

Drag and Drop an Object

'The following example drags and drops an object in the application.

UIAWindow("MainWindow").UIATab("leftTab").UIAObject("Left Tab 3").Drag
UIAWindow("MainWindow").UIATab("rightTab").UIAObject("Right Tab 6").Drop
UIAWindow("MainWindow").UIATab("rightTab").UIAObject("Left Tab 3").Drag
UIAWindow("MainWindow").UIATab("leftTab").UIAObject("Left Tab 6").Drop

Drag and Drop an Object with Relative Coordinates

'The following example drags and drops an object in the application.

UIAWindow("MainWindow").UIATab("leftTab").Drag 15,15
UIAWindow("MainWindow").UIATab("rightTab").Drop 120, 150

Back to top

GetVisibleText Method

Description

Returns the text from the specified area.

Syntax

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

Arguments

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

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

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

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

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

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

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

Return Type

None

IMPORTANT

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

Example

Select Additional Items Individually

'The following example selects additional items in the application one by one..

UIAWindow("Telerik UI for WinForms").UIAList("radCheckedListBox1").AddToSelection "Item 1"

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 ExpandCollapse 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], [button]

Arguments

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

Return Type

None

Example

Click a specified calendar item.

'The following example clicks the July 29th 2016 date in the calendar object.

UIAWindow("ControlTemplate Examples").UIACalendar("Calendar").ClickItem "2016-07-29"

Back to top

ClickRow Method

Description

Clicks a specific row in the object.

Syntax

object.ClickRow rowIdx, [x], [y], [button]

Arguments

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

Return Type

None

IMPORTANT

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

Example

Click an Object

'The following example clicks on an object.

UIAWindow("Telerik UI for WinForms").UIAObject("radRibbonBar1").UIAButton("Button").Click
wait 1
UIAWindow("Telerik UI for WinForms").UIAObject("radRibbonBar1").Click 150, 40, 1
Wait 1
UIAWindow("Telerik UI for WinForms").UIAObject("radRibbonBar1").Click 150, 40, "L"
wait 1
UIAWindow("Telerik UI for WinForms").UIAObject("radRibbonBar1").UIAButton("Button").Object.Invoke

Back to top

Collapse Method

Description

Collapses the specified item.

Syntax

object.Collapse Item

Arguments

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

Expand and Collapse a Tree Node

'The following example expands a node.

UIAWindow("ControlTemplate Examples").UIATree("TreeView").Collapse(0)
wait 1
UIAWindow("ControlTemplate Examples").UIATree("TreeView").Expand "Top One;Sub Four"
wait 1
UIAWindow("ControlTemplate Examples").UIATree("TreeView").Collapse "Top Two"

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

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

Expand and Collapse a Tree Node

'The following example expands a node.

UIAWindow("ControlTemplate Examples").UIATree("TreeView").Collapse(0)
wait 1
UIAWindow("ControlTemplate Examples").UIATree("TreeView").Expand "Top One;Sub Four"
wait 1
UIAWindow("ControlTemplate Examples").UIATree("TreeView").Collapse "Top Two"

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.

Retrieve the List of Selected Items

'The following example selects the list of selected items and clicks on one.

Set objsSelected = UIAWindow("Telerik UI for WinForms").UIAList("radCheckedListBox1").GetSelection()
print objsSelected.count
objsSelected(0).Click

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

Specifies 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 ExpandCollapse 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 RangeValue or 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

Maximize a Window object

'The following example expands an UIAWindow object to its maximum size.

UIAWindow("JavaFx AUT").Maximize()

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

Minimize a Window object

'The following example minimizes an UIAWindow object.

UIAWindow("JavaFx AUT").Minimize()

Back to top

Move Method

Description

Moves the object.

Syntax

object.Move x, y

Arguments

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

Move an Object

'The following example moves the object to a specified point.

UIAWindow("JavaFx AUT").Move 150, 50

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

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

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

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

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

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

Resize an Object

'The following example resizes an object.

UIAWindow("JavaFx AUT").Resize 100, 200

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

Restore a Window object

'The following example restores an UIAWindow object to its original size.

UIAWindow("JavaFx AUT").Restore()

Back to top

Rotate Method

Description

Rotates the object.

Syntax

object.Rotate degrees

Arguments

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

Return Type

None

IMPORTANT

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

Scroll an Item

'The following example scrolls an object, in the downward direction.

UIAWindow("JavaFx AUT").UIATab("JavaFX8").UIAList("JavaFX50").Scroll 0,3

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.

Scroll an Object Downward

'The following example scrolls an object in the downward direction.

UIAWindow("JavaFx AUT").UIATab("JavaFX8").UIAList("JavaFX50").ScrollDown

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.

Scroll an Object Upward

'The following example scrolls an object in the upward direction.

UIAWindow("JavaFx AUT").UIATab("JavaFX8").UIAList("JavaFX50").ScrollUp

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

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.

Select an Item from a List

'The following example selects an item from a list object.

UIAWindow("Telerik UI for WinForms").UIAList("radCheckedListBox1").Select 0

Back to top

SelectCell Method

Description

Selects a specific cell in the object.

Syntax

object.SelectCell rowIdx, colIdx

Arguments

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

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

Return Type

None

IMPORTANT

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

Example

Set the Value of a Toggle Button

'The following example sets the state of a checkbox.

UIAWindow("Qt Quick Controls Gallery").UIACheckBox("E-mail").Set 0 
wait 1
UIAWindow("WPF Controls Examples").UIACheckBox("Example").Set "on"
wait 1

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

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.

Set the Percent to Scroll an Object

'The following example sets the percentage by which to scroll an object.

UIAWindow("JavaFx AUT").UIATab("JavaFX8").UIAList("JavaFX50").SetScrollPercent 0, 50

Back to top

SetSecure Method

Description

Sets the encoded value of the object.

Syntax

object.SetSecure Value

Arguments

Return Type

None

IMPORTANT

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

• To find the encoded value to use as the argument for the this method, do one of the following: 

  • Use the Password Encoder utility (available from the Windows Start menu).

  • Parameterize the argument using a Data Table parameter and use the Data Table encryption option (right-click each unencrypted value in the password column and choose Data > Encrypt).

  For more information, refer to the UFT One User Guide.

• While the SetSecure method enables you to hide passwords on the screen when running a test, it is not intended to be a secure way to protect password information.

Back to top

SetValue Method

Description

Sets the value of the control.

Syntax

object.SetValue Value

Arguments

Return Type

None

Important

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

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:

• UIAButton
• UIACalendar
• UIACheckBox
• UIAComboBox
• UIAEdit
• UIAHyperLink
• UIAList
• UIAMenu
• UIAObject
• UIARadioButton
• UIASlider
• UIASplitButton
• UIATab
• UIATable
• UIATree
• UIAWindow