caption property

Forms2OleControl.caption property

Gets or sets a Caption property of the control. Default value is an empty string.

@property
def caption(self) -> str:
    ...

@caption.setter
def caption(self, value: str):
    ...

Examples

Shows how to verify the properties of an ActiveX control.

doc = aw.Document(file_name=MY_DIR + 'ActiveX controls.docx')
shape = doc.get_child(aw.NodeType.SHAPE, 0, True).as_shape()
ole_control = shape.ole_format.ole_control
self.assertEqual('CheckBox1', ole_control.name)
if ole_control.is_forms2_ole_control:
    check_box = ole_control.as_forms2_ole_control()
    self.assertEqual('First', check_box.caption)
    self.assertEqual('0', check_box.value)
    self.assertEqual(True, check_box.enabled)
    self.assertEqual(aw.drawing.ole.Forms2OleControlType.CHECK_BOX, check_box.type)
    self.assertEqual(None, check_box.child_nodes)
    self.assertEqual('', check_box.group_name)
    # Note, that you can't set GroupName for a Frame.
    check_box.group_name = 'Aspose group name'

Shows how to set caption for ActiveX control.

builder = aw.DocumentBuilder()
button1 = aw.drawing.ole.CommandButtonControl()
button1.caption = 'Button caption'
shape = builder.insert_forms_2_ole_control(button1)
self.assertEqual('Button caption', shape.ole_format.ole_control.as_forms2_ole_control().caption)

caption property

Forms2OleControl.caption property

Examples

See Also