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)

public static DateTimePicker AddDateTimePicker(
	this ControlCollection controls,
	double left,
	double top,
	double width,
	double height,
	string name
)

Parameters

controls
Type: Microsoft.Office.Tools.Excel.ControlCollection

The collection to add the control to. Do not supply this parameter yourself. When you call this method on the collection returned by the Worksheet.Controls property (in an application-level project) or the WorksheetBase.Controls property (in a document-level project), this parameter is supplied automatically.

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.DateTimePicker

The DateTimePicker control that was added to the ControlCollection instance.

Exception Condition
ArgumentNullException

The name argument is null or has zero length.

ControlNameAlreadyExistsException

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

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.

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 void ExcelAddDateTimePicker()
{

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