Back to Devexpress

Table.TableLook Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-table-e4a84888.md

latest10.2 KB
Original Source

Table.TableLook Property

Gets or sets the table style options that modify the table appearance.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
TableLookTypes TableLook { get; set; }
vb
Property TableLook As TableLookTypes

Property Value

TypeDescription
TableLookTypes

The TableLookTypes enumeration values which specify table style options that change the table appearance.

|

Available values:

NameDescription
None

Specifies that row and column banding formatting is applied to the table, but special formatting is not applied to the first row, last row, first column and last column.

| | ApplyFirstRow |

Specifies that special formatting is applied to the first row of the table.

| | ApplyLastRow |

Specifies that special formatting is applied to the last row of the table.

| | ApplyFirstColumn |

Specifies that special formatting is applied to the first column of the table.

| | ApplyLastColumn |

Specifies that special formatting is applied to the last column of the table.

| | DoNotApplyRowBanding |

Specifies that row banding formatting is not applied to the table.

| | DoNotApplyColumnBanding |

Specifies that column banding formatting is not applied to the table.

|

Remarks

Use the TableLook property to apply row or column banding formatting to the table, or special formatting to the first row, last row, first column or last column.

Example

The code sample below creates a new table style based on the Grid Table 5 Dark Accent 1 style, specifies style options for the first row, first column, odd and even banding columns, and applied the style to a table.

View Example

csharp
using DevExpress.XtraRichEdit.API.Native;
using System.Windows.Forms;

Document document = wordProcessor.Document;

// Load a document from a file.
wordProcessor.LoadDocument("Documents\\TableStyles.docx", DocumentFormat.Docx);

// Access a document.
Document document = wordProcessor.Document;

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

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

// Specify the parent style.
// The created style inherits from the 'Grid Table 5 Dark Accent 1' style
// defined in the loaded document.
myNewStyle.Parent = document.TableStyles["Grid Table 5 Dark Accent 1"];

// Create conditional styles for table elements.
TableConditionalStyle myNewStyleForFirstRow =
    myNewStyle.ConditionalStyleProperties.CreateConditionalStyle(ConditionalTableStyleFormattingTypes.FirstRow);
myNewStyleForFirstRow.CellBackgroundColor = Color.PaleVioletRed;
TableConditionalStyle myNewStyleForFirstColumn =
    myNewStyle.ConditionalStyleProperties.CreateConditionalStyle(ConditionalTableStyleFormattingTypes.FirstColumn);
myNewStyleForFirstColumn.CellBackgroundColor = Color.PaleVioletRed;
TableConditionalStyle myNewStyleForOddColumns =
    myNewStyle.ConditionalStyleProperties.CreateConditionalStyle(ConditionalTableStyleFormattingTypes.OddColumnBanding);
myNewStyleForOddColumns.CellBackgroundColor = ControlPaint.Light(Color.PaleVioletRed);
TableConditionalStyle myNewStyleForEvenColumns =
    myNewStyle.ConditionalStyleProperties.CreateConditionalStyle(ConditionalTableStyleFormattingTypes.EvenColumnBanding);
myNewStyleForEvenColumns.CellBackgroundColor = ControlPaint.LightLight(Color.PaleVioletRed);
document.TableStyles.Add(myNewStyle);

// Create a new table with four rows and columns
// at the document range's end position.
Table table = document.Tables.Create(document.Range.End, 4, 4, AutoFitBehaviorType.AutoFitToWindow);

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

// Apply special formatting to the first row and first column.
table.TableLook = TableLookTypes.ApplyFirstRow | TableLookTypes.ApplyFirstColumn;

// Finalize to edit the document.
document.EndUpdate();
vb
Imports DevExpress.XtraRichEdit.API.Native
Imports System.Windows.Forms

Private document As Document = wordProcessor.Document

' Load a document from a file.
wordProcessor.LoadDocument("Documents\TableStyles.docx", DocumentFormat.Docx)

' Access a document.
Dim document As Document = wordProcessor.Document

' Start to edit the document.
document.BeginUpdate()

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

' Specify the parent style.
' The created style inherits from the 'Grid Table 5 Dark Accent 1' style
' defined in the loaded document.
myNewStyle.Parent = document.TableStyles("Grid Table 5 Dark Accent 1")

' Create conditional styles for table elements.
Dim myNewStyleForFirstRow As TableConditionalStyle =
     myNewStyle.ConditionalStyleProperties.CreateConditionalStyle(ConditionalTableStyleFormattingTypes.FirstRow)
myNewStyleForFirstRow.CellBackgroundColor = Color.PaleVioletRed
Dim myNewStyleForFirstColumn As TableConditionalStyle =
     myNewStyle.ConditionalStyleProperties.CreateConditionalStyle(ConditionalTableStyleFormattingTypes.FirstColumn)
myNewStyleForFirstColumn.CellBackgroundColor = Color.PaleVioletRed
Dim myNewStyleForOddColumns As TableConditionalStyle =
     myNewStyle.ConditionalStyleProperties.CreateConditionalStyle(ConditionalTableStyleFormattingTypes.OddColumnBanding)
myNewStyleForOddColumns.CellBackgroundColor =
     ControlPaint.Light(Color.PaleVioletRed)
Dim myNewStyleForEvenColumns As TableConditionalStyle =
     myNewStyle.ConditionalStyleProperties.CreateConditionalStyle(ConditionalTableStyleFormattingTypes.EvenColumnBanding)
myNewStyleForEvenColumns.CellBackgroundColor =
     ControlPaint.LightLight(Color.PaleVioletRed)
document.TableStyles.Add(myNewStyle)

' Create a new table with four rows and columns
' at the document range's end position.
Dim table As Table = document.Tables.Create(document.Range.End, 4, 4, AutoFitBehaviorType.AutoFitToWindow)

' Apply the created style to the table.
table.Style = myNewStyle

' Apply special formatting to the first row and first column.
table.TableLook =
     TableLookTypes.ApplyFirstRow Or TableLookTypes.ApplyFirstColumn

' Finalize to edit the document.
document.EndUpdate()

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

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.

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

csharp
// Specify which conditional styles are in effect.
table.TableLook = TableLookTypes.ApplyFirstRow | TableLookTypes.ApplyFirstColumn;

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

csharp
// Specify which conditonal styles are in effect.
table.TableLook = TableLookTypes.ApplyFirstRow | TableLookTypes.ApplyFirstColumn;

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

vb
' Specify which conditional styles are in effect.
table.TableLook = DevExpress.XtraRichEdit.API.Native.TableLookTypes.ApplyFirstRow Or DevExpress.XtraRichEdit.API.Native.TableLookTypes.ApplyFirstColumn
document.EndUpdate()

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

vb
' Specify which conditonal styles are in effect.
table.TableLook = TableLookTypes.ApplyFirstRow Or TableLookTypes.ApplyFirstColumn

word-document-api-examples/VB/CodeExamples/TablesActions.vb#L211

vb
' Apply special formatting to the first row and first column.
table.TableLook = DevExpress.XtraRichEdit.API.Native.TableLookTypes.ApplyFirstRow Or DevExpress.XtraRichEdit.API.Native.TableLookTypes.ApplyFirstColumn
' Finalize to edit the document.

See Also

CreateNew()

Tables

ConditionalStyleProperties

Table Interface

Table Members

DevExpress.XtraRichEdit.API.Native Namespace