OptionButtonControl class
OptionButtonControl class
The OptionButton control enables a single choice in a limited set of mutually exclusive choices.
Inheritance: OptionButtonControl → MorphDataControl → Forms2OleControl → OleControl
Properties
| Name | Description |
|---|---|
| back_color | Gets or sets a background color of the control. The default value depends on a type of the control. (Inherited from Forms2OleControl) |
| caption | Gets or sets a Caption property of the control. Default value is an empty string. (Inherited from Forms2OleControl) |
| child_nodes | Gets collection of immediate child controls. (Inherited from Forms2OleControl) |
| enabled | Returns True if control is in enabled state.(Inherited from Forms2OleControl) |
| fore_color | Gets or sets a foreground color of the control. The default value depends on a type of the control. (Inherited from Forms2OleControl) |
| group_name | Gets or sets a string that specifies a group of mutually exclusive controls. The default value is an empty string. (Inherited from Forms2OleControl) |
| height | Gets or sets a height of the control in points. (Inherited from Forms2OleControl) |
| is_forms2_ole_control | Returns True if the control is a Forms2OleControl.(Inherited from OleControl) |
| name | Gets or sets name of the ActiveX control. (Inherited from OleControl) |
| selected | Gets or sets a boolean value indicating either this OptionButtonControl is selected or not. |
| type | Gets type of Forms 2.0 control. |
| value | Gets underlying Value property which often represents control state. For example checked option button has ‘1’ value while unchecked has ‘0’. Default value is an empty string. (Inherited from Forms2OleControl) |
| width | Gets or sets a width of the control in points. (Inherited from Forms2OleControl) |
Methods
| Name | Description |
|---|
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
- module aspose.words.drawing.ole
- class MorphDataControl