TableColumn Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Table Column.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is x:tableColumn.

public class TableColumn : DocumentFormat.OpenXml.OpenXmlCompositeElement

type TableColumn = class
    inherit OpenXmlCompositeElement

Public Class TableColumn
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

TableColumn

Remarks

[ISO/IEC 29500-1 1st Edition]

tableColumn (Table Column)

An element representing a single column for this table.

Parent Elements
tableColumns (§18.5.1.4)

Child Elements	Subclause
calculatedColumnFormula (Calculated Column Formula)	§18.5.1.1
extLst (Future Feature Data Storage Area)	§18.2.10
totalsRowFormula (Totals Row Formula)	§18.5.1.6
xmlColumnPr (XML Column Properties)	§18.5.1.7

Attributes	Description
dataCellStyle (Data Area Style Name)	A string representing the name of the cell style that is applied to the cells in the data area of this table column. 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. This cell style should get precedence over the dataCellStyle defined by the table. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
dataDxfId (Data & Insert Row 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 column. This formatting shall also apply to cells on the insert row for this column. 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 Cell Style)	A string representing the name of the cell style that is applied to the header row cell of this column. If this string is missing or does not correspond to the name of a cell style, then header row style specified by the current table style should be applied. This cell style should get precedence over the headerRowCellStyle defined by the table. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
headerRowDxfId (Header Row Cell Format Id)	A zero based integer index into the differential formatting records <dxfs> in the styleSheet indicating which format to apply to the header cell of this column. The possible values for this attribute are defined by the ST_DxfId simple type (§18.18.25).
id (Table Field Id)	An integer representing the unique identifier of this column. This shall be unique per table. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
name (Column name)	A string representing the unique caption of the table column. This is what shall be displayed in the header row in the UI, and is referenced through functions. This name shall be unique per table. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
queryTableFieldId (Query Table Field Id)	An integer representing the query table field ID corresponding to this table column. The relationship between this table and the corresponding query table is expressed in _rels part for this table. Each queryTableField has a unique id attribute, and this id is what is referenced here. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
totalsRowCellStyle (Totals Row Style Name)	A string representing the name of the cell style that is applied to the Totals Row cell of this column. If this string is missing or does not correspond to the name of a cell style, then the totals row cell style specified by the current table style should be applied. This cell style should get precedence over the totalsRowCellStyle defined by the table. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
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 cell of this column. The spreadsheet shall not 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).
totalsRowFunction (Totals Row Function)	An enumeration indicating which type of aggregation to show in the totals row cell for this column. The possible values for this attribute are defined by the ST_TotalsRowFunction simple type (§18.18.83).
totalsRowLabel (Totals Row Label)	A String to show in the totals row cell for this column. This string shall be ignored unless the totalsRowFunction="none" for this column, in which case it is displayed in the totals row. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
uniqueName (Unique Name)	An optional string representing the unique name of the table column. This string is used to bind the column to a field in a data table, so it should only be used when this table's tableType is queryTable or xml. This name shall be unique per table when it is used. For tables created from xml mappings, by default this should be the same as the name of the column, and should be kept in synch with the name of the column if that name is altered by the spreadsheet application. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

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

� ISO/IEC29500: 2008.

Constructors

TableColumn()	Initializes a new instance of the TableColumn class.
TableColumn(IEnumerable<OpenXmlElement>)	Initializes a new instance of the TableColumn class with the specified child elements.
TableColumn(OpenXmlElement[])	Initializes a new instance of the TableColumn class with the specified child elements.
TableColumn(String)	Initializes a new instance of the TableColumn class from outer XML.

Properties

CalculatedColumnFormula	Calculated Column Formula. Represents the following element tag in the schema: x:calculatedColumnFormula.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
DataCellStyle	Data Area Style Name Represents the following attribute in the schema: dataCellStyle
DataFormatId	Data and Insert Row Format Id Represents the following attribute in the schema: dataDxfId
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
ExtensionList	Future Feature Data Storage Area. Represents the following element tag in the schema: x:extLst.
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
HasAttributes	Gets a value indicating 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)
HeaderRowCellStyle	Header Row Cell Style Represents the following attribute in the schema: headerRowCellStyle
HeaderRowDifferentialFormattingId	Header Row Cell Format Id Represents the following attribute in the schema: headerRowDxfId
Id	Table Field 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)
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 current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
Name	Column 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 OpenXmlElementContext 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)
QueryTableFieldId	Query Table Field Id Represents the following attribute in the schema: queryTableFieldId
TotalsRowCellStyle	Totals Row Style Name Represents the following attribute in the schema: totalsRowCellStyle
TotalsRowDifferentialFormattingId	Totals Row Format Id Represents the following attribute in the schema: totalsRowDxfId
TotalsRowFormula	Totals Row Formula. Represents the following element tag in the schema: x:totalsRowFormula.
TotalsRowFunction	Totals Row Function Represents the following attribute in the schema: totalsRowFunction
TotalsRowLabel	Totals Row Label Represents the following attribute in the schema: totalsRowLabel
UniqueName	Unique Name Represents the following attribute in the schema: uniqueName
XmlColumnProperties	XML Column Properties. Represents the following element tag in the schema: x:xmlColumnPr.
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)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace 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)
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)
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)
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 OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)