TableStyle Class

Definition

Namespace:

DocumentFormat.OpenXml.Drawing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Table Style.

This class is available in Office 2007 and above.

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

public class TableStyle : DocumentFormat.OpenXml.Drawing.TableStyleType

type TableStyle = class
    inherit TableStyleType

Public Class TableStyle
Inherits TableStyleType

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

TableStyleType

TableStyle

Remarks

[ISO/IEC 29500-1 1st Edition]

tableStyle (Table Style)

This element specifies a particular table style. Fourteen elements make up the styling information of a given table style. These fourteen elements work together to provide visual formatting options for on/off states of the following toggles:

• First row on/off - Associated element: firstRow

• Last row on/off - Associated element: lastRow

• First column on/off - Associated element: firstCol

• Last column on/off - Associated element: lastCol

• Row banding on/off - Associated elements: band1H, band2H

• Column banding on/off - Associated elements: band1V, band2V

The formatting associated with the wholeTbl element defines the table formatting when all options are off. When an option is turned on, the formatting for that particular option is applied to the table. The four cell specific formatting options are enabled when overlapping options are toggled on. For example, when the first row, and first column formatting options are enabled, any formatting within the northwest cell is also be applied since that is the overlapping table cell when both first column and first row formatting options are on.

[Example: Consider the following partial example of a tblStyle within DrawingML:

<a:tblStyle styleId="{5940675A-B579-460E-94D1-54222C63F5DA}"  styleName="No Style, Table Grid">  
  <a:wholeTbl>  
    <a:tcTxStyle>  
      <a:fontRef idx="minor">  
        <a:scrgbClr r="0" g="0" b="0"/>  
      </a:fontRef>  
      <a:schemeClr val="tx1"/>  
    </a:tcTxStyle>  
    <a:tcStyle>  
      <a:tcBdr>  
        <a:left>  
          <a:ln w="12700" cmpd="sng">  
            <a:solidFill>  
              <a:schemeClr val="tx1"/>  
            </a:solidFill>  
          </a:ln>  
        </a:left>  

…right, top, bottom, insideH, insideV border information is defined just as the 'left' tag…

    </a:tcBdr>  
    <a:fill>  
      <a:noFill/>  
    </a:fill>  
  </a:tcStyle>  
</a:wholeTbl>  
<a:band1H>  
  <a:tcStyle>  
    <a:tcBdr/>  
  </a:tcStyle>  
</a:band1H>  

…band2H, band1V, band2V, firstCol, firstRow, lastCol, lastRow, neCell, nwCell, seCell, swCell tags are all defined just as the 'band1H' tag

</a:tblStyle>  

In this example, one can get an idea for the definition of a table style in its entirety. The above defined table style creates a style with only 1pt line formatting applied to all of the cells in a table. Notice that the on/off toggle formatting (band1H, band2H, firstCol, etc) do not define any formatting and therefore have no effect to the table when toggled. end example]

Parent Elements
tblPr (§21.1.3.15)

Child Elements	Subclause
band1H (Band 1 Horizontal)	§20.1.4.2.1
band1V (Band 1 Vertical)	§20.1.4.2.2
band2H (Band 2 Horizontal)	§20.1.4.2.3
band2V (Band 2 Vertical)	§20.1.4.2.4
extLst (Extension List)	§20.1.2.2.15
firstCol (First Column)	§20.1.4.2.11
firstRow (First Row)	§20.1.4.2.12
lastCol (Last Column)	§20.1.4.2.16
lastRow (Last Row)	§20.1.4.2.17
neCell (Northeast Cell)	§20.1.4.2.20
nwCell (Northwest Cell)	§20.1.4.2.21
seCell (Southeast Cell)	§20.1.4.2.23
swCell (Southwest Cell)	§20.1.4.2.24
tblBg (Table Background)	§20.1.4.2.25
wholeTbl (Whole Table)	§20.1.4.2.34

Attributes	Description
styleId (Style ID)	Specifies a GUID identifying the table style in a unique manner. The possible values for this attribute are defined by the ST_Guid simple type (§22.9.2.4).
styleName (Name)	Specifies the name of the table style which can show up in the user interface identifying the style to a user. The possible values for this attribute are defined by the W3C XML Schema string datatype.

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

Band1Horizontal	Band 1 Horizontal. Represents the following element tag in the schema: a:band1H. (Inherited from TableStyleType)
Band1Vertical	Band 1 Vertical. Represents the following element tag in the schema: a:band1V. (Inherited from TableStyleType)
Band2Horizontal	Band 2 Horizontal. Represents the following element tag in the schema: a:band2H. (Inherited from TableStyleType)
Band2Vertical	Band 2 Vertical. Represents the following element tag in the schema: a:band2V. (Inherited from TableStyleType)
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
ExtensionList	ExtensionList. Represents the following element tag in the schema: a:extLst. (Inherited from TableStyleType)
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)
FirstColumn	First Column. Represents the following element tag in the schema: a:firstCol. (Inherited from TableStyleType)
FirstRow	First Row. Represents the following element tag in the schema: a:firstRow. (Inherited from TableStyleType)
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)
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)
LastColumn	Last Column. Represents the following element tag in the schema: a:lastCol. (Inherited from TableStyleType)
LastRow	Last Row. Represents the following element tag in the schema: a:lastRow. (Inherited from TableStyleType)
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)
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)
NortheastCell	Northeast Cell. Represents the following element tag in the schema: a:neCell. (Inherited from TableStyleType)
NorthwestCell	Northwest Cell. Represents the following element tag in the schema: a:nwCell. (Inherited from TableStyleType)
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)
SoutheastCell	Southeast Cell. Represents the following element tag in the schema: a:seCell. (Inherited from TableStyleType)
SouthwestCell	Southwest Cell. Represents the following element tag in the schema: a:swCell. (Inherited from TableStyleType)
StyleId	Style ID Represents the following attribute in the schema: styleId (Inherited from TableStyleType)
StyleName	Name Represents the following attribute in the schema: styleName (Inherited from TableStyleType)
TableBackground	Table Background. Represents the following element tag in the schema: a:tblBg. (Inherited from TableStyleType)
WholeTable	Whole Table. Represents the following element tag in the schema: a:wholeTbl. (Inherited from TableStyleType)
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)