Skip to content

AppianCheckbox

AppianCheckbox represents a true Appian checkbox. Create it with page.checkbox(...).

include_details = page.checkbox(
    label="Include Details"
)

Check a checkbox

include_details.check()

check() first reads the native checked state. If the checkbox is already checked, nothing happens.

Uncheck a checkbox

include_details.uncheck()

uncheck() first reads the native checked state. If the checkbox is already unchecked, nothing happens.

Read the state

if include_details.is_checked():
    print("Details are included")

You can also set the desired state directly:

include_details.set_checked(True)
include_details.set_checked(False)

Use AppianRadioSelect for radio-button groups.

API

AppianCheckbox

Bases: AppianInputComponent

Represent an Appian native checkbox identified by visible label text.

The component supports the two semantic checkbox structures used by Appian:

  • a visible label[for] linked directly to input[type='checkbox'];
  • a boolean field label whose id is referenced by role='group' via aria-labelledby.

Generated Appian CSS classes are intentionally not used for identification.

is_visible 

is_visible() -> bool

Return whether a matching checkbox currently exists in this scope.

is_checked 

is_checked(timeout: float | None = None) -> bool

Return the checkbox's current checked state.

Parameters:

Name Type Description Default
timeout float | None

Optional timeout in seconds used only to wait for the checkbox to be attached. Once present, return its current checked state immediately; an unchecked checkbox must not make this method wait for a state transition that was never requested.

 None

check 

check() -> 'AppianCheckbox'

Check the checkbox only when it is currently unchecked.

uncheck 

uncheck() -> 'AppianCheckbox'

Uncheck the checkbox only when it is currently checked.

set_checked 

set_checked(checked: bool) -> 'AppianCheckbox'

Set the checkbox to checked using idempotent state handling.

select 

select(selected: bool = True) -> 'AppianCheckbox'

Compatibility alias for set_checked(selected).

Exact matching and visibility

By default, robo-appian uses a visible component whose displayed name or label exactly matches what you provide. Keep exact=True and visible=True for normal business automation. Use exact=False only when you intentionally want a partial name or label match. Change visible only when your scenario specifically requires a component that is not currently visible.

Timeout

timeout is expressed in seconds. Leave timeout=None to use the normal configured wait time, or provide a positive value when this particular action needs a different wait time.

Identify a checkbox group by header

Use header when the displayed heading is the clearest way to identify the checkbox group:

page.checkbox(header="More Details")

header is the displayed heading used to identify the checkbox or checkbox group.