ListObject.HeaderRowRange Property
Gets a Range that represents the range of the header row.
Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)
Syntax
'Declaration
ReadOnly Property HeaderRowRange As Range
Range HeaderRowRange { get; }
Property Value
Type: Microsoft.Office.Interop.Excel.Range
A Range that represents the range of the header row.
Remarks
If there is no header row, HeaderRowRange returns nulla null reference (Nothing in Visual Basic).
Examples
The following code example creates a DataTable and a ListObject, and binds the ListObject to the DataTable. It then gets the range that contains the header row and changes the header row font to bold.
This example is for a document-level customization.
Private Sub ListObject_HeaderRowRange()
' Create a new DataSet and DataTable.
Dim ds As New DataSet()
Dim dt As DataTable = ds.Tables.Add("Customers")
dt.Columns.Add(New DataColumn("LastName"))
dt.Columns.Add(New DataColumn("FirstName"))
' Add a new row to the DataTable.
Dim dr As DataRow = dt.NewRow()
dr("LastName") = "Chan"
dr("FirstName") = "Gareth"
dt.Rows.Add(dr)
' Create a list object.
Dim List1 As Microsoft.Office.Tools.Excel.ListObject = _
Me.Controls.AddListObject(Me.Range("A1"), _
"List1")
' Bind the list object to the DataTable.
List1.AutoSetDataBoundColumnHeaders = True
List1.SetDataBinding(ds, "Customers", _
"LastName", "FirstName")
' Get the header row range and set the font to bold.
Dim headerRow As Excel.Range = List1.HeaderRowRange
headerRow.Cells.Font.Bold = True
End Sub
private void ListObject_HeaderRowRange()
{
// 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"], "list1");
// Bind the list object to the DataTable.
list1.AutoSetDataBoundColumnHeaders = true;
list1.SetDataBinding(ds, "Customers", "LastName",
"FirstName");
// Get the header row range and set the font to bold.
Excel.Range headerRow = list1.HeaderRowRange;
headerRow.Cells.Font.Bold = true;
}
.NET Framework Security
- 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.