Table Class

Definition

Table. The root element of TableDefinitionPart. When the object is serialized out as xml, its qualified name is x:table.

[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.AutoFilter))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.SortState))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.TableColumns))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.TableStyleInfo))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.TableExtensionList))]
public class Table : DocumentFormat.OpenXml.OpenXmlPartRootElement
type Table = class
    inherit OpenXmlPartRootElement
Public Class Table
Inherits OpenXmlPartRootElement
Inheritance
Attributes

Remarks

[ISO/IEC 29500-1 1st Edition]

table (Table)

This element is the root element for a table that is not a single cell XML table.

Parent Elements
Root element of SpreadsheetML Table Definitions part
Child Elements Subclause
autoFilter (AutoFilter Settings) §18.3.1.2
extLst (Future Feature Data Storage Area) §18.2.10
sortState (Sort State) §18.3.1.92
tableColumns (Table Columns) §18.5.1.4
tableStyleInfo (Table Style) §18.5.1.5
Attributes Description
comment (Table Comment) A string representing a textual comment about the table.

[Note: This can be used by the spreadsheet application in other UI. end note] [Example: There can be name UI that is used to organize defined names and function references, if tables are listed in that UI the comment can give more information about the table. end example]

The maximum length of this string should be 32767 characters.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
connectionId (Connection ID) An integer representing an ID to indicate which connection from the connections collection is used by this table.

This shall only be used for tables that are based off of xml maps.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
dataCellStyle (Data Style Name) A string representing the name of the cell style that is applied to the data area cells of the table.

If this string is missing or does not correspond to the name of a cell style, then the data cell style specified by the current table style should be applied.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
dataDxfId (Data Area Format Id) A zero based integer index into the differential formatting records <dxfs> in the styleSheet indicating which format to apply to the data area of this table.

The spreadsheet should fail to load if this index is out of bounds.

The possible values for this attribute are defined by the ST_DxfId simple type (§18.18.25).
displayName (Table Name) A string representing the name of the table. This is the name that shall be used in formula references, and displayed in the UI to the spreadsheet user.

This name shall not have any spaces in it, and it shall be unique amongst all other displayNames and definedNames in the workbook. The character lengths and restrictions are the same as for definedNames. See SpreadsheetML Reference - Workbook definedNames section for details

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
headerRowBorderDxfId (Header Row Border Format Id) A zero based integer index into the differential formatting records <dxfs> in the styleSheet indicating what border formatting to apply to the header row of this table.

The spreadsheet should fail to load if this index is out of bounds.

The possible values for this attribute are defined by the ST_DxfId simple type (§18.18.25).
headerRowCellStyle (Header Row Style) A string representing the name of the cell style that is applied to the header row cells of the table.

If this string is missing or does not correspond to the name of a cell style, then the header row style specified by the current table style should be applied.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
headerRowCount (Header Row Count) An integer representing the number of header rows showing at the top of the table. 0 means that the header row is not shown.

It is up to the spreadsheet application to determine if numbers greater than 1 are allowed. Unless the spreadsheet application has a feature where there might ever be more than one header row, this number should not be higher than 1.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
headerRowDxfId (Header Row Format Id) A zero based integer index into the differential formatting records *<dxfs>*in the styleSheet indicating which format to apply to the header row of this table.

The spreadsheet should fail to load if this index is out of bounds.

The possible values for this attribute are defined by the ST_DxfId simple type (§18.18.25).
id (Table Id) A non zero integer representing the unique identifier for this table. Each table in the workbook shall have a unique id.

Ids can be used to refer to the specific table in the workbook. [Note: For instance a future records bucket could refer to the table using this id. end note]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
insertRow (Insert Row Showing) A Boolean value indicating whether the insert row is showing. True when the insert row is showing, false otherwise.

The insert row should only be shown if the table has no data.

When a user clicks the insert row in the UI, it provides them an easy way to enter data into a table.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
insertRowShift (Insert Row Shift) A Boolean that indicates whether cells in the sheet had to be inserted when the insert row was shown for this table. True if the cells were shifted, false otherwise.

