# Set Text

This is a pre-built Action located under the **@Custom Element**. The functionality of this Action in Avo Assure is to set the text or string on the object specified in the input. The result is stored in the given dynamic variable for further use during test execution.

{% hint style="info" %}
The **Set Text** action works only when the **VerifyExists** action is executed in a preceding step.
{% endhint %}

## Syntax

**Input Value**: `<ObjectType>;<VisibleText>(optional);<Index>;<value>;<abs(optional)>`

| Argument                            | Description                                                                                                                                            |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p>\<ObjectType><br>(Required)</p>  | Provide the object type which you want to preform the set text operation. (e.g., text box)                                                             |
| <p>\<VisibleText><br>(Optional)</p> | Provide the visible text associated with the object.                                                                                                   |
| <p>\<Index><br>(Required)</p>       | <p>Provide the position of the object you want to identify based on its sequence in the application.<br><strong>Note</strong>: Index start from 0.</p> |
| <p>\<value><br>(Required)</p>       | Provide the text or string which you want to write in the text box.                                                                                    |
| <p>\<abs><br>(Optional)</p>         | Provide the absolute XPath of the object you want to identify for this operation.                                                                      |

{% hint style="info" %}
**Note**:

* If the last argument **abs** is defined, the action executes using absolute identification based on the specified absolute XPath provided in the input.
* To skip an optional input value, use an extra semicolon (;).
  {% endhint %}

**Output Value**: `<Dynamic Variable>(Optional);<Dynamic Variable> (Optional)`

| Argument                                                     | Description                                                       |
| ------------------------------------------------------------ | ----------------------------------------------------------------- |
| \<Dynamic Variable>(Optional);\<Dynamic Variable> (Optional) | Both dynamic variable stores the status as **True** or **False**. |

### **Example 1: Entering Text into an Input Field**

In this example, we are explaining how to input specified text into a targeted input field on the application interface.

* **Action**: Set Text
* **Input Value**: textbox;;0;John\@123
  * The first argument (**textbox**) specifies the object type to be identified.
  * The second argument is left blank to skip an optional value.
  * The third argument (**0**) specifies the index of the input field when multiple matching elements are present.
  * The fourth argument (**John\@123**) specifies the text that needs to be entered into the input field.
* **Output Value**: {Status}
  * The result of the text entry operation is stored in the **{Status}** dynamic variable, with the following possible values:
    * **True**: If the text is entered successfully into the input field.
    * **False**: If the text is not entered successfully into the input field.
* **Logical Explanation**: The **Set Text** action reads the identification details and text value from the **Input Value** column (**textbox;;0;John\@123**). The action locates the matching input field based on the specified object type and index, and then enters the provided text into it. The execution result of the text entry action (True) is stored in the **{Status}** variable.

<figure><img src="/files/uJt8bo5r2lMM5q1PV0bH" alt=""><figcaption></figcaption></figure>

### **Example 2: Entering Text into an Input Field using O**ptional Parameters.

In this example, we are explaining how to input specified text into a targeted input field on the application interface using the provided identification details.

* **Action**: Set Text
* **Input Value**: textbox;Password;0;John\@123
  * The first argument (**textbox**) specifies the object type to be identified.
  * The second argument (**Password**) specifies the visible text of the object.
  * The third argument (**0**) specifies the index of the input field when multiple matching elements are present.
  * The fourth argument (**John\@123**) specifies the text that needs to be entered into the input field.
* **Output Value**: {Status}
  * The result of the text entry operation is stored in the **{Status}** dynamic variable, with the following possible values:
    * **True**: If the text is entered successfully into the input field.
    * **False**: If the text is not entered successfully into the input field.
* **Logical Explanation**: The **Set Text** action reads the identification details and text value from the **Input Value** column (**textbox;Password;0;John\@123**). The action locates the matching input field based on the specified object type, visible text and index, and then enters the provided text into it. The execution result of the text entry action (True) is stored in the **{Status}** variable.

<figure><img src="/files/MXXtnCjwqHSjEPEJUUje" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.avoautomation.com/avo-assure/actions/web/custom-1/set-text.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.