MobileToggle Object

Description

A toggle button control in a mobile application.

IMPORTANT

This test object type is not supported for Flutter-based applications.

Operations

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

Note: You can also view a list and descriptions of the MobileToggle 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 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.
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.
Common Method HighlightHighlights the object in the application.
Method LongPressPresses and holds the object for a moment.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PanPerform a Pan gesture on the object.
Method PinchPerform a Pinch gesture on the object.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SetSets the toggle button state.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method SwipeSwipes the object in the specified direction.
Method TapTaps the object.
Common Method ToStringReturns a string that represents the current test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.

Back to top

 

LongPress Method

Description

Presses and holds the object for a moment.

Syntax

object.LongPress [x], [y], [Duration], [NumOfTouchPoints], [Gesture]

Arguments

ParameterDescription
x Optional. An integer value.

The x-coordinate of the long press. 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 = -9999
y Optional. An integer value.

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

Tip: You can enter micNoCoordinate (-9999) for the x and y argument values if you want to enter a value for the other optional arguments without specifying x- and y- coordinates for the long press. micNoCoordinate indicates the center of the object.


Default value = -9999
Duration Optional. A double floating value.
The number of seconds to continue pressing. (Supported only on iOS)
Default value = 0
NumOfTouchPoints Optional. An integer value.
The number of points to press, similar to the number of fingers you would use for the gesture on a real device. (Supported only on iOS)
Supported value = 1
Gesture Optional. A String value.

The gesture class designed by the mobile application developer to handle this gesture on this object. (relevant for iOS only)

Note:
 - This argument is necessary only if the application developer overrode the default iOS gesture class.
 - If this argument is necessary, it is recorded when you perform the gesture on the mobile object during a record session.
   If you manually add any steps to the test that perform the same gesture on the same mobile object, use the recorded gesture class for this argument.


Default value = ""

Return Type

None

Back to top

 

Pan Method

Description

Perform a Pan gesture on the object.

Syntax

object.Pan StartX, StartY, EndX, EndY, [XVelocity], [YVelocity], [Gesture]

Arguments

ParameterDescription
StartX Required. An integer value.

The x-coordinate at which to start the pan gesture. Note that the specified coordinates are relative to the upper left corner of the object.

StartY Required. An integer value.
The y-coordinate at which to start the pan gesture. Note that the specified coordinates are relative to the upper left corner of the object.
EndX Required. An integer value.

The x-coordinate at which to end the pan gesture. Note that the specified coordinates are relative to the upper left corner of the object.

EndY Required. An integer value.

The y-coordinate at which to end the pan gesture. Note that the specified coordinates are relative to the upper left corner of the object.

XVelocity Optional. A double floating value.
The horizontal velocity of the pan gesture.
Default value = -9999
YVelocity Optional. A double floating value.
The vertical velocity of the pan gesture.
Default value = -9999
Gesture Optional. A String value.

The gesture class designed by the mobile application developer to handle this gesture on this object. (relevant for iOS only)

Note:
 - This argument is necessary only if the application developer overrode the default iOS gesture class.
 - If this argument is necessary, it is recorded when you perform the gesture on the mobile object during a record session.
   If you manually add any steps to the test that perform the same gesture on the same mobile object, use the recorded gesture class for this argument.


Default value = ""

Return Type

None

Example

                    'The following example performs a Pan gesture on a MobileObject object
'in a Mobile application.

Device("Device").App("TouchesNI").MobileObject("yellow_view").Pan 46,20,58,137,-29.768660,44.604350

Back to top

 

Pinch Method

Description

Perform a Pinch gesture on the object.

Syntax

object.Pinch Scale, [Velocity], [x], [y], [Gesture]

Arguments

ParameterDescription
Scale Required. A double floating value.

The scale for the pinch gesture. This number is the ratio between the start distance and the end distance between the two touch point used for the pinch.

For example, if you were to touch a screen with your fingers 6 cm apart, and pinch until your fingers were 3 cm, apart, the scale would be 0.5. 

Velocity Optional. A double floating value.