[Note: This happens when there are values in cells immediately below the table when the table is created and the insert row is shown. In this case blank cells for the insert row are inserted, and the existing values in the sheet are shifted down by one row to make room.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
name (Name) A string representing the name of the table that is used to reference the table programmatically through the spreadsheet applications object model. This string shall be unique per table per sheet. It has the same length and character restrictions as for displayName.

By default this should be the same as the table's displayName. This name should also be kept in synch with the displayName when the displayName is updated in the UI by the spreadsheet user.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
published (Published) A Boolean representing whether this table is marked as published for viewing by a server based spreadsheet application. True if it should be viewed by the server spreadsheet application, false otherwise.

[Note: Such an application might only display objects from the workbook that are marked as published, thus being able to load and calculate the entire workbook but only show the specific items that are marked as published. This can allow the server spreadsheet rendering to provide a more restricted view of the workbook. end note]

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
ref (Reference) The range on the relevant sheet that the table occupies expressed using A1 style referencing.

The reference shall include the totals row if it is shown.

The possible values for this attribute are defined by the ST_Ref simple type (§18.18.62).
tableBorderDxfId (Table Border Format Id) A zero based integer index into the differential formatting records <dxfs> in the styleSheet indicating what border formatting to apply to the borders of this table.

The spreadsheet should fail to load if this index is out of bounds.

The possible values for this attribute are defined by the ST_DxfId simple type (§18.18.25).
tableType (Table Type) An optional enumeration specifying the type or source of the table.

Indicates whether the table is based off of an external data query, data in a worksheet, or from an xml data mapped to a worksheet.

The possible values for this attribute are defined by the ST_TableType simple type (§18.18.78).
totalsRowBorderDxfId (Totals Row Border Format Id) A zero based integer index into the differential formatting records <dxfs> in the styleSheet indicating what border formatting to apply to the totals row of this table.

The spreadsheet should fail to load if this index is out of bounds.

The possible values for this attribute are defined by the ST_DxfId simple type (§18.18.25).
totalsRowCellStyle (Totals Row Style) A string representing the name of the cell style that is applied to the totals row cells of the table.

If this string is missing or does not correspond to the name of a cell style, then the totals row style specified by the current table style should be applied.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
totalsRowCount (Totals Row Count) An integer representing the number of totals rows that shall be shown at the bottom of the table.

0 means that the totals row is not shown. It is up to the spreadsheet application to determine if numbers greater than 1 are allowed. Unless the spreadsheet application has a feature where their might ever be more than one totals row, this number should not be higher than 1.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
totalsRowDxfId (Totals Row Format Id) A zero based integer index into the differential formatting records <dxfs> in the styleSheet indicating which format to apply to the totals row of this table.

The spreadsheet should fail to load if this index is out of bounds.

The possible values for this attribute are defined by the ST_DxfId simple type (§18.18.25).
totalsRowShown (Totals Row Shown) A Boolean indicating whether the totals row has ever been shown in the past for this table. True if the totals row has been shown, false otherwise.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_Table) is located in §A.2. end note]

� ISO/IEC29500: 2008.

Constructors

Table()

Initializes a new instance of the Table class.

Table(IEnumerable<OpenXmlElement>)

Initializes a new instance of the Table class with the specified child elements.

Table(OpenXmlElement[])

Initializes a new instance of the Table class with the specified child elements.

Table(String)

Initializes a new instance of the Table class from outer XML.

Properties

AutoFilter

Table AutoFilter. Represents the following element tag in the schema: x:autoFilter

BorderFormatId

Table Border Format Id.Represents the following attribute in the schema: tableBorderDxfId

ChildElements

Gets all the child nodes of the current element.

(Inherited from OpenXmlElement)
Comment

Table Comment.Represents the following attribute in the schema: comment

ConnectionId

Connection ID.Represents the following attribute in the schema: connectionId

DataCellStyle

Data Style Name.Represents the following attribute in the schema: dataCellStyle

DataFormatId

Data Area Format Id.Represents the following attribute in the schema: dataDxfId

DisplayName

Table Name.Represents the following attribute in the schema: displayName

ExtendedAttributes

Gets all extended attributes (attributes not defined in the schema) of the current element.

(Inherited from OpenXmlElement)
FirstChild

Gets the first child of the current OpenXmlElement element.

(Inherited from OpenXmlCompositeElement)
HasAttributes

Gets a boolean value that indicates whether the current element has any attributes.

