Object Model Reference for GUI Testing > SAPUI5 > ChildItem Method

SAPUITable Object

Description

An SAPUI5 table control.

IMPORTANT

The SAPUITable test object class extends the WebTable test object class and inherits many of its operations and description properties.

Operations

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

Note: You can also view a list and descriptions of the SAPUITable 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 Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the specified object property achieves the specified value within the specified timeout.
Method ChildItem Returns the value of the item specified by the index.
Method ChildItemCount Returns the number of objects of a specific type in the specified cell.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks the object.
Method ColumnCount Returns the number of columns in the table.
Method DeleteRow Deletes the specified row in the table.
Method DeselectAll Deselects all rows in the table.
Method DeselectRow Clears the selection of the specified row.
Method DoubleClick Clicks on the object twice.
Method Drag Performs the 'drag' part of a drag and drop operation.
Method Drop Performs the 'drop' part of a drag and drop operation.
Method ExtendDeselectRow Clears the selection of the specified row only.
Method ExtendSelectRow Selects the specified row in the table in addition to any rows already selected.
Method FindRowByCellContent Retrieves the number of the first row containing the specified data in the specified column.
Method FireEvent Triggers an event.
Method FirstPage Scrolls the table to the first page.
Method GetCellData Retrieves the contents of the specified cell.
Method GetColumnName Retrieves the name of the column with the specified index.
Common Method GetROProperty Returns the current value of the specified description properties from the object in the application.
Method GetRowWithCellText Returns the number of the first row found that contains a cell with the specified text.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method HeaderClick Clicks the header of the specified column.
Method HoverTap When hover is supported, places the pointer on the object. Otherwise, taps the object.
Method LastPage Scrolls the table to the last page.
Method LongPress Presses and holds the object.
Method MiddleClick Middle-clicks the object.
Method More Clicks the More button in the expandable table.
Method MoveColumn Moves the specified column to the specified new position.
Method Navigate Navigate to the specified row.
Method NextPage Scrolls the table to the next page.
Method OpenMenu Clicks the column header to open the associated menu.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method Pan Perform a pan gesture.
Method Pinch Perform a pinch gesture.
Method PreviousPage Scrolls the table to the previous page.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method ResizeColumn Resize the specified column to the specified width.
Method RightClick Right-clicks the object.
Method RowCount Returns the number of rows in the table.
Method SelectAll Selects all of the rows in the table.
Method SelectCell Selects the specified cell in the table.
Method SelectItemInCell Selects the specified item in the specified cell.
Method SelectRow Selects the specified row in the table.
Method SetCellData Sets the contents of a cell to the specified value.
Method SetPage Scrolls the table to the specified page.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method Submit Submits a form.
Method Swipe Swipes the object.
Common Method ToString Returns a string that represents the current test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Property CurrentPage Retrieves the number of the currently selected page.
Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.

 

Back to top

ChildItem Method

Description

Returns the value of the item specified by the index.

Syntax

object.ChildItem Row, Column, MicClass, Index

Arguments

Parameter Description
Row Required. An integer value.
The row number where the cell is located. The first row in the table is 1.
Column Required. An integer value.

The column number where the cell is located. The first column in the table is 1.

MicClass Required. A String value.
The test object class.
Index Required. A String value.
Index of the object of the specified MicClass in the cell. It is used to specify the desired element when there is more than one object of type TO_Class in the cell. The first object has an index of 0.

Return Type

None

Example


 

Back to top

ChildItemCount Method

Description

Returns the number of objects of a specific type in the specified cell.

Syntax

object.ChildItemCount (Row, Column, MicClass)

Arguments

Parameter Description
Row Required. An integer value.
The row number where the cell is located. The first row in the table is 1.
Column Required. An integer value.
The column number where the cell is located. The first column in the table is 1.s
MicClass Required. A String value.
The test object class.

Return Type

An integer value.

Example


 

Back to top

Click Method

Description

Clicks the object.

Syntax

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

Arguments

Parameter Description
x Optional. An integer value.
The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
y Optional. An integer value.

