activities

latest

false

UI Automation activities

Last updated Feb 19, 2026

Hover

Hovers the mouse over a specified UI element.

This API must be added after Open or Attach.

Definition

Namespace: UiPath.UIAutomationNext.API.Models

Assembly: UiPath.UIAutomationNext.API.Models (in UiPath.UIAutomationNext.API.Models dll)

Overloads

Overload	Description
`Hover(IElementDescriptor, Double, CursorMotionType)`	Hovers the mouse over a specified UI element, identified by a descriptor of an element from Object Repository, while specifying the hover time and the cursor motion type.
`Hover(String, Double, CursorMotionType)`	Hovers the mouse over a specified UI element, identified by a string from Object Repository, while specifying the hover time and the cursor motion type.
`Hover(TargetAnchorableModel, HoverOptions)`	Hovers the mouse over a specified UI element, identified by the `TargetAnchorableModel` object, while customizing the hover action.
`Hover(IElementDescriptor, HoverOptions)`	Hovers the mouse over a specified UI element, identified by a descriptor of an element from Object Repository, while customizing the hover action.
`Hover(String, HoverOptions)`	Hovers the mouse over a specified UI element, identified by a string from Object Repository, while customizing the hover action.
`Hover(RuntimeTarget, HoverOptions)`	Hovers the mouse over a specified UI element, identified by a runtime instance of an Object Repository element, while customizing the hover action.
`Hover(TargetAnchorableModel, Double, CursorMotionType)`	Hovers the mouse over a specified UI element, identified by the `TargetAnchorableModel` object, while specifying the hover time and the cursor motion type.

`Hover(IElementDescriptor, Double, CursorMotionType)`

Hovers the mouse over a specified UI element, identified by a descriptor of an element from Object Repository, while specifying the hover time and the cursor motion type.

Hover(
    IElementDescriptor elementDescriptor,
    double hoverTime,
    CursorMotionType cursorMotionType)
Hover(
    IElementDescriptor elementDescriptor,
    double hoverTime,
    CursorMotionType cursorMotionType)

elementDescriptor IElementDescriptor : The UI element that you want to hover, identified by a descriptor of an element from Object Repository.

hoverTime Double : The number of seconds for which to hover the target element. The default value is 1 second.

cursorMotionType CursorMotionType : Specifies the type of motion performed by the mouse cursor. There are two available options:

* **Instant** - The
  cursor jumps to the destination. By default, **Instant** is
  selected.
* **Smooth** - The
  cursor moves gradually towards the destination.
* **Instant** - The
  cursor jumps to the destination. By default, **Instant** is
  selected.
* **Smooth** - The
  cursor moves gradually towards the destination.

`Hover(String, Double, CursorMotionType)`

Hovers the mouse over a specified UI element, identified by a string from Object Repository, while specifying the hover time and the cursor motion type.

Hover(
    string target,
    double hoverTime,
    CursorMotionType cursorMotionType)
Hover(
    string target,
    double hoverTime,
    CursorMotionType cursorMotionType)

target String : The UI element that you want to hover, identified by a string from Object Repository.

hoverTime Double : The number of seconds for which to hover the target element. The default value is 1 second.

cursorMotionType CursorMotionType : Specifies the type of motion performed by the mouse cursor. There are two available options:

* **Instant** - The cursor jumps to the destination. By default,
  **Instant** is selected.
* **Smooth** - The cursor moves gradually towards the
  destination.
* **Instant** - The cursor jumps to the destination. By default,
  **Instant** is selected.
* **Smooth** - The cursor moves gradually towards the
  destination.

`Hover(TargetAnchorableModel, HoverOptions)`

Hovers the mouse over a specified UI element, identified by the TargetAnchorableModel object, while customizing the hover action.

Hover(
    TargetAnchorableModel target,
    HoverOptions hoverOptions)
Hover(
    TargetAnchorableModel target,
    HoverOptions hoverOptions)

target TargetAnchorableModel : The UI element that you want to hover, identified by the TargetAnchorableModel object.

