XlsGroupBoxShape module

class XlsGroupBoxShape.XlsGroupBoxShape

Bases: XlsShape, IGroupBox

Represents a group box shape in an Excel worksheet.

This class provides properties and methods for manipulating group box shapes in Excel, including text display, 3D shading effects, and other formatting options. It extends XlsShape and implements the IGroupBox interface.

property Display3DShading: bool

Gets or sets whether the group box displays with 3D shading.

Returns:

True if the group box displays with 3D shading; otherwise, False.

Return type:

bool

property IsTextLocked: bool

Gets or sets whether the text in the group box is locked.

Returns:

True if the text is locked; otherwise, False.

Return type:

bool

property ShapeType: ExcelShapeType

Gets the type of the shape.

Returns:

An enumeration value representing the type of the shape.

Return type:

ExcelShapeType

property Text: str

Gets or sets the text displayed in the group box.

Returns:

The text displayed in the group box.

Return type:

str