The y-coordinate of the click. Note that the specified coordinates are relatie to the upper left corner of the object. The default value is the center of the object.

Tip: You can enter MicNoCoordinate for the x and y argument values if you want to enter a value for the button argument without specifying x- and y-coordinates for the click.


Default value = 0
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

IMPORTANT

Example


 

Back to top

ColumnCount Method

Description

Returns the number of columns in the table.

Syntax

object.ColumnCount (Row)

Arguments

Parameter Description
Row Required. An integer value.
The row number for which you want to retrieve the column count. The first row in the table is 1.

Return Type

An integer value.

Example


 

Back to top

DeleteRow Method

Description

Deletes the specified row in the table.

Syntax

object.DeleteRow (Row)

Arguments

Parameter Description
Row Required. An integer value.
The row to delete. The first row in the table is numbered 1.

Return Type

A Boolean value.


 

Back to top

DeselectAll Method

Description

Deselects all rows in the table.

Syntax

object.DeselectAll

Return Type

None

Example


 

Back to top

DeselectRow Method

Description

Clears the selection of the specified row.

Syntax

object.DeselectRow (Row)

Arguments

Parameter Description
Row Required. An integer value.
The index of the row to deselect. Index values begin with 1.

Return Type

A Boolean value.

Example


 

Back to top

DoubleClick Method

Description

Clicks on the object twice.

Syntax

object.DoubleClick [interval], [x], [y]

Arguments

Parameter Description
interval

Optional. A Variant.

The number of seconds between the two clicks. The default value is 0.2 seconds.


x Optional. An integer value.
The x-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = 0
y Optional. An integer value.
The y-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.


 

Back to top

Drag Method

Description

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

Syntax

object.Drag [x], [y], [BUTTON], [Modifier]

Arguments

Parameter Description
x Optional. An integer value.
The x-coordinate within the source object.
Default value = 0
y Optional. An integer value.
The y-coordinate within the source object.
Default value = 0
BUTTON Optional. A predefined constant or number.
The mouse button used to drag the object.
Default value = micLeftBtn
Modifier Optional. A String value.

The keyboard modifier that is pressed during the Drag operation.

Possible values:

  • micAlt
  • micCtrl
  • micShift

Return Type

None

IMPORTANT

Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur in the run session.

UFT supports the following scenarios:

General Note:

UFT alsways runs Drag and Drop steps using the mouse API, even if you defined the Replay type as Event in the Run settings section of the Web > Advanced pane (Tools > Options > GUI Testing tab > Web pane > Advanced node).

Notes for Scenario A:

  • When recording: You cannot record crossobject or cross-frame types of drag and drop oeprations (operations in which you try to drop an object on another object or in aother frame). You can, however, insert these types of Drop steps manually. Note that it may be helfup to record a drag and drop operation on the object in order to determine valid coordinates for the Drag operation step. You will need to delete the recorded Drop step, though, and manually add a new Drop step for the target object instead.
  • When running: If the application being tested supports scrolling, then UFT supports scroplling when the Drag and Drop test objects are both located in the same frame. UFT drags the Drag object to the edge of the frame, waits for the Drop object to appear, and drops the Drag object onto the Drop object. If the application being tested does not support scrolling, then UFT displays an error message when it reaches a step that requires scrolling.
  • Run session. If you want to drag a test object from one frame to another, UFT tries to make both the Drag and Drop objects visible in their frames prior to performing the Drag and Drop operation. If the two objects cannot be viewed simultaneously (for example, because the browser window is too small), the step will fail.

Notes for Scenario B and Scenario C:

  • If the screen resolution during a run session is not the same as the screen resolution during the recording session, then the size of the frame may be different during the run session as compared to the recording session. In this case, the target location coordinates may be different during the run session, and this may cause the test steps to fail.
  • During a run session, if the coordinates of a Drop step are located outside the visible frame area (for example, because your application changed), then the step may not run accurately. To solve this, fix the specified coordinates, as needed. The test object can be dragged only within the visible area of the frame object. Dragging the object to the edge of a window or frame does not cause the area to scroll (as it does in Scenario A).

Example


 

Back to top

Drop Method