(Inherited from OpenXmlElement)
HasChildren

Gets a value that indicates whether the current element has any child elements.

(Inherited from OpenXmlCompositeElement)
HeaderRowBorderFormatId

Header Row Border Format Id.Represents the following attribute in the schema: headerRowBorderDxfId

HeaderRowCellStyle

Header Row Style.Represents the following attribute in the schema: headerRowCellStyle

HeaderRowCount

Header Row Count.Represents the following attribute in the schema: headerRowCount

HeaderRowFormatId

Header Row Format Id.Represents the following attribute in the schema: headerRowDxfId

Id

Table Id.Represents the following attribute in the schema: id

InnerText

Gets or sets the concatenated values of the current node and all of its children.

(Inherited from OpenXmlCompositeElement)
InnerXml

Gets or sets the markup that represents only the child nodes of the current node.

(Inherited from OpenXmlCompositeElement)
InsertRow

Insert Row Showing.Represents the following attribute in the schema: insertRow

InsertRowShift

Insert Row Shift.Represents the following attribute in the schema: insertRowShift

LastChild

Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element.

(Inherited from OpenXmlCompositeElement)
LocalName

Gets the local name of the element.

MCAttributes

Sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element.

(Inherited from OpenXmlElement)
Name

Name.Represents the following attribute in the schema: name

NamespaceDeclarations

Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration.

(Inherited from OpenXmlElement)
NamespaceUri

Gets the namespace URI of the current element.

(Inherited from OpenXmlElement)
OpenXmlElementContext

Gets the OpenXmlEementContext of the current element.

(Inherited from OpenXmlElement)
OuterXml

Gets the markup that represents the current element and all of its child elements.

(Inherited from OpenXmlElement)
Parent

Gets the parent element of the current element.

(Inherited from OpenXmlElement)
Prefix

Gets the namespace prefix of current element.

(Inherited from OpenXmlElement)
Published

Published.Represents the following attribute in the schema: published

Reference

Reference.Represents the following attribute in the schema: ref

SortState

Sort State. Represents the following element tag in the schema: x:sortState

TableColumns

Table Columns. Represents the following element tag in the schema: x:tableColumns

TableDefinitionPart

Gets the TableDefinitionPart associated with this element.

TableExtensionList

Future Feature Data Storage Area. Represents the following element tag in the schema: x:extLst

TableStyleInfo

Table Style. Represents the following element tag in the schema: x:tableStyleInfo

TableType

Table Type.Represents the following attribute in the schema: tableType

TotalsRowBorderFormatId

Totals Row Border Format Id.Represents the following attribute in the schema: totalsRowBorderDxfId

TotalsRowCellStyle

Totals Row Style.Represents the following attribute in the schema: totalsRowCellStyle

TotalsRowCount

Totals Row Count.Represents the following attribute in the schema: totalsRowCount

TotalsRowFormatId

Totals Row Format Id.Represents the following attribute in the schema: totalsRowDxfId

TotalsRowShown

Totals Row Shown.Represents the following attribute in the schema: totalsRowShown

XmlQualifiedName

Gets the qualified name of the current element.

(Inherited from OpenXmlElement)
XName

Gets the qualified name of the current element.

(Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)

Adds an object to the current OpenXmlElement element's list of annotations.

(Inherited from OpenXmlElement)
AddNamespaceDeclaration(String, String)

Adds a namepace declaration to the current node.

(Inherited from OpenXmlElement)
Ancestors()

Enumerates all of the current element's ancestors.

(Inherited from OpenXmlElement)
Ancestors<T>()

Enumerates only the current element's ancestors that have the specified type.

(Inherited from OpenXmlElement)
Annotation(Type)

Get the first annotation object of the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Annotation<T>()

Get the first annotation object of the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Annotations(Type)

Gets a collection of annotations with the specified type for the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Annotations<T>()

Gets a collection of annotations with the specified type for the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)

Appends each element from a list of elements to the end of the current element's list of child elements.

(Inherited from OpenXmlElement)
Append(OpenXmlElement[])

Appends each element from an array of elements to the end of the current element's list of child elements.

(Inherited from OpenXmlElement)
AppendChild<T>(T)

Appends the specified element to the end of the current element's list of child nodes.

