TableCellProperties Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Table Cell Properties.

This class is available in Office 2007 and above.

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

public class TableCellProperties : DocumentFormat.OpenXml.OpenXmlCompositeElement

type TableCellProperties = class
    inherit OpenXmlCompositeElement

Public Class TableCellProperties
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

TableCellProperties

Examples

The following example creates a table into a word-processing document, and uses the TableCellProperties class to specify the width of the table cell.

using System;  
using DocumentFormat.OpenXml;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Wordprocessing;  

namespace TableCellPropertiesEx  
{  
    class Program  
    {  
         // Insert a table into an existing word processing document.  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\users\public\documents\TableCellPropertiesEx.docx";  
            using (WordprocessingDocument document  
                = WordprocessingDocument.Open(fileName, true))  
            {  
                // Create an empty table.  
                Table table = new Table();  

                // Create a TableProperties object and specify its border information.  
                TableProperties tblProp = new TableProperties(  
                    new TableBorders(new TopBorder()  
                        { Val = new EnumValue<BorderValues>(BorderValues.Sawtooth), Size = 24 },  
                        new BottomBorder()  
                        { Val = new EnumValue<BorderValues>(BorderValues.Sawtooth), Size = 24 },  
                        new LeftBorder()  
                        { Val = new EnumValue<BorderValues>(BorderValues.Sawtooth), Size = 24 },  
                        new RightBorder()  
                        { Val = new EnumValue<BorderValues>(BorderValues.Sawtooth), Size = 24 },  
                        new InsideHorizontalBorder()  
                        { Val = new EnumValue<BorderValues>(BorderValues.Sawtooth), Size = 24 },  
                        new InsideVerticalBorder()  
                        { Val = new EnumValue<BorderValues>(BorderValues.Sawtooth), Size = 24 } )  
                );  

                // Append the TableProperties object to the empty table.  
                table.AppendChild<TableProperties>(tblProp);  

                // Create a row and a cell.  
                TableRow tableRow = new TableRow();  
                TableCell tableCell1 = new TableCell();  

                // Specify the width property of the table cell.  
                tableCell1.Append(new TableCellProperties(  
                    new TableCellWidth() { Type = TableWidthUnitValues.Dxa, Width = "2400" }));  

                // Write some text in the cell.  
                tableCell1.Append(new Paragraph(new Run(new Text("Some cell text."))));  

                // Append the cell to the row.  
                tableRow.Append(tableCell1);  

                // Create a second table cell by copying the OuterXml value of the first table cell.  
                TableCell tableCell2 = new TableCell(tableCell1.OuterXml);  

                // Append the cell to the row.  
                tableRow.Append(tableCell2);  

                // Append the table row to the table.  
                table.Append(tableRow);  

                // Append the table to the document.  
                document.MainDocumentPart.Document.Body.Append(table);  
            }  
        }  
    }  
}  

Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Wordprocessing  

Module Module1  
    ' Insert a table into an existing word processing document.  
    Sub Main(ByVal args As String())  
        Dim fileName As String = "C:\users\public\documents\TableCellPropertiesEx.docx"  
        Using document As WordprocessingDocument = WordprocessingDocument.Open(fileName, True)  
            ' Create an empty table.  
            Dim table As New Table()  

            ' Create a TableProperties object and specify its border information.  
            Dim tblProp As New TableProperties(New TableBorders(New TopBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Sawtooth), _  
             .Size = 24 _  
            }, New BottomBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Sawtooth), _  
             .Size = 24 _  
            }, New LeftBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Sawtooth), _  
             .Size = 24 _  
            }, New RightBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Sawtooth), _  
             .Size = 24 _  
            }, New InsideHorizontalBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Sawtooth), _  
             .Size = 24 _  
            }, New InsideVerticalBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Sawtooth), _  
             .Size = 24 _  
            }))  

            ' Append the TableProperties object to the empty table.  
            table.AppendChild(Of TableProperties)(tblProp)  

            ' Create a row and a cell.  
            Dim tableRow As New TableRow()  
            Dim tableCell1 As New TableCell()  

            ' Specify the width property of the table cell.  
            tableCell1.Append(New TableCellProperties(New TableCellWidth() With { _  
             .Type = TableWidthUnitValues.Dxa, _  
             .Width = "2400" _  
            }))  

            ' Write some text in the cell.  
            tableCell1.Append(New Paragraph(New Run(New Text("Some cell text."))))  

            ' Append the cell to the row.  
            tableRow.Append(tableCell1)  

            ' Create a second table cell by copying the OuterXml value of the first table cell.  
            Dim tableCell2 As New TableCell(tableCell1.OuterXml)  

            ' Append the cell to the row.  
            tableRow.Append(tableCell2)  

            ' Append the table row to the table.  
            table.Append(tableRow)  

            ' Append the table to the document.  
            document.MainDocumentPart.Document.Body.Append(table)  
        End Using  
    End Sub  