Description

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

Syntax

object.Drop [x], [y]

Arguments

Parameter Description
x Optional. An integer value.
The x-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the x-coordinate is relative to the upper left corner in the source location prior to being dragged.
Default value = 0
y Optional. An integer value.
The y-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the y-coordinate is relative to the upper left corner in the source location prior to being dragged.
Default value = 0

Return Type

None

IMPORTANT

Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes and error to occur. For more information on Drag and Drop operations, see Drag Method.

Example


 

Back to top

ExtendDeselectRow Method

Description

Clears the selection of the specified row only.

Syntax

object.ExtendDeselectRow (Row)

Arguments

ParameterDescription
Row Required. An integer value.

The index of the row to deselect. Index values begin with 1.

Return Type

A Boolean value.

IMPORTANT

This method is relevant only for table controls that support selecting multiple rows.

Example


 

Back to top

ExtendSelectRow Method

Description

Selects the specified row in the table in addition to any rows already selected.

Syntax

object.ExtendSelectRow (Row)

Arguments

ParameterDescription
Row Required. An integer value.

The index of the row to select in addition to any selected rows. Index values begin with 1.

Return Type

A Boolean value.

IMPORTANT

This method is relevant only for table controls that support selecting multiple rows.

Example


 

Back to top

FindRowByCellContent Method

Description

Retrieves the number of the first row containing the specified data in the specified column.

Syntax

object.FindRowByCellContent (Column, Text, [StartFromRow])

Arguments

ParameterDescription
Column Required. A Variant.
The column name (with quotes) or number (without quotes) in which to search for the specified string.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.
Text Required. A String value.
The string for which to search.
StartFromRow Optional. An integer value.
The row in which to begin the search.
Default value = 1
Default value = 0

Return Type

An integer value.

If no content matches the specified text, the return value is -1.

IMPORTANT

This method searches for the specified text only in visible rows. If you specify the StartFromRow parameter, this row will be set to visible before searching.

Example


 

Back to top

FireEvent Method

Description

Triggers an event.

Syntax

object.FireEvent EventName, [x], [y], [BUTTON]

Arguments

ParameterDescription
EventName Required. A String value.

The name of the event to trigger. Available events: onchange, onclick, ondblclick, onblur, onfocus, onmousedown, onmouseup, onmouseover, onmouseout, onsubmit, onreset, onpropertychange.

x Optional. An integer value.
The x-coordinate, relative to the upper left corner of the object.
Default value = 0
y Optional. An integer value.
The y-coordinate, relative to the upper left corner of the object.
Default value = 0
BUTTON Optional. A predefined constant or number.
The mouse button used to fire the event.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

FirstPage Method

Description

Scrolls the table to the first page.

Syntax

object.FirstPage

Return Type

A Boolean value.

Example


 

Back to top

GetCellData Method

Description

Retrieves the contents of the specified cell.

Syntax

object.GetCellData (Row, Column)

Arguments

ParameterDescription
Row Required. An integer value.
The row number where the cell is located. The first row in the table is 1.
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column in which the cell is located.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

Return Type

A String value.

If the specified cell is not valid, the method returns micCellDoesNotExist.

Example


 

Back to top

GetColumnName Method

Description

Retrieves the name of the column with the specified index.

Syntax

object.GetColumnName (Column)

Arguments

ParameterDescription
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column whose name you want to return.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

Return Type

A String value.

Example


 

Back to top

GetRowWithCellText Method

Description

Returns the number of the first row found that contains a cell with the specified text.

Syntax

object.GetRowWithCellText (Text, [Column], [StartFromRow])

Arguments

ParameterDescription
Text Required. A String value.
The text string for which to search.
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column in which the cell is located.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

StartFromRow Optional. An integer value.
The number of the row in which to start the search. The first row in the table is numbered 1.
Default value = 0

Return Type

An integer value.

If no content matches the specified value, the return value is NULL.

IMPORTANT

This method searches for the specified text only in visible rows. If you specify the StartFromRow parameter, this row will be set to visible before searching.

Example


 

Back to top

HeaderClick Method

Description

