ControlExtensions.AddNumericUpDown Method

Definition

Overloads

AddNumericUpDown(ControlCollection, Range, String)

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

AddNumericUpDown(ControlCollection, Double, Double, Double, Double, String)

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

AddNumericUpDown(ControlCollection, Range, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Excel::Controls::NumericUpDown ^ AddNumericUpDown(Microsoft::Office::Tools::Excel::ControlCollection ^ controls, Microsoft::Office::Interop::Excel::Range ^ range, System::String ^ name);
public static Microsoft.Office.Tools.Excel.Controls.NumericUpDown AddNumericUpDown (this Microsoft.Office.Tools.Excel.ControlCollection controls, Microsoft.Office.Interop.Excel.Range range, string name);
static member AddNumericUpDown : Microsoft.Office.Tools.Excel.ControlCollection * Microsoft.Office.Interop.Excel.Range * string -> Microsoft.Office.Tools.Excel.Controls.NumericUpDown
<Extension()>
Public Function AddNumericUpDown (controls As ControlCollection, range As Range, name As String) As NumericUpDown

Parameters

controls
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 Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

range
Range

A Range that provides the bounds for the control.

name
String

The name of the control that can be used to index the control in the ControlCollection instance.

Returns

The NumericUpDown control that was added to the ControlCollection instance.

Exceptions

The name or range argument is null, or the name argument has zero length.

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

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.

Examples

The following code example adds a NumericUpDown control to cell A1, and then sets the value to 10. To use this example, run it from the Sheet1 class in a document-level project.

private void ExcelRangeAddNumericUpDown()
{

    Microsoft.Office.Tools.Excel.Controls.NumericUpDown
         numericUpDown1 = this.Controls.AddNumericUpDown(
         this.Range["A1"], "numericUpDown1");
    numericUpDown1.Value = 10;
}
Private Sub ExcelRangeAddNumericUpDown()

    Dim NumericUpDown1 As Microsoft.Office.Tools. _
        Excel.Controls.NumericUpDown = Me.Controls. _
        AddNumericUpDown(Me.Range("A1"), _
        "NumericUpDown1")

    NumericUpDown1.Value = 10

End Sub

Remarks

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

The control automatically resizes when the range is resized.

Applies to

AddNumericUpDown(ControlCollection, Double, Double, Double, Double, String)

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

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Office::Tools::Excel::Controls::NumericUpDown ^ AddNumericUpDown(Microsoft::Office::Tools::Excel::ControlCollection ^ controls, double left, double top, double width, double height, System::String ^ name);
public static Microsoft.Office.Tools.Excel.Controls.NumericUpDown AddNumericUpDown (this Microsoft.Office.Tools.Excel.ControlCollection controls, double left, double top, double width, double height, string name);
static member AddNumericUpDown : Microsoft.Office.Tools.Excel.ControlCollection * double * double * double * double * string -> Microsoft.Office.Tools.Excel.Controls.NumericUpDown
<Extension()>
Public Function AddNumericUpDown (controls As ControlCollection, left As Double, top As Double, width As Double, height As Double, name As String) As NumericUpDown

Parameters

controls
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 Controls property (in an application-level project) or the Controls property (in a document-level project), this parameter is supplied automatically.

left
Double

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

top
Double

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

width
Double

The width of the control in points.

height
Double

The height of the control in points.

name
String

The name of the control.

Returns

The NumericUpDown control that was added to the ControlCollection instance.

Exceptions

The name argument is null or has zero length.

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

Examples

The following code example adds a NumericUpDown control to the top of the worksheet, and then sets the value to 10. To use this example, run it from the Sheet1 class in a document-level project.

private void ExcelAddNumericUpDown()
{

    Microsoft.Office.Tools.Excel.Controls.NumericUpDown
         numericUpDown1 = this.Controls.AddNumericUpDown(
         0, 0, 60, 15, "numericUpDown1");
    numericUpDown1.Value = 10;
}
Private Sub ExcelAddNumericUpDown()

    Dim NumericUpDown1 As Microsoft.Office.Tools. _
        Excel.Controls.NumericUpDown = Me.Controls. _
        AddNumericUpDown(0, 0, 60, 15, "NumericUpDown1")
    NumericUpDown1.Value = 10

End Sub

Remarks

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

Applies to