Share via


ControlExtensions.AddDateTimePicker Method (ControlCollection, Double, Double, Double, Double, String)

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

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 AddDateTimePicker ( _
    controls As ControlCollection, _
    left As Double, _
    top As Double, _
    width As Double, _
    height As Double, _
    name As String _
) As DateTimePicker
public static DateTimePicker AddDateTimePicker(
    this ControlCollection controls,
    double left,
    double top,
    double width,
    double height,
    string name
)

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.

  • height
    Type: System.Double

    The height of the control in points.

Return Value

Type: Microsoft.Office.Tools.Excel.Controls.DateTimePicker
The DateTimePicker 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 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 AddDateTimePicker method enables you to add DateTimePicker objects to the end of the ControlCollection. To remove a DateTimePicker control that was previously added programmatically, use the Remove method.

Examples

The following code example adds a DateTimePicker control to the top of the worksheet, and then sets the background of the calendar to light blue. To use this example, run it from the Sheet1 class in a document-level project.

Private Sub ExcelAddDateTimePicker()

        Dim DateTimePicker1 As Microsoft.Office.Tools. _
            Excel.Controls.DateTimePicker = Me.Controls. _
            AddDateTimePicker(0, 0, 150, 15, _
            "DateTimePicker1")
        DateTimePicker1.CalendarMonthBackground = _
            Color.LightBlue

    End Sub
private void ExcelAddDateTimePicker()
{

    Microsoft.Office.Tools.Excel.Controls.DateTimePicker
        dateTimePicker1 = this.Controls.AddDateTimePicker(
        0, 0, 150, 15, "dateTimePicker1");
    dateTimePicker1.CalendarMonthBackground = Color.LightBlue;
}

.NET Framework Security

See Also

Reference

ControlExtensions Class

AddDateTimePicker Overload

Microsoft.Office.Tools.Excel Namespace