hoverOptions HoverOptions : Additional options to customize the hover action. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in
    seconds) to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after
    executing the API. The default amount of time is 0.3 seconds
    (300 milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the
    API begins performing any operations. The default amount of
    time is 0.2 seconds (200 milliseconds).
* `HoverTime` - The number of seconds for which to
  hover the target element. The default value is 1 second.
* `CursorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `VerifyOptions` - At runtime, verifies if the action
  performed by the API was correct. This is done by indicating an
  element that should appear or disappear after the action is
  performed, which is monitored and verified after the API is
  executed.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in
    seconds) to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after
    executing the API. The default amount of time is 0.3 seconds
    (300 milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the
    API begins performing any operations. The default amount of
    time is 0.2 seconds (200 milliseconds).
* `HoverTime` - The number of seconds for which to
  hover the target element. The default value is 1 second.
* `CursorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `VerifyOptions` - At runtime, verifies if the action
  performed by the API was correct. This is done by indicating an
  element that should appear or disappear after the action is
  performed, which is monitored and verified after the API is
  executed.

`Hover(IElementDescriptor, HoverOptions)`

Hovers the mouse over a specified UI element, identified by a descriptor of an element from Object Repository, while customizing the hover action.

Hover(
    IElementDescriptor elementDescriptor,
    HoverOptions hoverOptions)
Hover(
    IElementDescriptor elementDescriptor,
    HoverOptions hoverOptions)

elementDescriptor IElementDescriptor : The UI element that you want to hover, identified by a descriptor of an element from Object Repository.

hoverOptions HoverOptions : Additional options to customize the hover action. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in
    seconds) to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after
    executing the API. The default amount of time is 0.3 seconds
    (300 milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the
    API begins performing any operations. The default amount of
    time is 0.2 seconds (200 milliseconds).
* `HoverTime` - The number of seconds for which to
  hover the target element. The default value is 1 second.
* `CursorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `VerifyOptions` - At runtime, verifies if the action
  performed by the API was correct. This is done by indicating an
  element that should appear or disappear after the action is
  performed, which is monitored and verified after the API is
  executed.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in
    seconds) to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after
    executing the API. The default amount of time is 0.3 seconds
    (300 milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the
    API begins performing any operations. The default amount of
    time is 0.2 seconds (200 milliseconds).
* `HoverTime` - The number of seconds for which to
  hover the target element. The default value is 1 second.
* `CursorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `VerifyOptions` - At runtime, verifies if the action
  performed by the API was correct. This is done by indicating an
  element that should appear or disappear after the action is
  performed, which is monitored and verified after the API is
  executed.

`Hover(String, HoverOptions)`

Hovers the mouse over a specified UI element, identified by a string from Object Repository, while customizing the hover action.

Hover(
    string target,
    HoverOptions hoverOptions)
Hover(
    string target,
    HoverOptions hoverOptions)

target String : The UI element that you want to hover, identified by a string from Object Repository.

hoverOptions HoverOptions : Additional options to customize the hover action. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in
    seconds) to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after
    executing the API. The default amount of time is 0.3 seconds
    (300 milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the
    API begins performing any operations. The default amount of
    time is 0.2 seconds (200 milliseconds).
* `HoverTime` - The number of seconds for which to
  hover the target element. The default value is 1 second.
* `CursorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `VerifyOptions` - At runtime, verifies if the action
  performed by the API was correct. This is done by indicating an
  element that should appear or disappear after the action is
  performed, which is monitored and verified after the API is
  executed.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in
    seconds) to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after
    executing the API. The default amount of time is 0.3 seconds
    (300 milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the
    API begins performing any operations. The default amount of
    time is 0.2 seconds (200 milliseconds).
* `HoverTime` - The number of seconds for which to
  hover the target element. The default value is 1 second.
* `CursorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `VerifyOptions` - At runtime, verifies if the action
  performed by the API was correct. This is done by indicating an
  element that should appear or disappear after the action is
  performed, which is monitored and verified after the API is
  executed.

`Hover(RuntimeTarget, HoverOptions)`

Hovers the mouse over a specified UI element, identified by a runtime instance of an Object Repository element, while customizing the hover action.

Hover(
    RuntimeTarget target,
    HoverOptions hoverOptions)
Hover(
    RuntimeTarget target,
    HoverOptions hoverOptions)

target RuntimeTarget : The UI element that you want to hover, identified by a runtime instance of an Object Repository element.

hoverOptions HoverOptions : Additional options to customize the hover action. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in
    seconds) to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after
    executing the API. The default amount of time is 0.3 seconds
    (300 milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the
    API begins performing any operations. The default amount of
    time is 0.2 seconds (200 milliseconds).
* `HoverTime` - The number of seconds for which to
  hover the target element. The default value is 1 second.
* `CursorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `VerifyOptions` - At runtime, verifies if the action
  performed by the API was correct. This is done by indicating an
  element that should appear or disappear after the action is
  performed, which is monitored and verified after the API is
  executed.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in
    seconds) to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after
    executing the API. The default amount of time is 0.3 seconds
    (300 milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the
    API begins performing any operations. The default amount of
    time is 0.2 seconds (200 milliseconds).
* `HoverTime` - The number of seconds for which to
  hover the target element. The default value is 1 second.
* `CursorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `VerifyOptions` - At runtime, verifies if the action
  performed by the API was correct. This is done by indicating an
  element that should appear or disappear after the action is
  performed, which is monitored and verified after the API is
  executed.

`Hover(TargetAnchorableModel, Double, CursorMotionType)`

Hovers the mouse over a specified UI element, identified by the TargetAnchorableModel object, while specifying the hover time and the cursor motion type.

Hover(
    TargetAnchorableModel target,
    double hoverTime,
    [CursorMotionType cursorMotionType])
Hover(
    TargetAnchorableModel target,
    double hoverTime,
    [CursorMotionType cursorMotionType])

target TargetAnchorableModel : The UI element that you want to hover, identified by the TargetAnchorableModel object.

hoverTime Double : The number of seconds for which to hover the target element. The default value is 1 second.

cursorMotionType CursorMotionType : Specifies the type of motion performed by the mouse cursor. There are two available options:

* **Instant** - The cursor jumps to the destination. By default,
  **Instant** is selected.
* **Smooth** - The cursor moves gradually towards the
  destination.
* **Instant** - The cursor jumps to the destination. By default,
  **Instant** is selected.
* **Smooth** - The cursor moves gradually towards the
  destination.