TextBoxShapeBase module

class TextBoxShapeBase.TextBoxShapeBase

Bases: ITextBoxShape

Base abstract class for text box shapes in Excel.

This class implements the ITextBoxShape interface and provides the foundation for text box shapes in Excel worksheets. It defines abstract properties for text wrapping, margins, inset mode, and fill color that derived classes must implement.

abstract property FillColor: Color

Gets or sets the fill color of the text box.

Returns:: The fill color object.
Return type:: Color

abstract property InnerBottomMargin: float

Gets or sets the bottom margin within the text box in points.

Returns:: The bottom margin value in points.
Return type:: float

abstract property InnerLeftMargin: float

Gets or sets the left margin within the text box in points.

Returns:: The left margin value in points.
Return type:: float

abstract property InnerRightMargin: float

Gets or sets the right margin within the text box in points.

Returns:: The right margin value in points.
Return type:: float

abstract property InnerTopMargin: float

Gets or sets the top margin within the text box in points.

Returns:: The top margin value in points.
Return type:: float

abstract property InsetMode: str

Gets or sets the inset mode for the text box.

The inset mode determines how text is positioned within the text box.

Returns:: The inset mode string.
Return type:: str

abstract property IsWrapText: bool

Gets or sets whether text is wrapped within the text box.

Returns:: True if text wrapping is enabled; otherwise, False.
Return type:: bool