ControlExtensions.AddDataGridView Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| AddDataGridView(ControlCollection, Range, String) |
Adds a new DataGridView control to the worksheet at the range specified. |
| AddDataGridView(ControlCollection, Double, Double, Double, Double, String) |
Adds a new DataGridView control to the worksheet in the specified size and location. |
AddDataGridView(ControlCollection, Range, String)
Adds a new DataGridView control to the worksheet at the range specified.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Office::Tools::Excel::Controls::DataGridView ^ AddDataGridView(Microsoft::Office::Tools::Excel::ControlCollection ^ controls, Microsoft::Office::Interop::Excel::Range ^ range, System::String ^ name);public static Microsoft.Office.Tools.Excel.Controls.DataGridView AddDataGridView (this Microsoft.Office.Tools.Excel.ControlCollection controls, Microsoft.Office.Interop.Excel.Range range, string name);static member AddDataGridView : Microsoft.Office.Tools.Excel.ControlCollection * Microsoft.Office.Interop.Excel.Range * string -> Microsoft.Office.Tools.Excel.Controls.DataGridView<Extension()>
Public Function AddDataGridView (controls As ControlCollection, range As Range, name As String) As DataGridViewParameters
- 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.
- name
- String
The name of the control that can be used to index the control in the ControlCollection instance.
Returns
The DataGridView 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 DataGridView control to cells A1 through D9, and then adds two columns to the control. To use this example, run it from the Sheet1 class in a document-level project.
private void ExcelRangeAddDataGridView()
{
Microsoft.Office.Tools.Excel.Controls.DataGridView
dataGridView1 = this.Controls.AddDataGridView(
this.Range["A1", "D9"], "dataGridView1");
dataGridView1.Columns.Add("firsName", "First Name");
dataGridView1.Columns.Add("lastName", "Last Name");
}
Private Sub ExcelRangeAddDataGridView()
Dim DataGridView1 As Microsoft.Office.Tools.Excel. _
Controls.DataGridView = Me.Controls. _
AddDataGridView(Me.Range("A1", "D9"), _
"DataGridView1")
DataGridView1.Columns.Add("firsName", "First Name")
DataGridView1.Columns.Add("lastName", "Last Name")
End Sub
Remarks
The AddDataGridView method enables you to add DataGridView objects to the end of the ControlCollection. To remove a DataGridView that was previously added programmatically, use the Remove method.
The control automatically resizes when the range is resized.
Applies to
AddDataGridView(ControlCollection, Double, Double, Double, Double, String)
Adds a new DataGridView control to the worksheet in the specified size and location.
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Office::Tools::Excel::Controls::DataGridView ^ AddDataGridView(Microsoft::Office::Tools::Excel::ControlCollection ^ controls, double left, double top, double width, double height, System::String ^ name);public static Microsoft.Office.Tools.Excel.Controls.DataGridView AddDataGridView (this Microsoft.Office.Tools.Excel.ControlCollection controls, double left, double top, double width, double height, string name);static member AddDataGridView : Microsoft.Office.Tools.Excel.ControlCollection * double * double * double * double * string -> Microsoft.Office.Tools.Excel.Controls.DataGridView<Extension()>
Public Function AddDataGridView (controls As ControlCollection, left As Double, top As Double, width As Double, height As Double, name As String) As DataGridViewParameters
- 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 DataGridView 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 DataGridView control to the top of the worksheet, and then adds two columns to the control. To use this example, run it from the Sheet1 class in a document-level project.
private void ExcelAddDataGridView()
{
Microsoft.Office.Tools.Excel.Controls.DataGridView
dataGridView1 = this.Controls.AddDataGridView(
0, 0, 190, 112.5, "dataGridView1");
dataGridView1.Columns.Add("firsName", "First Name");
dataGridView1.Columns.Add("lastName", "Last Name");
}
Private Sub ExcelAddDataGridView()
Dim DataGridView1 As Microsoft.Office.Tools.Excel. _
Controls.DataGridView = Me.Controls. _
AddDataGridView(0, 0, 190, 112.5, _
"DataGridView1")
DataGridView1.Columns.Add("firsName", "First Name")
DataGridView1.Columns.Add("lastName", "Last Name")
End Sub
Remarks
The AddDataGridView method enables you to add DataGridView objects to the end of the ControlCollection. To remove a DataGridView control that was previously added programmatically, use the Remove method.