ControlCollection.AddCheckBox Method (Double, Double, Double, Double, String) (2007 System)

Article
09/25/2012

Adds a new CheckBox control to the worksheet in the specified size and location.

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

Syntax

'Declaration
Public Function AddCheckBox ( _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As CheckBox

'Usage
Dim instance As ControlCollection 
Dim left As Double 
Dim top As Double 
Dim width As Double 
Dim height As Double 
Dim name As String 
Dim returnValue As CheckBox 

returnValue = instance.AddCheckBox(left, _
    top, width, height, name)

public CheckBox AddCheckBox(
    double left,
    double top,
    double width,
    double height,
    string name
)

public:
CheckBox^ AddCheckBox(
    double left, 
    double top, 
    double width, 
    double height, 
    String^ name
)

public function AddCheckBox(
    left : double, 
    top : double, 
    width : double, 
    height : double, 
    name : String
) : CheckBox

Parameters

left
Type: System.Double

The distance in points between the left edge of the control and the left edge of the worksheet.

top
Type: System.Double

The distance in points between the top edge of the control and the top edge of the worksheet.

width
Type: System.Double

The width of the control in points.

height
Type: System.Double

The height of the control in points.

name
Type: System.String

The name of the control.

Return Value

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

Exceptions

Exception	Condition
ArgumentNullException	The name argument is nulla null reference (Nothing in Visual Basic) or has zero length.
ControlNameAlreadyExistsException	A control with the same name is already in 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.

Examples

The following code example adds a CheckBox control to the top of the worksheet, and then adds text to the check box.

Private Sub ExcelAddCheckBox()

    Dim CheckBox1 As Microsoft.Office.Tools.Excel. _
        Controls.CheckBox = Me.Controls.AddCheckBox( _
        0, 0, 78, 18, "CheckBox1")
    CheckBox1.Text = "Underline" 

End Sub

private void ExcelAddCheckBox()
{
    Microsoft.Office.Tools.Excel.Controls.CheckBox checkBox1 =
        this.Controls.AddCheckBox(0, 0, 78, 18, "checkBox1");
    checkBox1.Text = "Underline";
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via