ScrollToItem Method (Specific to iOS TableView Controls)

Applies to TestComplete 15.46, last modified on January 09, 2023
This method is available in legacy mobile tests that work with devices connected to the local computer. To learn how to simulate user actions in newer cloud-compatible mobile tests, see the Simulating user actions in tests section.

Description

The ScrollToItem action scrolls to the item specified by its section and item properties.

Declaration

TestObj.ScrollToItem(Section, Item)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Section [in]    Required    Variant    
Item [in]    Required    Variant    
Result Object

Applies To

The method is applied to the following object:

View Mode

This method is available in the Object Browser panel and in other panels and dialogs in both Basic and Advanced view modes.

Parameters

The method has the following parameters:

Section

Specifies the section of the desired item. You can enter the section’s index (from 0) or its caption. The caption can contain asterisk (*) or question mark (?) wildcards or regular expressions. The asterisk (*) corresponds to a string of any length (including an empty string), the question mark corresponds to any single character (including none). To specify more complicated parts of a caption, use regular expressions.

The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting.

Item

Specifies the desired item. You can enter the item’s index (from 0) or its caption. The caption can contain asterisk (*) or question mark (?) wildcards or regular expressions. The asterisk (*) corresponds to a string of any length (including an empty string), the question mark corresponds to any single character (including none). To specify more complicated parts of a caption, use regular expressions.

The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting.

Result Value

Contains the reference to the item's object.

Example

This example script gets the slider from the table view and posts its position to the log.

JavaScript, JScript

function Test()
{
  // Select the mobile device
  Mobile.SetCurrent("iPhone");
  // Obtain the TableView object
  var p = Mobile.Device().Process("SampleApp");
  var tableview = p.Window().TableView();
  
  // Get the reference to the item
  var ItemObj = tableview.ScrollToItem(1, 0);
  
  // Post the position of the slider to the log
  Log.Message(ItemObj.Slider().wPosition);
}

Python

def Test():
  # Select the mobile device
  Mobile.SetCurrent("iPhone")
  # Obtain the TableView object 
  p = Mobile.Device().Process("SampleApp")
  tableview = p.Window().TableView()
  
  # Get the reference to the item
  ItemObj = tableview.ScrollToItem(1, 0)
  
  # Post the position of the slider to the log
  Log.Message(ItemObj.Slider().wPosition)

VBScript

Sub Test()
  Dim p, tableview, ItemObj
  ' Select the mobile device
  Mobile.SetCurrent("iPhone")
  ' Obtain the TableView object
  Set p = Mobile.Device.Process("SampleApp")
  Set tableview = p.Window().TableView()
  
  ' Get the reference to the item
  ItemObj = tableview.ScrollToItem(1, 0)
  
  ' Post the position of the slider to the log
  Log.Message(ItemObj.Slider().wPosition)
End Sub

DelphiScript

procedure Test();
var
  p, tableview, ItemObj;
begin
  // Select the mobile device
  Mobile.SetCurrent('iPhone');
  // Obtain the tableview object
  p := Mobile.Device.Process('SampleApp');
  tableview := p.Window(0).TableView(0);
  
  // Get the reference to the item
  ItemObj := tableview.ScrollToItem(1, 0);
  
  // Post the position of the slider to the log
  Log.Message(ItemObj.Slider().wPosition);
end;

C++Script, C#Script

function Test()
{
  // Select the mobile device
  Mobile["SetCurrent"]("iPhone");
  // Obtain the TableView object
  var p = Mobile["Device"].Process("SampleApp");
  var tableview = p["Window"]()["TableView"]();
  
  // Get the reference to the item
  var ItemObj = tableview["ScrollToItem"](1, 0);
  
  // Post the position of the slider to the log
  Log["Message"](ItemObj["Slider"]()["wPosition"]);
}

See Also

Working With Objects in Table View Items
Testing iOS Applications (Legacy)

Highlight search results