iOSObject¶
iOS Object.
Behavior Pattern: iOSObjectGenericBehavior
Property Summary¶
| Property | Description | Getter | Setter |
|---|---|---|---|
| ChildAt | Child object at index. | GetChildAt | |
| ChildCount | Number of child items. | GetChildCount | |
| Class | Class name of the object. | GetClass | |
| Height | Height of the object. | GetHeight | |
| Label | Label of the iOS object | GetLabel | |
| Name | Name of the object. | GetName | |
| NextSibling | iOSObject for the next sibling element. |
GetNextSibling | |
| ObjectType | Type of the object. | GetObjectType | |
| Parent | iOSObject for the parent element. |
GetParent | |
| PrevSibling | iOSObject for the previous sibling element. |
GetPrevSibling | |
| Property | Value of a named property of the object. | GetProperty | |
| Text | Text of the object, 'false' if text can not be read. | GetText | |
| Width | Width of the object. | GetWidth | |
| X | X-coordinate of the top left corner of the object. | GetX | |
| Y | Y-coordinate of the top left corner of the object. | GetY |
Action Summary¶
| Action | Description |
|---|---|
| DoAction | Clicks in the middle of the control. |
| DoClear | Clears the text of the object. |
| DoClick | Clicks in the middle of the control. |
| DoEnsureVisible | Ensure that a child item with the specified text is visible on screen. |
| DoFindByXPath | Finds an element by relative XPath expression. |
| DoSendKeys | Send a text to the object in character-by-character mode. |
| DoTap | Taps the control. |
| DoTwoFingerTap | Taps the control with two fingers. |
Property Detail¶
ChildAt¶
Child object at index.
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| index | number | Index of the object to get. |
Type: string
Accessors: GetChildAt
ChildCount¶
Number of child items.
Type: number
Accessors: GetChildCount
Class¶
Class name of the object.
Type: string
Accessors: GetClass
Height¶
Height of the object.
Type: number
Accessors: GetHeight
Label¶
Label of the iOS object
Type: string
Accessors: GetLabel
Name¶
Name of the object.
Type: string
Accessors: GetName
NextSibling¶
iOSObject for the next sibling element. Requires Rapise 6.6+
Type: iOSObject
Accessors: GetNextSibling
ObjectType¶
Type of the object.
Type: string
Accessors: GetObjectType
Parent¶
iOSObject for the parent element. Requires Rapise 6.6+
Type: iOSObject
Accessors: GetParent
PrevSibling¶
iOSObject for the previous sibling element. Requires Rapise 6.6+
Type: iOSObject
Accessors: GetPrevSibling
Property¶
Value of a named property of the object.
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| name | string | Property name. |
Type: string
Accessors: GetProperty
Text¶
Text of the object, 'false' if text can not be read.
Type: string
Accessors: GetText
Width¶
Width of the object.
Type: number
Accessors: GetWidth
X¶
X-coordinate of the top left corner of the object.
Type: number
Accessors: GetX
Y¶
Y-coordinate of the top left corner of the object.
Type: number
Accessors: GetY
Action Detail¶
DoAction¶
Clicks in the middle of the control.
DoAction()
Returns:
boolean: 'true' if success, 'false' otherwise.
DoClear¶
Clears the text of the object.
DoClear()
Returns:
boolean: 'true' if success, 'false' otherwise.
DoClick¶
Clicks in the middle of the control.
DoClick()
Returns:
boolean: 'true' if success, 'false' otherwise.
DoEnsureVisible¶
Ensure that a child item with the specified text is visible on screen.
DoEnsureVisible()
Returns:
boolean: 'true' if success, 'false' otherwise.
DoFindByXPath¶
Finds an element by relative XPath expression. Requires Rapise 6.6+
DoFindByXPath(xpath)
Parameters:
| Name | Type | Description |
|---|---|---|
| xpath | string | Relative XPath expression. |
Returns:
iOSObject: iOSObject if success, null otherwise.
DoSendKeys¶
Send a text to the object in character-by-character mode.
DoSendKeys(keys)
Parameters:
| Name | Type | Description |
|---|---|---|
| keys | string | Text to type into the object. |
Returns:
boolean: 'true' if success, 'false' otherwise.
DoTap¶
Taps the control.
DoTap()
Returns:
boolean: 'true' if success, 'false' otherwise.
DoTwoFingerTap¶
Taps the control with two fingers.
DoTwoFingerTap()
Returns:
boolean: 'true' if success, 'false' otherwise.