OleControl class

OleControl class

Represents OLE ActiveX control. To learn more, visit the Working with Ole Objects documentation article.

Properties

Name	Description
is_forms2_ole_control	Returns True if the control is a Forms2OleControl.
name	Gets or sets name of the ActiveX control.

Methods

Name	Description
as_check_box_control()
as_forms2_ole_control()
as_option_button_control()
as_text_box_control()

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'

See Also

• module aspose.words.drawing.ole