Forms2OleControl class

Forms2OleControl class

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

Inheritance: Forms2OleControl → OleControl

Properties

NameDescription
captionGets Caption property of control. Default value is an empty string.
child_nodesGets collection of immediate child controls.
enabledReturns True if control is in enabled state.
group_nameGets or sets a string that specifies a group of mutually exclusive controls. The default value is an empty string.
is_forms2_ole_controlReturns True if the control is a Forms2OleControl.
(Inherited from OleControl)
nameGets or sets name of the ActiveX control.
(Inherited from OleControl)
typeGets type of Forms 2.0 control.
valueGets 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.

Methods

NameDescription
as_text_box_control()Casts Forms2OleControl to TextBoxControl, otherwise returns null.

Examples

Shows how to verify the properties of an ActiveX control.

doc = aw.Document(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("Первый", 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.assertIsNone(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

Forms2OleControlCollection class