TableStyle Interface

A single style that can be applied to a table.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v18.2.Core.dll

Declaration

C#

[ComVisible(true)]
public interface TableStyle :
    TablePropertiesBase,
    TableCellPropertiesBase,
    CharacterPropertiesBase,
    ParagraphPropertiesBase

VB.NET

<ComVisible(True)>
Public Interface TableStyle
    Inherits TablePropertiesBase,
             TableCellPropertiesBase,
             CharacterPropertiesBase,
             ParagraphPropertiesBase

Related API Members

The following members return TableStyle objects:

• Table.Style
• TableConditionalStyleProperties.Owner
• TableStyle.Parent
• TableStyleCollection.CreateNew()
• TableStyleCollection.Item[String]

Remarks

The TableStyle object inherits the CharacterPropertiesBase, ParagraphPropertiesBase, TableCellPropertiesBase and the TablePropertiesBase interfaces.

Table styles are contained within the TableStyleCollection accessible via the Document.TableStyles property. To create a new style, use the TableStyleCollection.CreateNew method. Subsequently you should add a style to the document style collection, otherwise you won’t be able to apply it.

To apply a style to a table, use the Table.Style property.

Note that each paragraph in a cell may have its own style.

Default table formatting can be specified via the Document.DefaultTableProperties property.

Example

The following code creates a new table style from scratch, creates a table and applies a new style to a newly created table.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Table.vb

document.BeginUpdate()
' Create a new table style.
Dim tStyleMain As TableStyle = document.TableStyles.CreateNew()
' Specify style characteristics.
tStyleMain.AllCaps = True
tStyleMain.FontName = "Segoe Condensed"
tStyleMain.FontSize = 14
tStyleMain.Alignment = ParagraphAlignment.Center
tStyleMain.TableBorders.InsideHorizontalBorder.LineStyle = TableBorderLineStyle.Dotted
tStyleMain.TableBorders.InsideVerticalBorder.LineStyle = TableBorderLineStyle.Dotted
tStyleMain.TableBorders.Top.LineThickness = 1.5F
tStyleMain.TableBorders.Top.LineStyle = TableBorderLineStyle.Double
tStyleMain.TableBorders.Left.LineThickness = 1.5F
tStyleMain.TableBorders.Left.LineStyle = TableBorderLineStyle.Double
tStyleMain.TableBorders.Bottom.LineThickness = 1.5F
tStyleMain.TableBorders.Bottom.LineStyle = TableBorderLineStyle.Double
tStyleMain.TableBorders.Right.LineThickness = 1.5F
tStyleMain.TableBorders.Right.LineStyle = TableBorderLineStyle.Double
tStyleMain.CellBackgroundColor = System.Drawing.Color.LightBlue
tStyleMain.TableLayout = TableLayoutType.Fixed
tStyleMain.Name = "MyTableStyle"
'Add the style to the document.
document.TableStyles.Add(tStyleMain)
document.EndUpdate()
document.BeginUpdate()
' Create a table.
Dim table As Table = document.Tables.Create(document.Range.Start, 3, 3)
table.TableLayout = TableLayoutType.Fixed
table.PreferredWidthType = WidthType.Fixed
table.PreferredWidth = DevExpress.Office.Utils.Units.InchesToDocumentsF(4.5F)
table(1, 1).PreferredWidthType = WidthType.Fixed
table(1, 1).PreferredWidth = DevExpress.Office.Utils.Units.InchesToDocumentsF(1.5F)
' Apply a previously defined style.
table.Style = tStyleMain
document.EndUpdate()

document.InsertText(table(1, 1).Range.Start, "STYLED")

Table.cs

document.BeginUpdate();
// Create a new table style.
TableStyle tStyleMain = document.TableStyles.CreateNew();
// Specify style characteristics.
tStyleMain.AllCaps = true;
tStyleMain.FontName = "Segoe Condensed";
tStyleMain.FontSize = 14;
tStyleMain.Alignment = ParagraphAlignment.Center;
tStyleMain.TableBorders.InsideHorizontalBorder.LineStyle = TableBorderLineStyle.Dotted;
tStyleMain.TableBorders.InsideVerticalBorder.LineStyle = TableBorderLineStyle.Dotted;
tStyleMain.TableBorders.Top.LineThickness = 1.5f;
tStyleMain.TableBorders.Top.LineStyle = TableBorderLineStyle.Double;
tStyleMain.TableBorders.Left.LineThickness = 1.5f;
tStyleMain.TableBorders.Left.LineStyle = TableBorderLineStyle.Double;
tStyleMain.TableBorders.Bottom.LineThickness = 1.5f;
tStyleMain.TableBorders.Bottom.LineStyle = TableBorderLineStyle.Double;
tStyleMain.TableBorders.Right.LineThickness = 1.5f;
tStyleMain.TableBorders.Right.LineStyle = TableBorderLineStyle.Double;
tStyleMain.CellBackgroundColor = System.Drawing.Color.LightBlue;
tStyleMain.TableLayout = TableLayoutType.Fixed;
tStyleMain.Name = "MyTableStyle";
//Add the style to the document.
document.TableStyles.Add(tStyleMain);
document.EndUpdate();
document.BeginUpdate();
// Create a table.
Table table = document.Tables.Create(document.Range.Start, 3, 3);
table.TableLayout = TableLayoutType.Fixed;
table.PreferredWidthType = WidthType.Fixed;
table.PreferredWidth = DevExpress.Office.Utils.Units.InchesToDocumentsF(4.5f);
table[1, 1].PreferredWidthType = WidthType.Fixed;
table[1, 1].PreferredWidth = DevExpress.Office.Utils.Units.InchesToDocumentsF(1.5f);
// Apply a previously defined style.
table.Style = tStyleMain;
document.EndUpdate();

document.InsertText(table[1, 1].Range.Start, "STYLED");

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TableStyle interface.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

table-api-creating-table-a-simple-example-e3242/CS/Walkthrough_Creating_Table/Form1.cs#L85

// Define basic style
TableStyle tStyleNormal = richEditControl1.Document.TableStyles.CreateNew();
tStyleNormal.LineSpacingType = ParagraphLineSpacing.Single;

table-api-how-to-create-a-multiplication-table-in-code-e3231/CS/Table_API_Example/Form1.cs#L58

{
    TableStyle tStyleMain = doc.TableStyles.CreateNew();
    tStyleMain.AllCaps = true;

VB.NET

table-api-creating-table-a-simple-example-e3242/VB/Walkthrough_Creating_Table/Form1.vb#L81

' Define basic style
Dim tStyleNormal As TableStyle = richEditControl1.Document.TableStyles.CreateNew()
tStyleNormal.LineSpacingType = ParagraphLineSpacing.Single

table-api-how-to-create-a-multiplication-table-in-code-e3231/VB/Table_API_Example/Form1.vb#L55

Private Sub CreateTableStyles(ByVal doc As Document)
    Dim tStyleMain As TableStyle = doc.TableStyles.CreateNew()
    tStyleMain.AllCaps = True