Forms2OleControl class

Forms2OleControl class

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

Inheritance: Forms2OleControlOleControl

Properties

NameDescription
backColorGets or sets a background color of the control. The default value depends on a type of the control.
captionGets or sets a Caption property of the control. Default value is an empty string.
childNodesGets collection of immediate child controls.
enabledReturns true if control is in enabled state.
foreColorGets or sets a foreground color of the control. The default value depends on a type of the control.
groupNameGets or sets a string that specifies a group of mutually exclusive controls. The default value is an empty string.
heightGets or sets a height of the control in points.
isForms2OleControlReturns 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.
widthGets or sets a width of the control in points.

Methods

NameDescription
asCheckBoxControl()
(Inherited from OleControl)
asForms2OleControl()
(Inherited from OleControl)
asOptionButtonControl()
(Inherited from OleControl)
asTextBoxControl()
(Inherited from OleControl)

Examples

Shows how to verify the properties of an ActiveX control.

let doc = new aw.Document(base.myDir + "ActiveX controls.docx");

let shape = doc.getShape(0, true);
let oleControl = shape.oleFormat.oleControl;

expect(oleControl.name).toEqual("CheckBox1");

if (oleControl.isForms2OleControl)
{
  console.log(oleControl);
  let checkBox = oleControl.asForms2OleControl();
  expect(checkBox.caption).toEqual("First");
  expect(checkBox.value).toEqual("0");
  expect(checkBox.enabled).toEqual(true);
  expect(checkBox.type).toEqual(aw.Drawing.Ole.Forms2OleControlType.CheckBox);
  expect(checkBox.childNodes).toEqual(null);
  expect(checkBox.groupName).toEqual('');

  // Note, that you can't set GroupName for a Frame.
  checkBox.groupName = "Aspose group name";
}

See Also