ListObject.BeforeAddDataBoundRow Event (2007 System)
Updated: July 2008
Occurs just before an attempt to add a new row to a ListObject control that is bound to data.
Assembly: Microsoft.Office.Tools.Excel.v9.0 (in Microsoft.Office.Tools.Excel.v9.0.dll)
This event is raised only if the ListObject control is bound to data.
This event is raised only when a new row is added through the Microsoft Office Excel user interface. It is not raised when a new row is added programmatically.
Handle this event to perform additional validation, or to cancel addition of a row.
The following code example creates a DataTable and a ListObject, and binds the ListObject to the DataTable. It then creates a BeforeAddDataboundRow() event handler. To test the event, manually add a new row to the ListObject on sheet 1. The event handler removes the row and displays a message.
This version is for a document-level customization.
private void ListObject_BeforeAddDataBoundRow() { // Create a new DataSet and DataTable. DataSet ds = new DataSet(); DataTable dt = ds.Tables.Add("Customers"); dt.Columns.Add(new DataColumn("LastName")); dt.Columns.Add(new DataColumn("FirstName")); // Add a new row to the DataTable. DataRow dr = dt.NewRow(); dr["LastName"] = "Chan"; dr["FirstName"] = "Gareth"; dt.Rows.Add(dr); // Create a list object. Microsoft.Office.Tools.Excel.ListObject list1 = this.Controls.AddListObject( this.Range["A1", missing], "list1"); // Bind the list object to the DataTable. list1.AutoSetDataBoundColumnHeaders = true; list1.SetDataBinding(ds, "Customers", "LastName", "FirstName"); // Create the event handler. list1.BeforeAddDataBoundRow += new Microsoft.Office.Tools.Excel. BeforeAddDataBoundRowEventHandler( list1_BeforeAddDataBoundRow); } void list1_BeforeAddDataBoundRow(object sender, Microsoft.Office.Tools.Excel.BeforeAddDataBoundRowEventArgs e) { e.Cancel = true; MessageBox.Show("This data is read-only."); }
This version is for an application-level add-in. To use this code example, add the using System.Data; directive if you are using C# or the Imports System.Data statement if you are using Visual Basic.
private void ListObject_BeforeAddDataBoundRow() { // Create a new DataSet and DataTable. DataSet ds = new DataSet(); DataTable dt = ds.Tables.Add("Customers"); dt.Columns.Add(new DataColumn("LastName")); dt.Columns.Add(new DataColumn("FirstName")); // Add a new row to the DataTable. DataRow dr = dt.NewRow(); dr["LastName"] = "Chan"; dr["FirstName"] = "Gareth"; dt.Rows.Add(dr); // Create a list object. Worksheet vstoWorksheet = ((Excel.Worksheet) this.Application.ActiveWorkbook.Worksheets[1]).GetVstoObject(); ListObject list1 = vstoWorksheet.Controls.AddListObject( vstoWorksheet.Range["A1", missing], "list1"); // Bind the list object to the DataTable. list1.AutoSetDataBoundColumnHeaders = true; list1.SetDataBinding(ds, "Customers", "LastName", "FirstName"); // Create the event handler. list1.BeforeAddDataBoundRow += new BeforeAddDataBoundRowEventHandler( list1_BeforeAddDataBoundRow); } void list1_BeforeAddDataBoundRow(object sender, Microsoft.Office.Tools.Excel.BeforeAddDataBoundRowEventArgs e) { e.Cancel = true; System.Windows.Forms.MessageBox.Show("This data is read-only."); }
- 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.
