ControlCollection.AddDateTimePicker Method (Range, String) (2007 System) (2007 System)

AddDateTimePicker Method (Range, St...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

Visual Studio Tools for Office API Reference

ControlCollection..::.AddDateTimePicker Method (Range, String) (2007 System)

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

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

Syntax

Visual Basic (Declaration)

Public Function AddDateTimePicker ( _
    range As Range, _
    name As String _
) As DateTimePicker

Visual Basic (Usage)

Dim instance As ControlCollection
Dim range As Range
Dim name As String
Dim returnValue As DateTimePicker

returnValue = instance.AddDateTimePicker(range, _
    name)

public DateTimePicker AddDateTimePicker(
    Range range,
    string name
)

Parameters

range: Type: Microsoft.Office.Interop.Excel..::.Range
A Range that provides the bounds for the control.

name: Type: System..::.String
The name of the control that can be used to index the control in the ControlCollection instance.

Return Value

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

Exceptions

Exception	Condition
ArgumentNullException	The name or range argument is nullNothingnullptra 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 AddDateTimePicker method enables you to add DateTimePicker objects to the end of the ControlCollection. To remove a DateTimePicker 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 DateTimePicker control to cells A1 through C1, and then sets the background of the calendar to light blue.

Visual Basic

Private Sub ExcelRangeAddDateTimePicker()

    Dim DateTimePicker1 As Microsoft.Office.Tools. _
        Excel.Controls.DateTimePicker = Me.Controls. _
        AddDateTimePicker(Me.Range("A1", "C1"), _
        "DateTimePicker1")
    DateTimePicker1.CalendarMonthBackground = _
        Color.LightBlue

End Sub

private void ExcelRangeAddDateTimePicker()
{

    Microsoft.Office.Tools.Excel.Controls.DateTimePicker
        dateTimePicker1 = this.Controls.AddDateTimePicker(
        this.Range["A1", "C1"], "dateTimePicker1");
    dateTimePicker1.CalendarMonthBackground = Color.LightBlue;
}

Permissions

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.

Reference

ControlCollection Class

ControlCollection Members

AddDateTimePicker Overload

Microsoft.Office.Tools.Excel Namespace