(Inherited from OpenXmlCompositeElement)
ClearAllAttributes()

Clears all of the attributes, including both known attributes and extended attributes.

(Inherited from OpenXmlElement)
Clone()

Creates a duplicate of the current node.

(Inherited from OpenXmlElement)
CloneNode(Boolean)

Creates a duplicate of this node.

Descendants()

Enumerates all of the current element's descendants.

(Inherited from OpenXmlElement)
Descendants<T>()

Enumerate all of the current element's descendants of type T.

(Inherited from OpenXmlElement)
Elements()

Enumerates all of the current element's children.

(Inherited from OpenXmlElement)
Elements<T>()

Enumerates only the current element's children that have the specified type.

(Inherited from OpenXmlElement)
ElementsAfter()

Enumerates all of the sibling elements that follow the current element and have the same parent as the current element.

(Inherited from OpenXmlElement)
ElementsBefore()

Enumerates all of the sibling elements that precede the current element and have the same parent as the current element.

(Inherited from OpenXmlElement)
GetAttribute(String, String)

Gets an Open XML attribute with the specified tag name and namespace URI.

(Inherited from OpenXmlElement)
GetAttributes()

Gets a list that contains a copy of all the attributes.

(Inherited from OpenXmlElement)
GetEnumerator()

Returns an enumerator that iterates through the child collection.

(Inherited from OpenXmlElement)
GetFirstChild<T>()

Finds the first child element in type T.

(Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)

Inserts the specified element immediately after the specified reference element.

(Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)

Inserts the specified element immediately after the current element.

(Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)

Inserts the specified element at the specified index of the current element's children.

(Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)

Inserts the specified element immediately before the specified reference element.

(Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)

Inserts the specified element immediately before the current element.

(Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)

Determines if the current element appears after a specified element in document order.

(Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)

Determines if the current element appears before a specified element in document order.

(Inherited from OpenXmlElement)
Load(TableDefinitionPart)

Loads the DOM from the TableDefinitionPart.

LookupNamespace(String)

Resolves the namespace prefix in the context of the current node.

(Inherited from OpenXmlElement)
LookupPrefix(String)

Finds the corresponding prefix for a namespace uri in the current element scope.

(Inherited from OpenXmlElement)
NextSibling()

Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element.

(Inherited from OpenXmlElement)
NextSibling<T>()

Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement.

(Inherited from OpenXmlElement)
PrependChild<T>(T)

Inserts the specified element at the beginning of the current element's list of child nodes.

(Inherited from OpenXmlCompositeElement)
PreviousSibling()

Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element.

(Inherited from OpenXmlElement)
PreviousSibling<T>()

Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element.

(Inherited from OpenXmlElement)
Reload()

Reloads the part content into an Open XML DOM tree. This method can be called multiple times and each time it is called, the tree will be reloaded and previous changes on the tree are abandoned.

(Inherited from OpenXmlPartRootElement)
Remove()

Removes the current element from its parent.

(Inherited from OpenXmlElement)
RemoveAllChildren()

Removes all of the current element's child elements.

(Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()

Remove all of the current element's child elements that are of type T.

(Inherited from OpenXmlElement)
RemoveAnnotations(Type)

Removes the annotations of the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
RemoveAnnotations<T>()

Removes the annotations with the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
RemoveAttribute(String, String)

Removes the attribute from the current element.

(Inherited from OpenXmlElement)
RemoveChild<T>(T)

Removes the specified child element.

(Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)

Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix.

(Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)

Replaces one of the current element's child elements with another OpenXmlElement element.

(Inherited from OpenXmlCompositeElement)
Save()

Saves the data in the DOM tree back to the part. This method can be called multiple times and each time it is called, the stream will be flushed.

(Inherited from OpenXmlPartRootElement)
Save(Stream)

Saves the DOM tree to the specified stream.

(Inherited from OpenXmlPartRootElement)
Save(TableDefinitionPart)

Saves the DOM into the TableDefinitionPart.

SetAttribute(OpenXmlAttribute)

Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list.

(Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)

Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list.

(Inherited from OpenXmlElement)
WriteTo(XmlWriter)

Saves the current node to the specified XmlWriter.

(Inherited from OpenXmlPartRootElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator() (Inherited from OpenXmlElement)

Applies to