Interface IUiObjectBase

Common functionality for all UI objects in a mobile application.

Inherited Members

IEnabledProvider.IsEnabled

Namespace: HP.LFT.SDK.Mobile

Assembly: HP.LFT.SDK.dll

Syntax

public interface IUiObjectBase : IEnabledProvider

Properties

AccessibilityId

The accessibility ID of the mobile object.

Declaration

string AccessibilityId { get; }

Property Value

Type	Description
string

ClassName

The test object class name used by OpenText Functional Testing Lab

Declaration

string ClassName { get; }

Property Value

Type	Description
string

Container

Information about the table container, if the object is in a table. (iOS Only)

Declaration

string Container { get; }

Property Value

Type	Description
string

Remarks

Container information can include the class name, index, cell index, and section, for example.

Hint

Instruction or example indicating the type of content to enter for the value of a control, for example, a grayed out hint inside a text box.

Declaration

string Hint { get; }

Property Value

Type	Description
string

IsCheckable

Indicates whether the mobile object can be checked.

Declaration

bool IsCheckable { get; }

Property Value

Type	Description
bool

IsChecked

Indicates whether the mobile object is checked. (Relevant for objects that can have a check mark.)

Declaration

bool IsChecked { get; }

Property Value

Type	Description
bool

IsClickable

Indicates whether the object can be tapped.

Declaration

bool IsClickable { get; }

Property Value

Type	Description
bool

IsFocusable

Indicates whether the object can receive focus.

Declaration

bool IsFocusable { get; }

Property Value

Type	Description
bool

IsFocused

Indicates whether the mobile object is in focus.

Declaration

bool IsFocused { get; }

Property Value

Type	Description
bool

Location

The location of the mobile object.

Declaration

Point Location { get; }

Property Value

Type	Description
Point

MobileCenterIndex

An ordinal number assigned to the object to indicate the order in which the object appears on the device relative to other objects with an otherwise identical description.

Declaration

int MobileCenterIndex { get; }

Property Value

Type	Description
int

NativeClass

The native class of the mobile object.

Declaration

string NativeClass { get; }

Property Value

Type	Description
string

ResourceId

The resource ID of the object. (Android Only)

Declaration

string ResourceId { get; }

Property Value

Type	Description
string

Size

The size of the mobile object.

Declaration

Size Size { get; }

Property Value

Type	Description
Size

Text

The object's text.

Declaration

string Text { get; }

Property Value

Type	Description
string

Methods

LongPress()

Taps and holds the object for a short time.

Declaration

void LongPress()

LongPress(LongPressArgs)

Taps and holds the object for a short time according to the specified behavior.

Declaration

void LongPress(LongPressArgs args)

Parameters

Type	Name	Description
LongPressArgs	args	Additional LongPressArgs arguments that define the behavior of the long press operation.

Pan(Location, Location)

Perform a Pan gesture on the object.

Declaration

void Pan(Location start, Location end)

Parameters

Type	Name	Description
Location	start	The location at which to start the pan gesture.
Location	end	The location at which to end the pan gesture.

Pan(Point, Point)

Perform a Pan gesture on the object with default PanArgs.

Declaration

void Pan(Point start, Point end)

Parameters

Type	Name	Description
Point	start	The Point at which to start the pan gesture.
Point	end	The Point at which to end the pan gesture.

Pan(Point, Point, PanArgs)

Perform a Pan gesture on the object.

Declaration

void Pan(Point start, Point end, PanArgs args)

Parameters

Type	Name	Description
Point	start	The Point at which to start the pan gesture.
Point	end	The Point at which to end the pan gesture.
PanArgs	args	PanArgs arguments that define the behavior of the pan operation.

Pinch(double)

Perform a Pinch gesture on the object.

Declaration

void Pinch(double scale)

Parameters

Type	Name	Description
double	scale	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

Pinch(double, PinchArgs)

Perform a Pinch gesture on the object.

Declaration

void Pinch(double scale, PinchArgs args)

Parameters

Type	Name	Description
double	scale	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
PinchArgs	args	PinchArgs arguments that define the behavior of the pinch operation.

Swipe(SwipeDirection)

Swipes the object in the specified direction.

Declaration

void Swipe(SwipeDirection direction)

Parameters

Type	Name	Description
SwipeDirection	direction	The SwipeDirection.

Swipe(SwipeDirection, SwipeArgs)

Swipes the object in the specified direction.

Declaration

void Swipe(SwipeDirection direction, SwipeArgs args)

Parameters

Type	Name	Description
SwipeDirection	direction	The SwipeDirection.
SwipeArgs	args	SwipeArgs arguments that define the behavior of the swipe operation.

Tap()

Taps the center of the object.

Declaration

void Tap()

Tap(TapArgs)

Taps the object using the specified arguments.

Declaration

void Tap(TapArgs args)

Parameters

Type	Name	Description
TapArgs	args	TapArgs arguments that define the behavior of the tap operation.

Extension Methods

TestObjectExtensions.WaitUntilEnabled<T>(T)

TestObjectExtensions.WaitUntilEnabled<T>(T, int)