TableCellBorders Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the TableCellBorders Class.

This class is available in Office 2007 and above.

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

public class TableCellBorders : DocumentFormat.OpenXml.OpenXmlCompositeElement

type TableCellBorders = class
    inherit OpenXmlCompositeElement

Public Class TableCellBorders
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

TableCellBorders

Remarks

[ISO/IEC 29500-1 1st Edition]

tcBorders (Table Cell Borders)

This element specifies the set of borders for the edges of the current table cell, using the eight border types defined by its child elements.

If the cell spacing for any row is non-zero as specified using the tblCellSpacing element (§17.4.45; §17.4.44; §17.4.46), then there is never a border conflict (as the non-zero cell spacing is applied above and beyond each individual cell border's width) and all table, table-level exception, and table cell borders shall be displayed.

If the cell spacing is zero, then there can be a conflict between two adjacent cell borders [Example: Between the left border of all cells in the second column and the right border of all cells in the first column of the table. end example], which shall be resolved as follows:

If either conflicting table cell border is nil or none (no border), then the opposing border shall be displayed.

If a cell border conflicts with a table border, the cell border always wins.

Each border shall then be assigned a weight using the following formula, and the border value using this calculation shall be displayed over the alternative border:

The border number shall be determined by this list:

single

1

thick

2

double

3

dotted

4

dashed

5

dotDash

6

dotDotDash

7

triple

8

thinThickSmallGap

9

thickThinSmallGap

10

thinThickThinSmallGap

11

thinThickMediumGap

12

thickThinMediumGap

13

thinThickThinMediumGap

14

thinThickLargeGap

15

thickThinLargeGap

16

thinThickThinLargeGap

17

wave

18

doubleWave

19

dashSmallGap

20

dashDotStroked

21

threeDEmboss

22

threeDEngrave

23

outset

24

inset

25

If the borders have an equal weight, than the higher of the two on this precedence list shall win:

single

thick

double

dotted

dashed

dotDash

dotDotDash

triple

thinThickSmallGap

thickThinSmallGap

thinThickThinSmallGap

thinThickMediumGap

thickThinMediumGap

thinThickThinMediumGap

thinThickLargeGap

thickThinLargeGap

thinThickThinLargeGap

wave

doubleWave

dashSmallGap

dashDotStroked

threeDEmboss

threeDEngrave

outset

inset

If the borders have an identical style, than each border color shall be assigned a brightness value as follows:The color with the smaller brightness value shall win.

If the borders have an identical brightness value above, than each border color shall be assigned a new brightness value as follows:The color with the smaller brightness value shall win.

If the borders have an identical brightness value above, than each border color shall be assigned a brightness value as follows:The color with the smaller brightness value shall win.

If the borders have an identical brightness value above, then they are functionally identical, and the first border in reading order should be displayed.

[Example: Consider the following two cell table (with exaggerated table cell spacing for clarity):

If we collapse the cell spacing, there are conflicting borders at all edges. For each cell/table border conflict, rule #2 says that the cell border must win. For the conflict in the center between two cell borders, rule #3 gives us a larger border weight for the right cell's border, resulting in the following table:

end example]

If this element is omitted, then this table shall have the borders specified by the associated table style. If no borders are specified in the style hierarchy, then this table shall not have any table borders.

[Example: Consider a table whose first cell specifies cell-level borders consisting of a think double red line, as follows:

These cell borders are specified using the following WordprocessingML:

<w:tcPr>  
  <w:tcBorders>  
    <w:top w:val="double" w:sz="24" w:space="0" w:color="FF0000"/>  
    <w:left w:val="double" w:sz="24" w:space="0" w:color="FF0000"/>  
    <w:bottom w:val="double" w:sz="24" w:space="0" w:color="FF0000"/>  
    <w:right w:val="double" w:sz="24" w:space="0" w:color="FF0000"/>  
  </w:tcBorders>  
</w:tcPr>  

The tcBorders element specifies the set of borders applied to the first cell as a 3 point double border. end example]

Parent Elements
tcPr (§17.7.6.8); tcPr (§17.7.6.9); tcPr (§17.4.70); tcPr (§17.4.71)

Child Elements	Subclause
bottom (Table Cell Bottom Border)	§17.4.3
end (Table Cell Trailing Edge Border)	§17.4.12
insideH (Table Cell Inside Horizontal Edges Border)	§17.4.24
insideV (Table Cell Inside Vertical Edges Border)	§17.4.26
start (Table Cell Leading Edge Border)	§17.4.34
tl2br (Table Cell Top Left to Bottom Right Diagonal Border)	§17.4.74
top (Table Cell Top Border)	§17.4.75
tr2bl (Table Cell Top Right to Bottom Left Diagonal Border)	§17.4.80

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

BottomBorder	Table Cell Bottom Border. Represents the following element tag in the schema: w:bottom.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
EndBorder	EndBorder, this property is only available in Office 2010 and later.. Represents the following element tag in the schema: w:end.
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
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)
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)
InsideHorizontalBorder	Table Cell Inside Horizontal Edges Border. Represents the following element tag in the schema: w:insideH.
InsideVerticalBorder	Table Cell Inside Vertical Edges Border. Represents the following element tag in the schema: w:insideV.
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)
LeftBorder	Table Cell Left Border. Represents the following element tag in the schema: w:left.
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)
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)
RightBorder	Table Cell Right Border. Represents the following element tag in the schema: w:right.
StartBorder	StartBorder, this property is only available in Office 2010 and later.. Represents the following element tag in the schema: w:start.
TopBorder	Table Cell Top Border. Represents the following element tag in the schema: w:top.
TopLeftToBottomRightCellBorder	Table Cell Top Left to Bottom Right Diagonal Border. Represents the following element tag in the schema: w:tl2br.
TopRightToBottomLeftCellBorder	Table Cell Top Right to Bottom Left Diagonal Border. Represents the following element tag in the schema: w:tr2bl.
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)