selected property

OptionButtonControl.selected property

Gets or sets a boolean value indicating either this OptionButtonControl is selected or not.

@property
def selected(self) -> bool:
    ...

@selected.setter
def selected(self, value: bool):
    ...

Remarks

Note, this property allows you to select multiple items in a group of OptionButtonControl with the same Forms2OleControl.group_name. It is up to you to take care of deselecting a previously selected item when you make this OptionButtonControl selected.

Examples

Shows how to select radio button.

doc = aw.Document(file_name=MY_DIR + 'Radio buttons.docx')
shape1 = doc.get_child(aw.NodeType.SHAPE, 0, True).as_shape()
option_button1 = shape1.ole_format.ole_control.as_option_button_control()
# Deselect selected first item.
option_button1.selected = False
shape2 = doc.get_child(aw.NodeType.SHAPE, 1, True).as_shape()
option_button2 = shape2.ole_format.ole_control.as_option_button_control()
# Select second option button.
option_button2.selected = True
self.assertEqual(aw.drawing.ole.Forms2OleControlType.OPTION_BUTTON, option_button1.type)
self.assertEqual(aw.drawing.ole.Forms2OleControlType.OPTION_BUTTON, option_button2.type)
doc.save(file_name=ARTIFACTS_DIR + 'Shape.SelectRadioControl.docx')

See Also

OptionButtonControl.type property