The speed at which to perform the pinch gesture. This number specifies the scale factor per second. Meaning - ratio between the touch point distance at one second, and the touch point distance one second later.

For example, if performing a pinch from 6 cm to 3 cm (0.5 scale) takes 2 seconds, then the velocity is 0.25.


Default value = 0
x Optional. An integer value.

The x-coordinate for the pinch gesture. 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 = -9999
y Optional. An integer value.

The y-coordinate for the pinch gesture. 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 = -9999
Gesture Optional. A String value.

The gesture class designed by the mobile application developer to handle this gesture on this object. (relevant for iOS only)

Note:
 - This argument is necessary only if the application developer overrode the default iOS gesture class.
 - If this argument is necessary, it is recorded when you perform the gesture on the mobile object during a record session.
   If you manually add any steps to the test that perform the same gesture on the same mobile object, use the recorded gesture class for this argument.


Default value = ""

Return Type

None

Example

                    'The following example performs a Pinch gesture on a MobileObject object
'in a Mobile application.

Device("Device").App("TouchesNI").MobileObject("pink_View").Pinch 1.885921,0.700999,78,89

Back to top

 

Set Method

Description

Sets the toggle button state.

Syntax

object.Set State

Arguments

ParameterDescription
State Required. A String value.
The new state of the toggle.
Possible values:
 - On
 - Off

Return Type

None

Example

                    'The following example sets the state of a MobileToggle object in
'a Mobile application.

Device("Device").App("com.sample.UICatalog").MobileToggle("ON").Set "on"

Back to top

 

Swipe Method

Description

Swipes the object in the specified direction.

Syntax

object.Swipe Direction, [x], [y], [Gesture]

Arguments

ParameterDescription
Direction Required. A String value.

The direction in which to swipe the object.

Possible values:
- up
- down
- left
- right

x Optional. An integer value.

The x-coordinate at which to start the swipe. 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 = -9999
y Optional. An integer value.

The y-coordinate at which to start the swipe. 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 = -9999
Gesture Optional. A String value.

The gesture class designed by the mobile application developer to handle this gesture on this object. (relevant for iOS only)

Note:
 - This argument is necessary only if the application developer overrode the default iOS gesture class.
 - If this argument is necessary, it is recorded when you perform the gesture on the mobile object during a record session.
   If you manually add any steps to the test that perform the same gesture on the same mobile object, use the recorded gesture class for this argument.


Default value = ""

Return Type

None

IMPORTANT

During recording sessions on Android devices, this method is not recorded. You can add it to the test manually.

Example

                    'The following example performs a Swipe gesture on a MobileObject object
'in a Mobile application.

Device("Device").App("UICatalog").MobileObject("customviewpager").Swipe "up",545,1521

Back to top

 

Tap Method

Description

Taps the object.

Syntax

object.Tap [x], [y], [NumberOfTaps], [NumOfTouchPoints], [Gesture]

Arguments

ParameterDescription
x Optional. An integer value.

The x-coordinate of the tap. 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 = -9999
y Optional. An integer value.

The y-coordinate of the tap. 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 = -9999
NumberOfTaps Optional. An integer value.
The number of times to tap the object. (Supported only on iOS)
Default value = 1
NumOfTouchPoints Optional. An integer value.
The number of points to press, similar to the number of fingers you would use for the gesture on a real device. (Supported only on iOS)
Default value = 1
Gesture Optional. A String value.

The gesture class designed by the mobile application developer to handle this gesture on this object. (relevant for iOS only)

Note:
 - This argument is necessary only if the application developer overrode the default iOS gesture class.
 - If this argument is necessary, it is recorded when you perform the gesture on the mobile object during a record session.
   If you manually add any steps to the test that perform the same gesture on the same mobile object, use the recorded gesture class for this argument.


Default value = ""

Return Type

None

Example

                    'The following example performs a Tap on a MobileObject object in
'a Mobile application.

Device("Device").App("TouchesNI").MobileObject("yellow_view").Tap 49,58

Back to top

See also: