Skip to content

ScrollBar

Horizontal and vertical scroll-bar elements. Both expose the shared RangeValue properties from ScrollBarBase plus directional scroll methods. Obtain them via element.as_horizontal_scroll_bar() / element.as_vertical_scroll_bar().

flaui.core.automation_elements.ScrollBarBase

Bases: AutomationElement

Base class for scroll bar elements, exposing the shared RangeValue properties.

is_read_only property

Whether the scroll bar value is read-only.

Returns:

Type Description
bool

True if read-only, else False.

large_change property

The value of a large change (page scroll).

Returns:

Type Description
float

Large change value.

maximum_value property

The maximum scroll value.

Returns:

Type Description
float

Maximum value.

minimum_value property

The minimum scroll value.

Returns:

Type Description
float

Minimum value.

small_change property

The value of a small change (line scroll).

Returns:

Type Description
float

Small change value.

value property

The current scroll value.

Returns:

Type Description
float

Current value.

flaui.core.automation_elements.HorizontalScrollBar

Bases: ScrollBarBase

Class to interact with a horizontal scroll bar element.

scroll_left()

Scroll left by a small amount (line).

Source code in flaui/core/automation_elements.py 
2685
2686
2687
2688
@handle_csharp_exceptions
def scroll_left(self) -> None:
    """Scroll left by a small amount (line)."""
    self.raw_element.ScrollLeft()

scroll_left_large()

Scroll left by a large amount (page).

Source code in flaui/core/automation_elements.py 
2695
2696
2697
2698
@handle_csharp_exceptions
def scroll_left_large(self) -> None:
    """Scroll left by a large amount (page)."""
    self.raw_element.ScrollLeftLarge()

scroll_right()

Scroll right by a small amount (line).

Source code in flaui/core/automation_elements.py 
2690
2691
2692
2693
@handle_csharp_exceptions
def scroll_right(self) -> None:
    """Scroll right by a small amount (line)."""
    self.raw_element.ScrollRight()

scroll_right_large()

Scroll right by a large amount (page).

Source code in flaui/core/automation_elements.py 
2700
2701
2702
2703
@handle_csharp_exceptions
def scroll_right_large(self) -> None:
    """Scroll right by a large amount (page)."""
    self.raw_element.ScrollRightLarge()

flaui.core.automation_elements.VerticalScrollBar

Bases: ScrollBarBase

Class to interact with a vertical scroll bar element.

scroll_down()

Scroll down by a small amount (line).

Source code in flaui/core/automation_elements.py 
2714
2715
2716
2717
@handle_csharp_exceptions
def scroll_down(self) -> None:
    """Scroll down by a small amount (line)."""
    self.raw_element.ScrollDown()

scroll_down_large()

Scroll down by a large amount (page).

Source code in flaui/core/automation_elements.py 
2724
2725
2726
2727
@handle_csharp_exceptions
def scroll_down_large(self) -> None:
    """Scroll down by a large amount (page)."""
    self.raw_element.ScrollDownLarge()

scroll_up()

Scroll up by a small amount (line).

Source code in flaui/core/automation_elements.py 
2709
2710
2711
2712
@handle_csharp_exceptions
def scroll_up(self) -> None:
    """Scroll up by a small amount (line)."""
    self.raw_element.ScrollUp()

scroll_up_large()

Scroll up by a large amount (page).

Source code in flaui/core/automation_elements.py 
2719
2720
2721
2722
@handle_csharp_exceptions
def scroll_up_large(self) -> None:
    """Scroll up by a large amount (page)."""
    self.raw_element.ScrollUpLarge()