# Get Button Name

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

{% hint style="info" %}
The **Get Button Name** 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 type of object whose button name you want to retrieved.                                                                                    |
| <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 fetched button name.             |
| <p>\<Dynamic Variable><br>(Optional)</p> | This dynamic variable stores the status as **True** or **False**. |

### **Example 1: Retrieving the Name of a Button**

In this example, we are explaining how to retrieve the name of a specified button from the application.

* **Action**: Get Button Name
* **Input Value**: button;;0
  * The first argument (**button**) 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 button when multiple matching elements are present.
* **Output Value**: {Name}
  * The retrieved button name (**Submit**) is stored in the **{Name}** dynamic variable.
  * If a second output variable is defined, it stores the execution status with the following possible values:
    * **True**: If the button name is retrieved successfully.
    * **False**: If the button name is not retrieved successfully.
* **Logical Explanation**: The **Get Button Name** action reads the identification details from the **Input Value** column (**button;;0**). The action locates the matching button based on the specified object type and index and extracts the name of the button. The retrieved button name (Submit) is stored in the **{Name}** variable.

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

### **Example 2: Retrieving the Name of a Button using Optional Parameters**

In this example, we are explaining how to retrieve the name of a specified button from the application using optional identification parameters.

* **Action**: Get Button Name
* **Input Value**: button;Submit;0
  * The first argument (**button**) specifies the object type to be identified.
  * The second argument (**Submit**) specifies the visible text of the button.
  * The third argument (**0**) specifies the index of the button when multiple matching elements are present.
* **Output Value**: {Name}
  * The retrieved button name (Submit) is stored in the **{Name}** dynamic variable.
  * If a second output variable is defined, it stores the execution status with the following possible values:
    * **True**: If the button name is retrieved successfully.
    * **False**: If the button name is not retrieved successfully.
* **Logical Explanation**: The **Get Button Name** action reads the identification details from the **Input Value** column (**button;Submit;0**). The action locates the matching button based on the specified object type, visible text, and index and extracts the name of the button. The retrieved button name is stored in the **{Name}** variable.

<figure><img src="/files/RXRGdGdiqyjg7tMmhxPC" 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-button-name.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.