XlsCheckBoxShape module
- class XlsCheckBoxShape.XlsCheckBoxShape
Bases:
XlsShape,ICheckBoxRepresents a checkbox shape in an Excel worksheet.
This class provides properties and methods for manipulating checkbox shapes in Excel, including check state, text formatting, alignment, and rotation. It extends XlsShape and implements the ICheckBox interface.
- property CheckState: CheckState
Gets or sets the check state of the checkbox.
- Returns:
An enumeration value representing the check state (checked, unchecked, or mixed).
- Return type:
CheckState
- property Display3DShading: bool
Gets or sets whether the checkbox displays 3D shading.
- Returns:
True if 3D shading is displayed; otherwise, False.
- Return type:
bool
- property HAlignment: CommentHAlignType
Gets or sets the horizontal alignment of the text next to the checkbox.
- Returns:
An enumeration value representing the horizontal alignment.
- Return type:
CommentHAlignType
- property IsTextLocked: bool
Gets or sets whether the text next to the checkbox 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 next to the checkbox.
- Returns:
The text displayed next to the checkbox.
- Return type:
str
- property TextRotation: TextRotationType
Gets or sets the rotation of the text next to the checkbox.
- Returns:
An enumeration value representing the text rotation type.
- Return type:
TextRotationType
- property VAlignment: CommentVAlignType
Gets or sets the vertical alignment of the text next to the checkbox.
- Returns:
An enumeration value representing the vertical alignment.
- Return type:
CommentVAlignType