Click or drag to resize

IListObject Interface

Represents a table on a worksheet.

Namespace: Spire.Xls.Core
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public interface IListObject

The IListObject type exposes the following members.

Properties
Name Description
Public property AutoFilters
Gets the AutoFiltersCollection collection in the table. Read-only.
Public property Code example BuiltInTableStyle
Gets or sets the built-in table style for the specified ListObject object.
Examples
The following code illustrates how to set TableBuiltInStyles.TableStyleMedium9 to BuiltInTableStyle property:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Apply builtin style</para><para>table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9;</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example Columns
Gets collection of all columns of the list object.
Examples
The following code illustrates how to access Columns property of the table:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Total row</para><para>table1.DisplayTotalRow = true;</para><para>table1.Columns[0].TotalsRowLabel = "Total";</para><para>table1.Columns[1].TotalsCalculation = ExcelTotalsCalculation.Sum;</para><para>table1.Columns[2].TotalsCalculation = ExcelTotalsCalculation.Sum;</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example DisplayFirstColumn
Gets or sets a value indicating whether first column is present.
Examples
The following code illustrates how to set DisplayFirstColumn to "true" to enable the format for the first column:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Set Column Visiblity</para><para>table1.DisplayFirstColumn = true;</para><para>table1.DisplayLastColumn = true;</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example DisplayHeaderRow
Gets or sets a Boolean value indicating whether to hide/display header row.
Examples
The following code illustrates how to hide the header row of the table:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Set Header Visiblity</para><para>table1.DisplayHeaderRow = true;</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example DisplayLastColumn
Gets or sets a value indicating whether last column is present.
Examples
The following code illustrates how to set DisplayLastColumn to "true" to enable the format for the last column:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Set Column Visiblity</para><para>table1.DisplayFirstColumn = true;</para><para>table1.DisplayLastColumn = true;</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example DisplayName
Gets or sets list object name.
Examples
The following code illustrates how the get the DisplayName and print it to console:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Get Table display name</para><para>Console.WriteLine(table1.DisplayName);</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example DisplayTotalRow
Gets or sets a value indicating whether the Total row is visible.
Examples
The following code illustrates how to enable it by setting it to "True" and show the sum of values in second and third columns in the totals row:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Show total row</para><para>table1.DisplayTotalRow = true;</para><para>table1.Columns[0].TotalsRowLabel = "Total";</para><para>table1.Columns[1].TotalsCalculation = ExcelTotalsCalculation.Sum;</para><para>table1.Columns[2].TotalsCalculation = ExcelTotalsCalculation.Sum;</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example Index
Gets index of the current list object.
Examples
The following code illustrates how to access the index of the table:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Print Table index</para><para>Console.WriteLine(table1.Index);</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example Location
Gets or sets list object's location.
Examples
The following code illustrates how table range can be set and accessed:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Set Table Range</para><para>table1.Location = worksheet.Range["A1:C7"];</para><para>//Get Table Range</para><para>Console.WriteLine(table1.Location.RangeAddressLocal.ToString());</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example Name
Gets or sets name of the list object.
Examples
The following code illustrates how to access Name property of the table:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Set Table Name</para><para>table1.Name = "Products";</para><para>//Get Table Name</para><para>Console.WriteLine(table1.Name);</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example ShowTableStyleColumnStripes
Gets or sets a value indicating whether column stripes should be present.
Examples
The following code illustrates how to set ShowTableStyleRowStripes to "False" and set ShowTableStyleColumnStripes to "True" to change the default formatting of the table:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Set Row Column Stripe Visiblity</para><para>table1.ShowTableStyleRowStripes = false;</para><para>table1.ShowTableStyleColumnStripes = true;</para><para>//Apply builtin style</para><para>table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9;</para><para>//Create style for table number format</para><para>IStyle style1 = workbook.Styles.Add("CurrencyFormat");</para><para>style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)";</para><para>//Apply number format</para><para>worksheet["B2:C6"].CellStyleName = "CurrencyFormat";</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example ShowTableStyleRowStripes
Gets or sets a value indicating whether row stripes should be present.
Examples
The following code illustrates how to set ShowTableStyleRowStripes to "False" and set ShowTableStyleColumnStripes to "True" to enable table formatting in columns only:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Set Row Column Stripe Visiblity</para><para>table1.ShowTableStyleRowStripes = false;</para><para>table1.ShowTableStyleColumnStripes = true;</para><para>//Apply builtin style</para><para>table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9;</para><para>//Create style for table number format</para><para>IStyle style1 = workbook.Styles.Add("CurrencyFormat");</para><para>style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)";</para><para>//Apply number format</para><para>worksheet["B2:C6"].CellStyleName = "CurrencyFormat";</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example TotalsRowCount
Gets number of totals rows.
Examples
The following code illustrates how to get the totals rows count:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Check totals row count</para><para>Console.WriteLine(table1.TotalsRowCount);</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Public property Code example Worksheet
Gets parent worksheet object.
Examples
The following code illustrates how the parent worksheet can be accessed:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create table</para><para>IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]);</para><para>//Get parent worksheet's name</para><para>Console.WriteLine(table1.Worksheet.Name);</para><para>//Save to file</para><para>workbook.SaveToFile("Table.xlsx");</para>
Top
See Also