Clicks the header of the specified column.

Syntax

object.HeaderClick (Column)

Arguments

ParameterDescription
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column header to click .
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

Return Type

A Boolean value.

IMPORTANT

During a recording session, this method is not recorded. If you click a column header, the OpenMenu method is recorded.

Example


 

Back to top

HoverTap Method

Description

When hover is supported, places the pointer on the object. Otherwise, taps the object.

Syntax

object.HoverTap [x], [y]

Arguments

ParameterDescription
x Optional. An integer value.
The x-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = 0
y Optional. An integer value.
The y-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.


 

Back to top

LastPage Method

Description

Scrolls the table to the last page.

Syntax

object.LastPage

Return Type

A Boolean value.

Example


 

Back to top

LongPress Method

Description

Presses and holds the object.

Syntax

object.LongPress [duration], [x], [y]

Arguments

ParameterDescription
duration Optional. A Variant.

The time period (in seconds) to hold the long tap gesture.

You can specify partial seconds as a duration time.

x Optional. An integer value.
The x-coordinate of the long tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
y Optional. An integer value.
The y-coordinate of the tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

Example


 

Back to top

MiddleClick Method

Description

Middle-clicks the object.

Syntax

object.MiddleClick [x], [y]

Arguments

ParameterDescription
x Optional. An integer value.
The x-coordinate of the middle click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
y Optional. An integer value.
The y-coordinate of the middle click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0

Return Type

None

IMPORTANT

Example


 

Back to top

More Method

Description

Clicks the More button in the expandable table.

Syntax

object.More

Return Type

None


 

Back to top

MoveColumn Method

Description

Moves the specified column to the specified new position.

Syntax

object.MoveColumn (FromColumn, ToColumn)

Arguments

ParameterDescription
FromColumn Required. A Variant.

The name (with quotes) or number (without quotes) of the column to move.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

ToColumn Required. A Variant.

The name (with quotes) or number (without quotes) of the column whose position the moved column will take.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

This column is not overwritten by the moved column. Rather, it moves to the right or the left in the table to make room for the moved column.

Return Type

A Boolean value.

IMPORTANT

This method is not recorded if you move columns during a recording session. You can manually add a step with this method when editing your test or component.

Example


 

Back to top

Navigate Method

Description

Navigate to the specified row.

Syntax

object.Navigate (Index)

Arguments

ParameterDescription
Index Required. An integer value.

Return Type

A Boolean value.


 

Back to top

NextPage Method

Description

Scrolls the table to the next page.

Syntax

object.NextPage

Return Type

A Boolean value.

Example


 

Back to top

OpenMenu Method

Description

Clicks the column header to open the associated menu.

Syntax

object.OpenMenu (Column)

Arguments

ParameterDescription
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column header to click .
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

Return Type

A Boolean value.

Example


 

Back to top

Pan Method

Description

Perform a pan gesture.

Syntax

object.Pan deltaX, deltaY, [duration], [startX], [startY]

Arguments

ParameterDescription
deltaX Required. An integer value.

The distance moved on the x axis, relative to the start point.

deltaY Required. An integer value.

The distance moved on the y axis, relative to the start point.

duration Optional. A Variant.

The number of seconds required to perform the pan gesture.

startX Optional. An integer value.

The x-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object.


Default value = 0
startY Optional. An integer value.

The y-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object.


Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported in Internet Explorer and older versions of FireFox.


 

Back to top

Pinch Method

Description

Perform a pinch gesture.

Syntax

object.Pinch scale, [duration], [x], [y]

Arguments

ParameterDescription
scale Required. A Variant.

The zoom scale resulting from the pinch gesture. This is the ratio between the distance between the fingers at the end of the pinch gesture to the distance between the fingers at the beginning of the pinch gesture.

duration Optional. A Variant.

The number of seconds required to perform the pinch gesture. The default value is 1 second.

x Optional. An integer value.

The x-coordinate of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.


Default value = 0
y Optional. An integer value.

The y-coordinate of of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.


Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported in Internet Explorer and older versions of FireFox.


 

Back to top

PreviousPage Method

Description

