# Get Text field Length

This is a pre-built Action located under the **@Custom Element**. The functionality of this Action in Avo Assure is to fetch the maximum allowed length of the textbox. The extracted value is stored in the given dynamic variable for further use during test execution.

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

## **Syntax**

**Input Value**: `<ObjectType>;<VisibleText(optional)>;<Index>;<abs(optional)>`&#x20;

| Argument                            | Description                                                                                                                                            |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p>\<ObjectType><br>(Required)</p>  | Provide the object type which you want to preform the retrieved 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>\<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                                                       |
| ------------------------------------------- | ----------------------------------------------------------------- |
| <p>\<Dynamic Variable><br>(Optional)</p>    | This dynamic variable stores the length of the textbox.           |
| <p>\<Dynamic Variable></p><p>(Optional)</p> | This dynamic variable stores the status as **True** or **False**. |

### **Example 1: Retrieving the Length of a Textbox**

In this example, we are explaining how to fetch the length of text entered in a specified textbox.

* **Action**: Get Text field Length
* **Input Value**: textbox;;1
  * 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 (**1**) specifies the index of the textbox when multiple matching elements are present.
* **Output Value**: {length}
  * The result of the text length retrieval (15) is stored in the **{length}** dynamic variable.&#x20;
  * If a second output variable is defined, it stores the execution status with the following possible values:
    * **True**: If the text length is retrieved successfully.
    * **False**: If the text length is not retrieved successfully.
* **Logical Explanation**: The **Get Text field Length** action reads the identification details from the **Input Value** column (**textbox;;1**). The action locates the matching textbox based on the specified object type and index and retrieves the length of the text present. The extracted length (15) is stored in the **{length}** variable.

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

### **Example 2: Retrieving the Length of a Textbox using Optional Parameters**

In this example, we are explaining how to fetch the length of text entered in a specified textbox using optional identification parameters.

* **Action**: Get Text Field Length
* **Input Value**: textbox;Password;1
  * The first argument (**textbox**) specifies the object type to be identified.
  * The second argument (**Password**) specifies the visible text of the input field.
  * The third argument (**1**) specifies the index of the input field when multiple matching elements are present.
* **Output Value**: {length}
  * The result of the text length retrieval (15) is stored in the **{length}** dynamic variable.&#x20;
  * If a second output variable is defined, it stores the execution status with the following possible values:
    * **True**: If the text length is retrieved successfully.
    * **False**: If the text length is not retrieved successfully.
* **Logical Explanation**: The **Get Text Field Length** action reads the identification details from the **Input Value** column (**textbox;Password;1**). The action locates the matching input field based on the specified object type, visible text, and index, and fetches the length of the text present in the field. The extracted length (15) is stored in the **{length}** variable.

<figure><img src="/files/EvCZr7or2RgJLw0eCQJF" 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/get-text-field-length.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.
