Apply Table Style

What is this page about?

This page explains how to work with table styles.

A table style defines a set of formatting that can be easily applied to a table. Formatting such as borders, shading, alignment, and font can be set in a table style and applied to many tables for a consistent appearance.

Aspose.Words supports applying a table style to a table and also reading properties of any table style. Table styles are preserved during loading and saving in the following ways:

• Table styles in DOCX and WordML formats are preserved when loading and saving to these formats
• Table styles are preserved when loading and saving in DOC format (but not to any other format)
• When exporting to other formats, rendering or printing, table styles are expanded to direct formatting in the table, so all formatting is preserved

Create a Table Style

The user can create a new style and add it to style collection. The Add method is used to create a new table style.

The following code example shows how to create a new user defined table style:

Copy an Existing Table Style

If necessary, you can copy a table style that already exists in a certain document into your style collection using the AddCopy method.

It is important to know that with this copying, the linked styles are also copied.

The following code example shows how to import a style from one document to another document:

Apply an Existing Table Style

Aspose.Words provides a TableStyle inherited from the Style class. TableStyle facilitates the user to apply different style options like as shading, padding, indentation, CellSpacing and Font, etc.

In addition, Aspose.Words provides the StyleCollection class and a few properties of the Table class to specify which table style we will work with: Style, StyleIdentifier, StyleName, and StyleOptions.

Aspose.Words also provides ConditionalStyle class that represents special formatting applied to some area of a table with an assigned table style, and the ConditionalStyleCollection that represents a collection of ConditionalStyle objects. This collection contains a permanent set of items representing one item for each value of the ConditionalStyleType enumeration type. The ConditionalStyleType enumeration defines all possible table areas to which conditional formatting may be defined in a table style.

In this case, conditional formatting can be defined for all possible table area defined under the ConditionalStyleType enumeration type.

The following code example shows how to define conditional formatting for header row of the table:

You can also choose which table parts to apply styles to, such as first column, last column, banded rows. They are listed in the TableStyleOptions enumeration and are applied through the StyleOptions property. The TableStyleOptions enumeration allows a bitwise combination of these features.

The following code example shows how to create a new table with a table style applied:

The pictures below show a representation of the Table Styles in Microsoft Word and their corresponding properties in Aspose.Words.

Take Formatting from Table Style and Apply it as Direct Formatting

Aspose.Words also provides the ExpandTableStylesToDirectFormatting method to take formatting found on a table style and expands it onto the rows and cells of the table as direct formatting. Try combining formatting with table style and cell style.

This method will not override any other formatting already applied to the table through a row or cell format.

The following code example shows how to expand the formatting from styles onto table rows and cells as direct formatting:

You can download the sample file of this example from Aspose.Words GitHub.

---

FAQ

1. Q: How do I create a custom table style programmatically?
   A: Use the StyleCollection.Add method to create a new style, set its StyleType to Table, and then configure properties such as borders, shading, and font. After configuring, add the style to the document’s Styles collection.

2. Q: Can I copy a table style from one document to another?
   A: Yes. Call StyleCollection.AddCopy(sourceStyle) on the destination document’s Styles collection. This copies the style together with any linked styles it references.

3. Q: How can I apply a table style to an existing table?
   A: Set the table’s StyleIdentifier or StyleName property to the name of the desired style, or assign a TableStyle object to the table’s Style property. You can also modify StyleOptions to include first column, banded rows, etc.

4. Q: What is the purpose of ExpandTableStylesToDirectFormatting?
   A: This method converts the formatting defined by a table style into direct formatting on each row and cell. It is useful when exporting to formats that do not support table styles, ensuring the visual appearance is retained.

5. Q: Are table styles preserved when saving to formats other than DOCX/DOC?
   A: Table styles are fully preserved in DOCX, WordML, and DOC. When saving to other formats (e.g., PDF, HTML), the styles are expanded to direct formatting, so the appearance remains the same even though the style definitions are not retained.