Activities
latest
false
UI Automation Activities
Last updated 7 juin 2024

IsEnabled

Checks if an UI element is enabled.

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

OverloadDescription
IsEnabled(String)Checks if an UI element is enabled, identified by a string from Object Repository.
IsEnabled(IElementDescriptor)Checks if an UI element is enabled, identified by a descriptor of an element from Object Repository.
IsEnabled(IElementDescriptor, IsEnabledOptions)Checks if an UI element is enabled, identified by a descriptor of an element from Object Repository, along with other options.
IsEnabled(String, IsEnabledOptions)Checks if an UI element is enabled, identified by a string from Object Repository, along with other options.
IsEnabled(TargetAnchorableModel, IsEnabledOptions)Checks if an UI element is enabled, identified by the TargetAnchorableModel object, along with other options.
IsEnabled(RuntimeTarget, IsEnabledOptions)Checks if an UI element is enabled, identified by a runtime instance of an Object Repository element, along with other options.

IsEnabled(String)

Checks if an UI element is enabled, identified by a string from Object Repository.

IsEnabled(
    string target)IsEnabled(
    string target)
target String
The UI element that you want to check if it's enabled, identified by a string from Object Repository.

IsEnabled(IElementDescriptor)

Checks if an UI element is enabled, identified by a descriptor of an element from Object Repository.

IsEnabled(
    IElementDescriptor elementDescriptor)IsEnabled(
    IElementDescriptor elementDescriptor)
elementDescriptor IElementDescriptor
The UI element that you want to check if it's enabled, identified by a descriptor of an element from Object Repository.

IsEnabled(IElementDescriptor, IsEnabledOptions)

Checks if an UI element is enabled, identified by a descriptor of an element from Object Repository, along with other options.

IsEnabled(
    IElementDescriptor elementDescriptor,
    IsEnabledOptions isEnabledOptions)IsEnabled(
    IElementDescriptor elementDescriptor,
    IsEnabledOptions isEnabledOptions)
elementDescriptor IElementDescriptor
The UI element that you want to check if it's enabled, identified by a descriptor of an element from Object Repository.
isEnabledOptions IsEnabledOptions
Additional options to customize the verification process. 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).

IsEnabled(String, IsEnabledOptions)

Checks if an UI element is enabled, identified by a string from Object Repository, along with other options.

IsEnabled(
    string target,
    IsEnabledOptions isEnabledOptions)IsEnabled(
    string target,
    IsEnabledOptions isEnabledOptions)
target String
The UI element that you want to check if it's enabled, identified by a string from Object Repository.
isEnabledOptions IsEnabledOptions
Additional options to customize the verification process. 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).

IsEnabled(TargetAnchorableModel, IsEnabledOptions)

Checks if an UI element is enabled, identified by the TargetAnchorableModel object, along with other options.
IsEnabled(
    TargetAnchorableModel target,
    IsEnabledOptions isEnabledOptions)IsEnabled(
    TargetAnchorableModel target,
    IsEnabledOptions isEnabledOptions)
target TargetAnchorableModel
The UI element that you want to check if it's enabled, identified by the TargetAnchorableModel object.
isEnabledOptions IsEnabledOptions
Additional options to customize the verification process. 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).

IsEnabled(RuntimeTarget, IsEnabledOptions)

Checks if an UI element is enabled, identified by a runtime instance of an Object Repository element, along with other options.

IsEnabled(
    RuntimeTarget target,
    [IsEnabledOptions isEnabledOptions])IsEnabled(
    RuntimeTarget target,
    [IsEnabledOptions isEnabledOptions])
target RuntimeTarget
The UI element that you want to check if it's enabled, identified by a runtime instance of an Object Repository element.
isEnabledOptions IsEnabledOptions
Additional options to customize the verification process. 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).

Return value

The True of False value based on whether the UI element is enabled or not.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.