XlsScrollBarShape module

class XlsScrollBarShape.XlsScrollBarShape

Bases: XlsShape, IScrollBarShape

Represents a scroll bar control in an Excel worksheet.

This class provides properties and methods for manipulating scroll bar controls, including value ranges, appearance, and orientation.

property CurrentValue: int

Gets or sets the current value of the scroll bar.

The value must be between Min and Max properties.

Returns:

The current value of the scroll bar.

Return type:

int

property Display3DShading: bool

Gets or sets whether the scroll bar displays with 3D shading.

Returns:

True if the scroll bar has 3D shading; otherwise, False.

Return type:

bool

property IncrementalChange: int

Gets or sets the small change value for the scroll bar.

This is the value that changes when the user clicks on the scroll arrows.

Returns:

The small change value for the scroll bar.

Return type:

int

property IsHorizontal: bool

Gets or sets whether the scroll bar is horizontal.

Returns:

True if the scroll bar is horizontal; False if it is vertical.

Return type:

bool

property Max: int

Gets or sets the maximum value of the scroll bar.

Returns:

The maximum value of the scroll bar.

Return type:

int

property Min: int

Gets or sets the minimum value of the scroll bar.

Returns:

The minimum value of the scroll bar.

Return type:

int

property PageChange: int

Gets or sets the large change value for the scroll bar.

This is the value that changes when the user clicks on the scroll bar area between the thumb and the arrows.

Returns:

The large change value for the scroll bar.

Return type:

int

property ShapeType: ExcelShapeType

Gets the shape type of the scroll bar.

Returns:

An enumeration value representing the shape type.

Return type:

ExcelShapeType