activities
latest
false
UiPath logo, featuring letters U and I in white
UI Automation Activities
Last updated Nov 25, 2024

Check

Selects or clears a check box or a radio button.

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
Check(String, CheckOptions)Checks or unchecks a box or radio button, identified by a string from the Object Repository.
Check(IElementDescriptor, CheckOptions)Checks or unchecks a box or radio button, identified by a descriptor of an element from Object Repository, while customizing the check action.
Check(String, NCheckType)Checks or unchecks a box or radio button, identified by a string from the Object Repository, while customizing the check type.
Check(TargetAnchorableModel, CheckOptions)Checks or unchecks a box or radio button, identified by the TargetAnchorableModel object, while customizing the check action.
Check(RuntimeTarget, CheckOptions)Checks or unchecks a box or radio button, identified by a runtime instance of an Object Repository element, while customizing the check action.
Check(IElementDescriptor, NCheckType)Checks or unchecks a box or radio button, identified by a descriptor of an element from Object Repository, while customizing the check type.

Check(String, CheckOptions)

Checks or unchecks a box or radio button, identified by its string target.

Check(
    string target, 
    CheckOptions checkOptions)Check(
    string target, 
    CheckOptions checkOptions)
target String
Indicate the radio button or check box, from the Object Repository, to select or clear.
checkOptions CheckOptions
CheckType NCheckType - The action to perform:
  • Check - Select a check box or radio button.
  • Uncheck - Clear a check box.
  • Toggle - Switch the state of a check box (select if cleared and clear if selected).
AlterIfDisabled Boolean - When true, the API executes the action even if the target element is disabled. The default value is false.

Check(IElementDescriptor, CheckOptions)

Checks or unchecks a box or radio button, identified by a descriptor of an element from Object Repository, while customizing the check action.
Check(
    IElementDescriptor elementDescriptor,
    CheckOptions checkOptions)Check(
    IElementDescriptor elementDescriptor,
    CheckOptions checkOptions)
IElementDescriptor elementDescriptor
The descriptor of an element from Object Repository that you want to check or uncheck.
checkOptions CheckOptions
CheckType NCheckType - The action to perform:
  • Check - Select a check box or radio button.
  • Uncheck - Clear a check box.
  • Toggle - Switch the state of a check box (select if cleared and clear if selected).
AlterIfDisabled Boolean - When true, the API executes the action even if the target element is disabled. The default value is false.

Check(String, NCheckType)

Checks or unchecks a box or radio button, identified by its string target, while customizing the check type. 

Check(
    string target, 
    NCheckType checkType)Check(
    string target, 
    NCheckType checkType)
target String
Indicate the radio button or check box, from the Object Repository, to select or clear.
checkType NCheckType
The action to perform:
  • Check - Select a check box or radio button.
  • Uncheck - Clear a check box.
  • Toggle - Switch the state of a check box (select if cleared and clear if selected).

Check(TargetAnchorableModel, CheckOptions)

Checks or unchecks a box or radio button, identified by the TargetAnchorableModel object, while customizing the check action.
Check(
    TargetAnchorableModel target,
    CheckOptions checkOptions)Check(
    TargetAnchorableModel target,
    CheckOptions checkOptions)
target TargetAnchorableModel
The target anchorable model (UI element) that you want to check or uncheck.
checkOptions CheckOptions
CheckType NCheckType - The action to perform:
  • Check - Select a check box or radio button.
  • Uncheck - Clear a check box.
  • Toggle - Switch the state of a check box (select if cleared and clear if selected).
AlterIfDisabled Boolean - When true, the API executes the action even if the target element is disabled. The default value is false.

Check(RuntimeTarget, CheckOptions)

Checks or unchecks a box or radio button, identified by a runtime instance of an Object Repository element, while customizing the check action. 

Check(
    RuntimeTarget target,
    CheckOptions checkOptions)Check(
    RuntimeTarget target,
    CheckOptions checkOptions)
RuntimeTarget target
The runtime instance of an Object Repository element that you want to check or uncheck.
checkOptions CheckOptions
CheckType NCheckType - The action to perform:
  • Check - Select a check box or radio button.
  • Uncheck - Clear a check box.
  • Toggle - Switch the state of a check box (select if cleared and clear if selected).
AlterIfDisabled Boolean - When true, the API executes the action even if the target element is disabled. The default value is false.

Check(IElementDescriptor, NCheckType)

Checks or unchecks a box or radio button, identified by a descriptor of an element from Object Repository, while customizing the check type. 

Check(
    IElementDescriptor elementDescriptor,
    NCheckType checkType)Check(
    IElementDescriptor elementDescriptor,
    NCheckType checkType)
IElementDescriptor elementDescriptor
The descriptor of an element from Object Repository that you want to check or uncheck.
checkType NCheckType
The action to perform:
  • Check - Select a check box or radio button.
  • Uncheck - Clear a check box.
  • Toggle - Switch the state of a check box (select if cleared and clear if selected).

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2024 UiPath. All rights reserved.