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

Overload	Description
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.

 [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

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.

 [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

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.

 [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

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.

 [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

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.

 [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

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.

 [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

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).