Scrolls the table to the previous page.

Syntax

object.PreviousPage

Return Type

A Boolean value.

Example


 

Back to top

ResizeColumn Method

Description

Resize the specified column to the specified width.

Syntax

object.ResizeColumn Column, Width

Arguments

ParameterDescription
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column to resize.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

Width Required. An integer value.
The new column width (in pixels).

Return Type

None

Example


 

Back to top

RightClick Method

Description

Right-clicks the object.

Syntax

object.RightClick [x], [y]

Arguments

ParameterDescription
x Optional. An integer value.
The x-coordinate of the right click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
y Optional. An integer value.
The y-coordinate of the right click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0

Return Type

None

IMPORTANT

Example


 

Back to top

RowCount Method

Description

Returns the number of rows in the table.

Syntax

object.RowCount

Return Type

An integer value.

Example


 

Back to top

SelectAll Method

Description

Selects all of the rows in the table.

Syntax

object.SelectAll

Return Type

None

Example


 

Back to top

SelectCell Method

Description

Selects the specified cell in the table.

Syntax

object.SelectCell Row, Column

Arguments

ParameterDescription
Row Required. An integer value.
The row number. The first row in the table is 1.
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column in which the cell is located.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

Return Type

None

Example


 

Back to top

SelectItemInCell Method

Description

Selects the specified item in the specified cell.

Syntax

object.SelectItemInCell Row, Column, Item

Arguments

ParameterDescription
Row Required. An integer value.
The row number. The first row in the table is 1.
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column in which the cell is located.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

Item Required. A String value.
The index (in quotes) of the item to select in the cell. The first item in the cell is 1.

Return Type

None

IMPORTANT

Use this method, for example, to set the level of a rating control inside a table cell. Select the item that represents the relevant rating level.

Example


 

Back to top

SelectRow Method

Description

Selects the specified row in the table.

Syntax

object.SelectRow (Row)

Arguments

ParameterDescription
Row Required. An integer value.

The numeric index of the row you want to select. Index values begin with 1.

Return Type

A Boolean value.

Example


 

Back to top

SetCellData Method

Description

Sets the contents of a cell to the specified value.

Syntax

object.SetCellData Row, Column, Data

Arguments

ParameterDescription
Row Required. An integer value.
The row number. The first row in the table is 1.
Column Required. A Variant.

The name (with quotes) or number (without quotes) of the column in which the cell is located.
The first column in the table is 1.
To specify a column number, use the number, or the format "#N", where N is the numeric value.

Data Required. A String value.
The data to be inserted in the specified cell.

Return Type

None

Example


 

Back to top

SetPage Method

Description

Scrolls the table to the specified page.

Syntax

object.SetPage (Page)

Arguments

ParameterDescription
Page Required. A Variant.

The number of the page to set. The first page number is 1.

To specify a column number, use the number, or the format "#N", where N is the numeric value.

Return Type

A Boolean value.

Example


 

Back to top

Submit Method

Description

Submits a form.

Syntax

object.Submit

Return Type

None

IMPORTANT

This method simulates pressing the Enter key, while the focus is on the object specified in the statement.

If the object is not part of a Web form, the Submit method has no effect.


 

Back to top

Swipe Method

Description

Swipes the object.

Syntax

object.Swipe direction, [distance], [duration], [startX], [startY]

Arguments

ParameterDescription
direction Required. A MoveDirection Value.

The direction of the swipe gesture.

Possible values:

  • moveDown
  • moveLeft
  • moveRight
  • moveUp
distance Optional. An integer value.
The distance (in pixels) of the swipe gesture.
Default value = 0
duration Optional. A Variant.

The time period (in seconds) of the swipe gesture.

You can specify partial seconds as a duration time.

startX Optional. An integer value.
The x-coordinate at which the swipe gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
startY Optional. An integer value.
The y-coordinate at which the swipe gesture begins. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported for Windows Phone.

Example


 

Back to top

CurrentPage Property

Description

Retrieves the number of the currently selected page.

Syntax

object.CurrentPage

Value Type

An integer value.

Property type

Read-only property


Back to top

See also: