Overview
Overview
The NativeApp library is a library that takes and executes strings from Windows application (.exe) files.
Only 32-bit Windows applications works.
The features provided by the NativeApp library are as follows:
Extract string information: GetNativeAppTextList, GetNativeAppTextInfoList
Mouse action features: NativeAppTextClick, NativeAppTextDoubleClick, NativeAppTextRightClick, NativeAppTextHover
Get text feature: GetNativeAppTextBound
Text recognition feature: NativeAppTextWaitAppear, NativeAppTextWaitDisAppear
You can refer to samples for the NativeApp library using the designer or Windows Explorer.
• Designer Path: Menu > Help > Sample > Sample > NativeApp
• Windows Explorer path: C:\Users\user\AppData\Roaming\Brity RPA Designer\samples\NativeApp
Installing the NativeApp Library
To Install NativeApp library Please refer: 5. Install the Add-In Library
Close both BrityRPA Designer and Bot before installation.
Common Properties
Common Properties
INPUT
Since the object information output as the result of the Find Activity of the App Library is required, the process must always be performed like the Find Activity.
Property | Type | Required | Unit | Auto-sitting | Description |
---|---|---|---|---|---|
NativeApp | Object | Y | - | N | Enter the object information output as the Result of the Find Activity. |
MORE OPTIONS
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
WaitDrawTime | Number | Y | Second | Y | Enter the maximum amount of time that the target Native App will finish loading the screen. This means the time at which the entire on-screen control finishes loading. (More than 5 seconds required) |
DrawInterval | Number | Y | Millisecond | Y | Estimates the maximum spacing between each text on the screen of the target Native App. |
On Error | Combination box | N | - | N | Specify an action to carry out when an error occurs at the time of execution. - If not specified: Output errors and exit the task. - --Ignore--: Ignore the error. - --Retry--: Try the activity one more time. - --Goto--: Try the scenario for the specified time if the activity fails. - _Event: Select an event created within the project. If a handler is specified: Call the specified handler. |
DESCRIPTION
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
DESCRIPTION | Text | N | - | N | Enter the description for the activity card. The description entered in the DESCRIPTION field is used as the description of the activity. A representative value will be displayed in the absence of the DESCRIPTION input. |
GetNativeAppTextList
GetNativeAppTextList
Overview
This activity card gets a list of all the strings inside the entered NativeApp object.
Application procedures
In the NativeApp field, enter the object variable received as the result of the find activity.
Card properties
Property | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
[Output] Result | Variable | Y | - | N | Enter a variable to store the list of strings. |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. |
Sample file
Menu > Help > Sample > Sample > NativeApp > P_GetNativeAppTextList
GetNativeAppTextInfoList
GetNativeAppTextInfoList
Overview
This activity card gets a list of all strings inside the entered NativeApp object and their on-screen location information.
Application procedures
In NativeApp, enter the object variable that you received as the result of the Find Activity.
Card properties
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
[Output] Result | Variable | Y | - | N | Enter a variable to store the list of string information. |
- | - | - | - | Common property of the NativeApp library. | |
MORE OPTIONSThe internal link is invalid.The internal link is invalid. | - | - | - | - | Common property of the NativeApp library. |
- | - | - | - | Common property of the NativeApp library. |
Sample file
Menu > Help > Sample > Sample > NativeApp > P_GetNativeAppTextInfoList
Example of using Output
[Output] If you enter the variable this.list in the result, you can use it as follows after receiving the list after the execution is entered.
Get the text of the first item in the list: this.list[0]. AppText
Get the text area screen coordinates of the first item in the list: this.list[0]. Bounds
Get the text area x coordinates of the first item in the list: this.list[0]. Left
Get the text area y coordinates of the first item in the list: this.list[0]. Top
Get the text area width value of the first item in the list: this.list[0]. Width
Get the text area height value of the first item in the list: this.list[0]. Height
NativeAppTextClick
NativeAppTextClick
Overview
This activity card finds the specified target text among the text of the entered Native App object and clicks on the area.
Application procedures
In the [Output]Result field, enter a variable to store the screen coordinates of the target string upon successful search.
In the NativeApp field, enter the object variable you received as the result of the Find Activity.
In the TargetText field, enter the text you want to search.
Specify the order if Index has the same target text.
Card properties
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
[Output] Result | Variable | Y | - | N | Enter a variable to store the screen coordinates (left, top, width, height) of the target string when the search is successful on the screen. |
TargetText | Text | Y | - | N | Enter the target text you want to search for on the screen. |
Index | Number | Y | - | Y | If the target text is the same, specify the order. The more it is located in the upper left corner of the screen, the lower the order number. You can specify from 0. |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. |
Sample file
Menu > Help > Sample > Sample > NativeApp > P_NativeAppTextClick
NativeAppTextDoubleClick
NativeAppTextDoubleClick
Overview
Finds the specified target text among the text of the entered Native App object and double-clicks on the area.
Application procedures
In the [Output]Result field, enter a variable to store the screen coordinates of the target string upon successful search.
In the NativeApp field, enter the object variable you received as the result of the Find Activity.
In the TargetText field, enter the text you want to search.
Specify the order if Index has the same target text.
Card properties
Properies | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
[Output] Result | String | Y | - | N | Enter a variable to store the screen coordinates (left, top, width, height) of the target string when the search is successful on the screen. |
- | - | - | - | Common property of the NativeApp library. | |
TargetText | String | Y | - | N | Enter the target text you want to search for on the screen. |
Index | Number | Y | - | Y | If the target text is the same, specify the order. The more it is located in the upper left corner of the screen, the lower the order number. You can specify from 0. |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. |
Sample file
Menu > Help > Sample > Sample > NativeApp > P_NativeAppTextDoubleClick
NativeAppTextRightClick
NativeAppTextRightClick
Overview
Thia activity card finds the specified target text among the text of the entered Native App object and right-clicks on the area.
Application procedures
In the [Output]Result field, enter a variable to store the screen coordinates of the target string upon successful search.
In the NativeApp field, enter the object variable you received as the result of the Find Activity.
In the TargetText field, enter the text you want to search.
Specify the order if Index has the same target text.
Card properties
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
[Output] Result | String | Y | - | N | Enter a variable to store the screen coordinates (left, top, width, height) of the target string when the search is successful on the screen. |
- | - | - | - | Common property of the NativeApp library. | |
TargetText | Text | Y | - | N | Enter the target text you want to search for on the screen. |
Index | Number | Y | - | Y | If the target text is the same, specify the order. The more it is located in the upper left corner of the screen, the lower the order number. You can specify from 0. |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. |
Sample file
Menu > Help > Sample > Sample > NativeApp > P_NativeAppTextRightClick
NativeAppTextHover
NativeAppTextHover
Overview
Thia activity card finds the specified target text among the text of the entered Native App object and hovers over the area.
Application procedures
In the [Output] Result field, enter a variable to store the screen coordinates of the target string upon successful search.
In the NativeApp field, enter the object variable you received as the result of the Find Activity.
In the TargetText field, enter the text you want to search.
Specify the order if Index has the same target text.
Card properties
Property | Type | Required | Unit | Auto-settings | Description |
---|---|---|---|---|---|
[Output] Result | String | Y | - | N | Enter a variable to store the screen coordinates (left, top, width, height) of the target string when the search is successful on the screen. |
- | - | - | - | Common property of the NativeApp library. | |
TargetText | String | Y | - | N | Enter the target text you want to search for on the screen. |
Index | Number | Y | - | Y | If the target text is the same, specify the order. The more it is located in the upper left corner of the screen, the lower the order number. You can specify from 0. |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. |
Sample file
Menu > Help > Sample > Sample > NativeApp > P_NativeAppTextHover
GetNativeAppTextBound
GetNativeAppTextBound
Overview
This activity card finds the specified target text among the text of the entered Native App object and gets the corresponding area information.
Application procedures
In the [Output] Result field, enter a variable to store the screen coordinates of the target string upon successful search.
In the NativeApp field, enter the object variable you received as the result of the Find Activity.
In the TargetText field, enter the text you want to search.
Specify the order if Index has the same target text.
Card properties
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
[Output] Result | String | Y | - | N | Enter a variable to store the screen coordinates (left, top, width, height) of the target string when the search is successful on the screen. |
- | - | - | - | Common property of the NativeApp library. | |
TargetText | String | Y | - | N | Enter the target text you want to search for on the screen. |
Index | Number | Y | - | Y | If the target text is the same, specify the order. The more it is located in the upper left corner of the screen, the lower the order number. You can specify from 0. |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. |
Sample file
Menu > Help > Sample > Sample > NativeApp > P_GetNativeAppTextBound
WaitAppearNativeAppText
WaitAppearNativeAppText
Overview
Waits for the specified target text of the input Native App object to be displayed on the screen.
Application procedures
In the [Output] Result field, enter a variable to store the screen coordinates of the target string upon successful search.
In the NativeApp field, enter the object variable you received as the result of the Find Activity.
In the TargetText field, enter the text you want to search.
Specify the order if Index has the same target text.
In the Timeout field, enter the maximum wait time.
Card properties
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
[Output] Result | Variable | Y | - | N | Enter a variable to store whether the target string is output within Timeout. |
- | - | - | - | Common property of the NativeApp library. | |
TargetText | String | Y | - | N | Enter the target text you want to search for on the screen. |
Index | Number | Y | - | Y | If the target text is the same, specify the order. The more it is located in the upper left corner of the screen, the lower the order number. You can specify from 0. |
Timeout | Number | Y | second | Y | Enter the maximum wait time. You cannot enter a value smaller than WaitDrawTime. |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. |
Sample file
Menu > Help > Sample > Sample > NativeApp > P_WaitAppearNativeAppText
WaitDisappearNativeAppText
WaitDisappearNativeAppText
Overview
Waits until the specified target text of the input Native App object is not displayed on the screen.
Application procedures
In [Output] Result screen, enter a variable to store whether the target string is not output within the Timeout.
In NativeApp, enter the object variable that you received as the result of the Find Activity.
For TargetText, enter the target text that you want to search for on the screen.
If Index has the same target text, specify the order.
For Timeout, enter the maximum wait time.
Card properties
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
[Output] Result | Variable | Y | - | N | Enter a variable to store whether the target string is not output within Timeout. |
- | - | - | - | Common property of the NativeApp library. | |
TargetText | String | Y | - | N | Enter the target text you want to search for on the screen. |
Index | Number | Y | - | Y | If the target text is the same, specify the order. The more it is located in the upper left corner of the screen, the lower the order number. You can specify from 0. |
Timeout | Number | Y | second | Y | Enter the maximum wait time. You cannot enter a value smaller than WaitDrawTime. |
- | - | - | - | Common property of the NativeApp library. | |
- | - | - | - | Common property of the NativeApp library. |
Sample file
Menu > Help > Sample > Sample > NativeApp > P_WaitDisappearNativeAppText