Share via


ControlExtensions.AddCheckBox Method (ControlCollection, Range, String)

Adds a new CheckBox control to the worksheet at the range specified.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function AddCheckBox ( _
    controls As ControlCollection, _
    range As Range, _
    name As String _
) As CheckBox
public static CheckBox AddCheckBox(
    this ControlCollection controls,
    Range range,
    string name
)

Parameters

  • range
    Type: Range

    A Range that provides the bounds for the control.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.CheckBox
The CheckBox control that was added to the ControlCollection instance

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ControlCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception Condition
ArgumentNullException

The name or range argument is nulla null reference (Nothing in Visual Basic), or the name argument has zero length.

ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection instance.

InvalidRangeException

The range that was specified is not valid. Multi-area ranges cannot be used. The range should be on the same worksheet as the ControlCollection instance.

Remarks

The AddCheckBox method enables you to add CheckBox objects to the end of the ControlCollection. To remove a CheckBox control that was previously added programmatically, use the Remove method.

The control automatically resizes when the range is resized.

Examples

The following code example adds a CheckBox control to cell A1, and then adds text to the check box. To use this example, run it from the Sheet1 class in a document-level project.

Private Sub ExcelRangeAddCheckBox()

        Dim checkBox1 As Microsoft.Office.Tools.Excel. _
            Controls.CheckBox = Me.Controls.AddCheckBox( _
            Me.Range("A1"), "checkBox1")
        checkBox1.Text = "Underline" 

    End Sub
private void ExcelRangeAddCheckBox()
{

    Microsoft.Office.Tools.Excel.Controls.CheckBox checkBox1 =
        this.Controls.AddCheckBox(this.Range["A1"], 
        "checkBox1");
    checkBox1.Text = "Underline";
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddCheckBox Overload

Microsoft.Office.Tools.Excel Namespace