Forms2OleControl

Forms2OleControl class

Represents Microsoft Forms 2.0 OLE control.

To learn more, visit the Working with Ole Objects documentation article.

public abstract class Forms2OleControl : OleControl

Properties

NameDescription
BackColor { get; set; }Gets or sets a background color of the control. The default value depends on a type of the control.
Caption { get; set; }Gets or sets a Caption property of the control. Default value is an empty string.
virtual ChildNodes { get; }Gets collection of immediate child controls.
Enabled { get; }Returns true if control is in enabled state.
ForeColor { get; set; }Gets or sets a foreground color of the control. The default value depends on a type of the control.
GroupName { get; set; }Gets or sets a string that specifies a group of mutually exclusive controls. The default value is an empty string.
Height { get; set; }Gets or sets a height of the control in points.
IsForms2OleControl { get; }Returns true if the control is a Forms2OleControl.
Name { get; set; }Gets or sets name of the ActiveX control.
abstract Type { get; }Gets type of Forms 2.0 control.
Value { get; }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.
Width { get; set; }Gets or sets a width of the control in points.

Examples

Shows how to verify the properties of an ActiveX control.

Document doc = new Document(MyDir + "ActiveX controls.docx");

Shape shape = (Shape)doc.GetChild(NodeType.Shape, 0, true);
OleControl oleControl = shape.OleFormat.OleControl;

Assert.AreEqual("CheckBox1", oleControl.Name);

if (oleControl.IsForms2OleControl)
{
    Forms2OleControl checkBox = (Forms2OleControl)oleControl;
    Assert.AreEqual("First", checkBox.Caption);
    Assert.AreEqual("0", checkBox.Value);
    Assert.AreEqual(true, checkBox.Enabled);
    Assert.AreEqual(Forms2OleControlType.CheckBox, checkBox.Type);
    Assert.AreEqual(null, checkBox.ChildNodes);
    Assert.AreEqual(string.Empty, checkBox.GroupName);

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

See Also

CommandButtonControl Class Forms2OleControlCollection Class