End Module  

Remarks

[ISO/IEC 29500-1 1st Edition]

tcPr (Table Cell Properties)

This element specifies the set of properties which shall be applied a specific table cell. Each unique property is specified by a child element of this element. In any instance where there is a conflict between the table level, table-level exception, or row level properties with a corresponding table cell property, these properties shall overwrite the table or row wide properties.

[Example: Consider a table where the cell width overwrites the table width represented in the following WordprocessingML:

<w:tbl>  
  <w:tblPr>  
    <w:tblCellMar>  
      <w:left w:w="0" w:type="dxa"/>  
    </w:tblCellMar>  
  </w:tblPr>  
  …  <w:tr>  
    <w:tc>  
      <w:tcPr>  
        <w:tcMar>  
          <w:left w:w="720" w:type="dxa"/>  
        </w:tcMar>  
      </w:tcPr>  
      …    </w:tc>  
  </w:tr>  
</w:tbl>  

This table cell has a left cell margin of 720 twentieths of a point (one half inch) as specified in the tcMar element, which overwrites the table level setting of 0 left table cell margin. end example]

Parent Elements
tc (§17.4.66)

Child Elements	Subclause
cellDel (Table Cell Deletion)	§17.13.5.1
cellIns (Table Cell Insertion)	§17.13.5.2
cellMerge (Vertically Merged/Split Table Cells)	§17.13.5.3
cnfStyle (Table Cell Conditional Formatting)	§17.4.8
gridSpan (Grid Columns Spanned by Current Table Cell)	§17.4.17
headers (Header Cells Associated With Table Cell)	§17.4.19
hideMark (Ignore End Of Cell Marker In Row Height Calculation)	§17.4.21
hMerge (Horizontally Merged Cell)	§17.4.22
noWrap (Don't Wrap Cell Content)	§17.4.30
shd (Table Cell Shading)	§17.4.33
tcBorders (Table Cell Borders)	§17.4.67
tcFitText (Fit Text Within Cell)	§17.4.68
tcMar (Single Table Cell Margins)	§17.4.69
tcPrChange (Revision Information for Table Cell Properties)	§17.13.5.36
tcW (Preferred Table Cell Width)	§17.4.72
textDirection (Table Cell Text Flow Direction)	§17.4.73
vAlign (Table Cell Vertical Alignment)	§17.4.84
vMerge (Vertically Merged Cell)	§17.4.85

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

[ISO/IEC 29500-1 1st Edition]

tcPr (Table Style Conditional Formatting Table Cell Properties)

This element specifies the set of table cell properties which shall be applied to all regions within a table which match the conditional formatting type specified on the parent tblStylePr element. These properties are applied in the order specified via the style hierarchy.

[Example: Consider a table style which contains conditional formatting for its firstRow, defined as follows:

<w:style w:type="table" w:styleId="exampleTableStyle">  
  …  <w:tblStylePr w:type="firstRow">  
    <w:tcPr>  
      <w:tcBorders>  
        <w:top w:val="nil" />  
        <w:left w:val="nil" />  
        <w:bottom w:val="nil" />  
        <w:right w:val="nil" />  
        <w:insideH w:val="nil" />  
        <w:insideV w:val="nil" />  
      </w:tcBorders>  
    </w:tcPr>  
    …  </w:tblStylePr>  
</w:style>  

The tcPr element specified within the tblStylePr element specifies the set of table cell properties which must be applied to all parts of the table which meet the criteria specified by the type value of firstRow - all of the header rows of the table. In this example, the single table cell property applied is a set of table cell borders via the tcBorders element (§17.4.67). In this case, these cell borders simply reset any previous cell borders to nil. end example]

Parent Elements
tblStylePr (§17.7.6.6)

Child Elements	Subclause
cellDel (Table Cell Deletion)	§17.13.5.1
cellIns (Table Cell Insertion)	§17.13.5.2
cellMerge (Vertically Merged/Split Table Cells)	§17.13.5.3
cnfStyle (Table Cell Conditional Formatting)	§17.4.8
gridSpan (Grid Columns Spanned by Current Table Cell)	§17.4.17
headers (Header Cells Associated With Table Cell)	§17.4.19
hideMark (Ignore End Of Cell Marker In Row Height Calculation)	§17.4.21
hMerge (Horizontally Merged Cell)	§17.4.22
noWrap (Don't Wrap Cell Content)	§17.4.30
shd (Table Cell Shading)	§17.4.33
tcBorders (Table Cell Borders)	§17.4.67
tcFitText (Fit Text Within Cell)	§17.4.68
tcMar (Single Table Cell Margins)	§17.4.69
tcPrChange (Revision Information for Table Cell Properties)	§17.13.5.36
tcW (Preferred Table Cell Width)	§17.4.72
textDirection (Table Cell Text Flow Direction)	§17.4.73
vAlign (Table Cell Vertical Alignment)	§17.4.84
vMerge (Vertically Merged Cell)	§17.4.85

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

[ISO/IEC 29500-1 1st Edition]

tcPr (Style Table Cell Properties)

This element specifies the set of table cell properties which shall be applied to the table. These properties are not conditional and shall always be applied (although they are applied before all conditional formatting properties).

[Example: Consider a table style defined as follows:

<w:style w:type="table" w:styleId="exampleTableStyle">  
  <w:tcPr>  
    <w:tcFitText/>  
  </w:tcPr>  
</w:style>  

The tcPr element specified within the style element specifies the set of table cell properties which must be applied to all parts of the table. In this example, the single table cell property applied is the fit text setting via the tcFitText element (§17.4.68). end example]

Parent Elements
style (§17.7.4.17)

Child Elements	Subclause
cellDel (Table Cell Deletion)	§17.13.5.1
cellIns (Table Cell Insertion)	§17.13.5.2
cellMerge (Vertically Merged/Split Table Cells)	§17.13.5.3
cnfStyle (Table Cell Conditional Formatting)	§17.4.8
gridSpan (Grid Columns Spanned by Current Table Cell)	§17.4.17
headers (Header Cells Associated With Table Cell)	§17.4.19
hideMark (Ignore End Of Cell Marker In Row Height Calculation)	§17.4.21
hMerge (Horizontally Merged Cell)	§17.4.22
noWrap (Don't Wrap Cell Content)	§17.4.30
shd (Table Cell Shading)	§17.4.33
tcBorders (Table Cell Borders)	§17.4.67
tcFitText (Fit Text Within Cell)	§17.4.68
tcMar (Single Table Cell Margins)	§17.4.69
tcPrChange (Revision Information for Table Cell Properties)	§17.13.5.36
tcW (Preferred Table Cell Width)	§17.4.72
textDirection (Table Cell Text Flow Direction)	§17.4.73
vAlign (Table Cell Vertical Alignment)	§17.4.84
vMerge (Vertically Merged Cell)	§17.4.85

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ConditionalFormatStyle	ConditionalFormatStyle. Represents the following element tag in the schema: w:cnfStyle.
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)
GridSpan	GridSpan. Represents the following element tag in the schema: w:gridSpan.
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)
HideMark	HideMark. Represents the following element tag in the schema: w:hideMark.
HorizontalMerge	HorizontalMerge. Represents the following element tag in the schema: w:hMerge.
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)
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)
NoWrap	NoWrap. Represents the following element tag in the schema: w:noWrap.
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)
Shading	Shading. Represents the following element tag in the schema: w:shd.
TableCellBorders	TableCellBorders. Represents the following element tag in the schema: w:tcBorders.
TableCellFitText	TableCellFitText. Represents the following element tag in the schema: w:tcFitText.
TableCellMargin	TableCellMargin. Represents the following element tag in the schema: w:tcMar.
TableCellVerticalAlignment	TableCellVerticalAlignment. Represents the following element tag in the schema: w:vAlign.
TableCellWidth	TableCellWidth. Represents the following element tag in the schema: w:tcW.
TextDirection	TextDirection. Represents the following element tag in the schema: w:textDirection.
VerticalMerge	VerticalMerge. Represents the following element tag in the schema: w:vMerge.
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)