TableStyle Interface

A table style.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v21.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 accept/return TableStyle objects:

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

Remarks

To create a new style, use the TableStyleCollection.CreateNew method. Call the TableStyleCollection.Add method and pass the TableStyle object as the method parameter to add a newly created style to the collection. Otherwise, you cannot apply the table style.

To apply a style to a table, use the Table.Style property. Note that each paragraph in a cell may have its own style.

The Document.DefaultTableProperties property allows you to specify default format options for the table.

Example

The code sample below creates a new table style and applies it to a table:

View Example

TablesActions.cs

using DevExpress.Office.Utils;
using DevExpress.XtraRichEdit.API.Native;
using System.Drawing;

static void CreateAndApplyTableStyle(RichEditDocumentServer wordProcessor)
{
    // Access a document.
    Document document = wordProcessor.Document;

    // Start to edit the document.
    document.BeginUpdate();

    // Create a new table style.
    TableStyle tStyleMain = document.TableStyles.CreateNew();

    // Specify table style options.
    tStyleMain.AllCaps = true;
    tStyleMain.FontName = "Segoe Condensed";
    tStyleMain.FontSize = 14;
    tStyleMain.Alignment = ParagraphAlignment.Center;

    TableBorders tableBorders = tStyleMain.TableBorders;
    tableBorders.InsideHorizontalBorder.LineStyle =
         TableBorderLineStyle.Dotted;

    tableBorders.InsideVerticalBorder.LineStyle =
         TableBorderLineStyle.Dotted;

    tableBorders.Top.LineThickness = 1.5f;
    tableBorders.Top.LineStyle = TableBorderLineStyle.Double;
    tableBorders.Left.LineThickness = 1.5f;
    tableBorders.Left.LineStyle = TableBorderLineStyle.Double;
    tableBorders.Bottom.LineThickness = 1.5f;
    tableBorders.Bottom.LineStyle = TableBorderLineStyle.Double;
    tableBorders.Right.LineThickness = 1.5f;
    tableBorders.Right.LineStyle = TableBorderLineStyle.Double;

    tStyleMain.CellBackgroundColor = Color.LightBlue;
    tStyleMain.TableLayout = TableLayoutType.Fixed;
    tStyleMain.Name = "MyTableStyle";

    // Add the style to the collection of styles.
    document.TableStyles.Add(tStyleMain);

    // Finalize to edit the document.
    document.EndUpdate();

    // Start to edit the document.
    document.BeginUpdate();

    // Create a table with three rows and columns
    // at the document range's start position.
    Table table = document.Tables.Create(document.Range.Start, 3, 3);

    // Set the table width to a fixed value.
    table.TableLayout = TableLayoutType.Fixed;
    table.PreferredWidthType = WidthType.Fixed;
    table.PreferredWidth = Units.InchesToDocumentsF(3.5f);

    // Set the cell width to a fixed value. 
    table[1, 1].PreferredWidthType = WidthType.Fixed;
    table[1, 1].PreferredWidth = Units.InchesToDocumentsF(1.5f);

    // Apply the created style to the table.
    table.Style = tStyleMain;

    // Finalize to edit the document.
    document.EndUpdate();

    // Insert text to the table cell.
    document.InsertText(table[1, 1].Range.Start, "STYLED");

}

TablesActions.vb

Dim document As Document = server.Document
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 = Units.InchesToDocumentsF(4.5F)
table(1, 1).PreferredWidthType = WidthType.Fixed
table(1, 1).PreferredWidth = 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#

how-to-use-snapdocument-events-to-customize-the-default-templates-of-snap-lists-and-columns-e4782/CS/Snap_Events/Form1.cs#L75

TableStyle employee = document.TableStyles.CreateNew();
employee.Name = employeeStyleName;

dxrichedit-for-wpf-table-api-creating-table-a-simple-example-e3266/CS/MainWindow.xaml.cs#L83

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

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;

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/TableActions.cs#L76

// Create a new table style.
TableStyle tStyleMain = document.TableStyles.CreateNew();
// Specify style characteristics.

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Table.cs#L108

// Create a new table style.
TableStyle tStyleMain = document.TableStyles.CreateNew();
// Specify style characteristics.

VB.NET

how-to-use-snapdocument-events-to-customize-the-default-templates-of-snap-lists-and-columns-e4782/VB/Snap_Events/Form1.vb#L77

Dim employee As TableStyle = document.TableStyles.CreateNew()
employee.Name = employeeStyleName

dxrichedit-for-wpf-table-api-creating-table-a-simple-example-e3266/VB/MainWindow.xaml.vb#L83

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

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

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/TableActions.vb#L66

' Create a new table style.
Dim tStyleMain As TableStyle = document.TableStyles.CreateNew()
' Specify style characteristics.

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Table.vb#L94

' Create a new table style.
Dim tStyleMain As TableStyle = document.TableStyles.CreateNew()
' Specify style characteristics.