Class AppElementDescription

The Object Description how to identify the UI Elemen for native Mobile Application

Inheritance
Object
ElementDescription
AppElementDescription
Inherited Members
Namespace: AxaFrance.WebEngine.MobileApp
Assembly: AxaFrance.WebEngine.MobileApp.dll
Syntax
public class AppElementDescription : ElementDescription

Constructors

| Edit this page View Source

AppElementDescription()

Initialize the element description. If the element is not part of PageObject, you need to call UseDriver(WebDriver) to indicate with WebDriver will be used.

Declaration
public AppElementDescription()
| Edit this page View Source

AppElementDescription(WebDriver)

Initialize the element description using given WebDriver

Declaration
public AppElementDescription(WebDriver driver)
Parameters
Type Name Description
WebDriver driver

WebDriver instance

Properties

| Edit this page View Source

AccessbilityId

To identify element via it's AccessibilityId. Id and AccessibilityId can't be used in the same time.

Declaration
public string AccessbilityId { get; set; }
Property Value
Type Description
String
| Edit this page View Source

ClassName

Classname of the element.

Declaration
public string ClassName { get; set; }
Property Value
Type Description
String
| Edit this page View Source

ContentDescription

To identify elements via it's content-desc. Name and ContentDescription can't be used in the same time.

Declaration
public string ContentDescription { get; set; }
Property Value
Type Description
String
| Edit this page View Source

Id

Identifier of the element

Declaration
public string Id { get; set; }
Property Value
Type Description
String
| Edit this page View Source

IosClassChain

Using IOS Class Chain, only avaiable for iOS applications. When using IosClassChain, other locators will be ignored..

Declaration
public string IosClassChain { get; set; }
Property Value
Type Description
String
| Edit this page View Source

Name

The Name property of the element. Name and ContentDescription can't be used in the same time, or Name attribute will be ignored.

Declaration
public string Name { get; set; }
Property Value
Type Description
String
| Edit this page View Source

Text

Text of Innertext of the element

Declaration
public string Text { get; set; }
Property Value
Type Description
String
| Edit this page View Source

UIAutomatorSelector

Using UIAutomator selector, only avaiable for Android applications. When using UIAutomator selector, other locators will be ignored.

Declaration
public string UIAutomatorSelector { get; set; }
Property Value
Type Description
String
| Edit this page View Source

XPath

XPath of the element. Please avoid to use XPATH if another identification approche is available.

Declaration
public string XPath { get; set; }
Property Value
Type Description
String

Methods

| Edit this page View Source

ApplyAttribute(FindsByAttribute)

Applies the locator defined in FindsByAttribute. this function is called automatically before InternalFindElements()

Declaration
public override void ApplyAttribute(FindsByAttribute attr)
Parameters
Type Name Description
FindsByAttribute attr
Overrides
| Edit this page View Source

InternalFindElement()

Implemente element identifying algorithm, without the need of object synchronization.

Declaration
protected override IWebElement InternalFindElement()
Returns
Type Description
IWebElement

Identified test object.
Overrides
| Edit this page View Source

InternalFindElements()

Implemente element identifying algorithm, without the need of object synchronization.

Declaration
protected override IReadOnlyCollection<IWebElement> InternalFindElements()
Returns
Type Description
IReadOnlyCollection<IWebElement>

Identified test objects
Overrides
| Edit this page View Source

InternalGetScreenshot()

Implemente screenshot generation for the current specific element

Declaration
protected override byte[] InternalGetScreenshot()
Returns
Type Description
Byte[]

The screenshot image in RAW Binary data format.
Overrides
| Edit this page View Source

ScrollDown()

Scroll the screen downward

Declaration
public void ScrollDown()
| Edit this page View Source

ScrollIntoView(ScrollDirection, Int32)

Tries to bring current element into viewport. This method will scroll the page multiple times to make the element visible. If after the maximum scroll action and the element is still not visible, the method will return false.

Declaration
public bool ScrollIntoView(ScrollDirection direction, int maxSwipe = 10)
Parameters
Type Name Description
ScrollDirection direction

The direction of the scroll
Int32 maxSwipe

The maximum number of swipe action to make the element visible
Returns
Type Description
Boolean

True if the element is visible after scrolling. False when the element is not visible.
| Edit this page View Source

ScrollIntoView(Int32)

Tries to bring current element into viewport. This method will scroll down the page multiple times to make the element visible. If after the maximum scroll action and the element is still not visible, the method will return false.

Declaration
public bool ScrollIntoView(int maxSwipe = 10)
Parameters
Type Name Description
Int32 maxSwipe
Returns
Type Description
Boolean

True if the element is visible after scrolling. False when the element is not visible.
| Edit this page View Source

ScrollUp()

Scroll the screen upward

Declaration
public void ScrollUp()
| Edit this page View Source

ToString()

Shows a string representation of this AppElementDescription

Declaration
public override string ToString()
Returns
Type Description
String

A string representation of this AppElementDescription
Overrides
System.Object.ToString()