Class TableStyle

Represents the style properties of a table.

Inheritance
System.Object
TableStyle
Implements
IronSoftware.Abstractions.Word.ITableStyle
IronSoftware.Abstractions.Word.IDerivedStyle
IronSoftware.Abstractions.Word.IStyle
IronSoftware.Abstractions.Word.IWordDocumentObjectProperty
IronSoftware.Abstractions.IDocumentObjectProperty
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class TableStyle : Object, ITableStyle, IDerivedStyle

When a table needs a default appearance applied across all of its rows and cells, TableStyle collects those settings into one object you assign to the table. It holds the table-wide borders, cell margins, alignment, and width, so a developer sets the look once instead of repeating values per cell. Note that it is the styling object in IronWord.Models, distinct from the TableStyle enumeration in IronWord.Models.Enums.

The defaults a table applies are set through this object's properties: Borders takes a TableBorders for the frame and grid lines, BottomCellMargin, TopCellMargin, LeftCellMargin, and RightCellMargin set the default padding inside every cell, Justification aligns the table on the page, and Width sets its overall width. Any of these can be overridden by the styling of an individual row or cell, so the table style is the baseline rather than the last word.

TableStyle also takes part in IronWord's derived-style model: BaseStyle points at a style this one extends, and InheritedStyle exposes the effective settings once inheritance is resolved, which lets several tables share a base style and override only what differs. Build a TableStyle, set its borders, margins, and alignment, and assign it to the Style property of a Table to apply the defaults across the whole grid. Setting the look on the table style rather than on each cell keeps a large grid consistent and easy to retune, since one change to the style flows to every cell that has not overridden it. This baseline-plus-override approach is what lets a reporting layout reuse the same table style while a few highlighted cells still carry their own shading.

using IronWord.Models;

Table table = new Table(3, 3);
table.Style = new TableStyle
{
    Borders = new TableBorders(),
    Width = 9000
};

The add a table how-to covers table-wide styling, the add table example saves a styled grid to DOCX, and the document element tutorial shows where table styling fits the document model.

Constructors

TableStyle()

Initializes a new instance of TableStyle.

Declaration
public TableStyle()

Properties

BaseStyle

The original base style definition a style is based off of.

Declaration
public IBaseStyle BaseStyle { get; }
Property Value
Type Description
IBaseStyle

Borders

The borders for the table.

Declaration
public TableBorders Borders { get; set; }
Property Value
Type Description
TableBorders

BottomCellMargin

Declaration
public Nullable<uint> BottomCellMargin { get; set; }
Property Value
Type Description
System.Nullable<System.UInt32>

InheritedStyle

Table style this style inherits from.

Declaration
public ITableStyle InheritedStyle { get; }
Property Value
Type Description
ITableStyle

Justification

Declaration
public Nullable<JustificationValues> Justification { get; set; }
Property Value
Type Description
System.Nullable<IronSoftware.Abstractions.Word.JustificationValues>

LeftCellMargin

Declaration
public Nullable<uint> LeftCellMargin { get; set; }
Property Value
Type Description
System.Nullable<System.UInt32>

RightCellMargin

Declaration
public Nullable<uint> RightCellMargin { get; set; }
Property Value
Type Description
System.Nullable<System.UInt32>

TopCellMargin

Declaration
public Nullable<uint> TopCellMargin { get; set; }
Property Value
Type Description
System.Nullable<System.UInt32>

Width

Declaration
public Nullable<long> Width { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

Implements

IronSoftware.Abstractions.Word.ITableStyle
IronSoftware.Abstractions.Word.IDerivedStyle
IronSoftware.Abstractions.Word.IStyle
IronSoftware.Abstractions.Word.IWordDocumentObjectProperty
IronSoftware.Abstractions.IDocumentObjectProperty