# Hover Mouse on Object

This is a pre-built Action located under the **@Custom Element**. The functionality of this Action in Avo Assure is to move the mouse pointer over the specified element without performing a click operation. The result is stored in the given dynamic variable for further use during test execution.

{% hint style="info" %}
The **Hover Mouse on Object** 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 where you want to preform the mouse hover operation. (e.g., button, link)                                                      |
| <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                                                       |
| ----------------------------------------------------------- | ----------------------------------------------------------------- |
| \<Dynamic Variable>(Optional);\<Dynamic Variable>(Optional) | Both dynamic variable stores the status as **True** or **False**. |

### **Example 1: Hovering Mouse on a UI Element**

In this example, we are explaining how to move the mouse pointer over a specific object on the application interface without performing a click action.

* **Action**: Hover Mouse on Object
* **Input Value**: button;;3
  * 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 (**3**) specifies the index of the object when multiple matching elements are present.
* **Output Value**: {Status}
  * The result of the hover operation is stored in the **{Status}** dynamic variable, with the following possible values:
    * **True**: If the mouse hover is performed successfully on the object.
    * **False**: If the mouse hover is not performed on the object.
* **Logical Explanation**: The **Hover Mouse on Object** action reads the identification details from the **Input Value** column (**button;;3**). The action locates the matching UI element based on the specified object type and index and then moves the mouse pointer over the element without clicking. The execution result of the hover action (True) is stored in the **{Status}** variable.

<figure><img src="/files/1dyxHsLFCkGvwAVOEjKF" alt=""><figcaption></figcaption></figure>

### **Example 2: Hovering Mouse on a UI Element using Optional Parameters**

In this example, we are explaining how to move the mouse pointer over a specific object on the application interface using optional identification parameters.

* **Action**: Hover Mouse on Object
* **Input Value**: button;Submit;3;//\*\[@id="btn3"]
  * The first argument (**button**) specifies the object type to be identified.
  * The second argument (**Submit**) specifies the visible text associated with the object.
  * The third argument (**3**) specifies the index of the object when multiple matching elements are present.
  * The fourth argument (**//\*\[@id="btn3"]**) specifies the absolute XPath of the object.
* **Output Value**: {Status}
  * The result of the hover operation is stored in the **{Status}** dynamic variable, with the following possible values:
    * **True**: If the mouse hover is performed successfully on the object.
    * **False**: If the mouse hover is not performed on the object.
* **Logical Explanation**: The **Hover Mouse on Object** action reads the identification details from the **Input Value** column (**button;Submit;3;//\*\[@id="btn3"]**). The action locates the matching UI element using the object type, visible text, index, and XPath, and then moves the mouse pointer over the element without clicking. The execution result of the hover action (True) is stored in the **{Status}** variable.

<figure><img src="/files/e96BqSP7bZizUelYt1gt" 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/hover-mouse-on-object.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.