XlsRadioButtonShape module
- class XlsRadioButtonShape.XlsRadioButtonShape
Bases:
XlsShape,IRadioButtonRepresents a radio button control in an Excel worksheet.
This class provides properties and methods for manipulating radio button controls, including text, state, and alignment.
- property CheckState: CheckState
Gets or sets the check state of the radio button.
- Returns:
An enumeration value representing the check state.
- Return type:
CheckState
- property Display3DShading: bool
Gets or sets whether the radio button displays with 3D shading.
- Returns:
True if the radio button has 3D shading; otherwise, False.
- Return type:
bool
- property HAlignment: CommentHAlignType
Gets or sets the horizontal alignment of text in the radio button.
- Returns:
An enumeration value representing the horizontal alignment.
- Return type:
CommentHAlignType
- property IsFirstButton: bool
Gets whether this radio button is the first in its group.
Radio buttons in the same group are mutually exclusive. The first button in a group defines the start of a new group.
- Returns:
True if this is the first button in its group; otherwise, False.
- Return type:
bool
- property IsTextLocked: bool
Gets or sets whether the text in the radio button is locked.
- Returns:
True if the text is locked; otherwise, False.
- Return type:
bool
- property LinkedCell: IXLSRange
Gets or sets the cell linked to the radio button state.
The linked cell will contain the value of the radio button’s state.
- Returns:
A cell range object representing the linked cell.
- Return type:
IXLSRange
- SetRichText(value: RichTextString)
Sets rich text formatting for the radio button text.
- Parameters:
value (RichTextString) – A rich text string object containing the formatted text.
- property ShapeType: ExcelShapeType
Gets the shape type of the radio button.
- Returns:
An enumeration value representing the shape type.
- Return type:
ExcelShapeType
- property Text: str
Gets or sets the text displayed next to the radio button.
- Returns:
The text label of the radio button.
- Return type:
str
- property TextRotation: TextRotationType
Gets or sets the text rotation in the radio button.
- Returns:
An enumeration value representing the text rotation.
- Return type:
TextRotationType
- property VAlignment: CommentVAlignType
Gets or sets the vertical alignment of text in the radio button.
- Returns:
An enumeration value representing the vertical alignment.
- Return type:
CommentVAlignType