Back to all docs
API Reference / Telerik.Windows.Documents.Model / Table
New to Telerik UI for WPF? Start a free 30-day trial

Table

Class

Represents a table within the document model.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:
C#
public class Table : Block

Inheritance: objectDocumentElementBlockTable

Inherited Members DocumentElement.GetStyleProperty(IStylePropertyDefinition)DocumentElement.GetStyleProperty(string)DocumentElement.EnumerateChildrenOfType<T>()DocumentElement.GetParentOfType<T>()DocumentElement.CreateLayoutBox()DocumentElement.CopyPropertiesFrom(DocumentElement)DocumentElement.CopyPropertiesFromStyle(StyleDefinition)DocumentElement.ExtractStyleFromProperties()DocumentElement.ExtractStyleFromLocalProperties()DocumentElement.InvalidateAssociatedBoxesArrange()DocumentElement.InvalidateAssociatedBoxesMeasure()DocumentElement.InvalidateAssociatedBoxesLayout()DocumentElement.GetAssociatedLayoutBoxes()DocumentElement.GetRootDocument()DocumentElement.CreateDeepCopy()DocumentElement.CreateShallowCopy()DocumentElement.GetPropertyValueSource(IStylePropertyDefinition)DocumentElement.ClearValue(IStylePropertyDefinition)DocumentElement.OnRemoved()DocumentElement.OnStyleChanging()DocumentElement.OnStylePropertyChanged(StylePropertyChangeEventArgs)DocumentElement.OnParentChanging()DocumentElement.OnParentChanged()DocumentElement.ChildIndexDocumentElement.HasStyleDocumentElement.StyleDocumentElement.StyleNameDocumentElement.TagDocumentElement.FirstLayoutBoxDocumentElement.IsFirstLayoutBoxInitializedDocumentElement.DocumentElementsDocumentElement.ParentDocumentElement.ChildrenDocumentElement.PreviousSiblingDocumentElement.NextSiblingDocumentElement.CursorDocumentElement.StyleChangingDocumentElement.StyleChangedDocumentElement.StylePropertyChangedDocumentElement.ParentChangingDocumentElement.ParentChangedDocumentElement.PropertyValueChanged...

Constructors

Table()

Initializes a new instance of the Table class.

C#
public Table()

Table(int, int)

Initializes a new instance of the Table class.

C#
public Table(int rowsCount, int columnsCount)
Parameters:rowsCountint

The number of rows of the table.

columnsCountint

The number of columns of the table.

Fields

BackgroundProperty

C#
public static readonly StylePropertyDefinition<Color?, TableProperties> BackgroundProperty

BordersProperty

C#
public static readonly StylePropertyDefinition<TableBorders, TableProperties> BordersProperty

CellPaddingProperty

C#
public static readonly StylePropertyDefinition<Padding?, TableProperties> CellPaddingProperty

CellSpacingProperty

C#
public static readonly StylePropertyDefinition<double?, TableProperties> CellSpacingProperty

ColumnBandSizeProperty

Represents the size of a column band in a table within the Telerik document model.

C#
public static readonly StylePropertyDefinition<int?, TableProperties> ColumnBandSizeProperty

FlowDirectionProperty

C#
public static readonly StylePropertyDefinition<FlowDirection?, TableProperties> FlowDirectionProperty

HorizontalAlignmentProperty

C#
public static readonly StylePropertyDefinition<RadHorizontalAlignment?, TableProperties> HorizontalAlignmentProperty

LayoutModeProperty

C#
public static readonly StylePropertyDefinition<TableLayoutMode?, TableProperties> LayoutModeProperty

PreferredWidthProperty

C#
public static readonly StylePropertyDefinition<TableWidthUnit, TableProperties> PreferredWidthProperty

RowBandSizeProperty

Represents the size of a row band in a table, defining the visual layout and appearance of the rows.

C#
public static readonly StylePropertyDefinition<int?, TableProperties> RowBandSizeProperty

TableIndentProperty

C#
public static readonly StylePropertyDefinition<double?, TableProperties> TableIndentProperty

TableLookProperty

C#
public static readonly StylePropertyDefinition<TableLook, TableProperties> TableLookProperty

ThemeBackgroundProperty

C#
public static readonly StylePropertyDefinition<ThemeColorsEnum?, TableProperties> ThemeBackgroundProperty

ThemeFillShadeProperty

C#
public static readonly StylePropertyDefinition<string, TableProperties> ThemeFillShadeProperty

ThemeFillTintProperty

C#
public static readonly StylePropertyDefinition<string, TableProperties> ThemeFillTintProperty

Properties

Background

Color

Gets or sets the table background.

C#
[XamlSerializable]
public Color Background { get; set; }
Property Value:

The background.

Borders

Gets or sets all borders of the table.

C#
[XamlSerializable]
public TableBorders Borders { get; set; }
Property Value:

The borders.

CellPadding

Gets or sets the cell padding.

C#
[XamlSerializable]
public Padding CellPadding { get; set; }
Property Value:

The cell padding.

CellSpacing

Gets or sets the cell spacing.

C#
[XamlSerializable]
public double CellSpacing { get; set; }
Property Value:

The cell spacing.

ColumnBandSize

C#
[XamlSerializable]
public int ColumnBandSize { get; set; }

FlowDirection

FlowDirection

Gets or sets the flow direction of the table contents.

C#
[XamlSerializable]
public FlowDirection FlowDirection { get; set; }
Property Value:

The flow direction.

Grid

Gets the grid of the table which keeps information about the rows and columns.

C#
public TableGrid Grid { get; }
Property Value:

The grid.

HorizontalAlignment

Gets or sets the horizontal alignment.

C#
[XamlSerializable(RadHorizontalAlignment.Left)]
public RadHorizontalAlignment HorizontalAlignment { get; set; }
Property Value:

The horizontal alignment.

LayoutMode

Gets or sets then table layout mode.

C#
[XamlSerializable]
public TableLayoutMode LayoutMode { get; set; }
Property Value:

The layout mode.

PreferredWidth

Gets or sets the preferred width of the table.

C#
[XamlSerializable]
public TableWidthUnit PreferredWidth { get; set; }
Property Value:

The preferred width.

RowBandSize

C#
[XamlSerializable]
public int RowBandSize { get; set; }

Rows

Gets the rows.

C#
public TableRowCollection Rows { get; }
Property Value:

The rows.

TableIndent

Gets or sets the table indent.

C#
[XamlSerializable]
public double TableIndent { get; set; }
Property Value:

The table indent.

TableLook

Gets or sets the table look.

The look of a table defines the components of the conditional formatting which will be applied to it.

C#
[XamlCompositePropertySerializable]
public TableLook TableLook { get; set; }
Property Value:

The table look.

ThemeBackground

Gets or sets the theme background.

C#
[XamlSerializable]
public ThemeColorsEnum ThemeBackground { get; set; }
Property Value:

The theme background.

ThemeFillShade

Represents the fill shade of a table theme in Telerik's document model.

C#
[XamlSerializable]
public string ThemeFillShade { get; set; }

ThemeFillTint

Represents the tint applied to the theme fill of a table in the Telerik document model.

C#
[XamlSerializable]
public string ThemeFillTint { get; set; }

Methods

AddColumn()

Adds a column after the last one in the table.

C#
public IEnumerable<TableCell> AddColumn()
Returns:

IEnumerable<TableCell>

A collection of the added TableCells.

AddColumnToTheLeft(TableCell)

Adds a column on the left side of an existing cell.

C#
public IEnumerable<TableCell> AddColumnToTheLeft(TableCell existingCell)
Parameters:existingCellTableCell

The existing TableCell.

Returns:

IEnumerable<TableCell>

A collection of the added TableCells.

Exceptions:

InvalidOperationException

Cell must be from the same table.

AddColumnToTheRight(TableCell)

Adds a column on the right side of an existing cell.

C#
public IEnumerable<TableCell> AddColumnToTheRight(TableCell existingCell)
Parameters:existingCellTableCell

The existing TableCell.

Returns:

IEnumerable<TableCell>

A collection of the added TableCells.

Exceptions:

InvalidOperationException

Cell must be from the same table.

AddRow()

Adds copy of the last TableRow in the table. If the table doesn't have any rows, then a new TableRow is added.

C#
public TableRow AddRow()
Returns:

TableRow

The newly added row.

AddRow(TableRow)

Adds a TableRow as a last row in the table.

C#
public TableRow AddRow(TableRow newRow)
Parameters:newRowTableRow

The new TableRow.

Returns:

TableRow

The added TableRow instance.

Exceptions:

ArgumentException

Row already added to this table.

AddRowAbove(TableRow, TableRow)

Adds a TableRow above an existing one.

C#
public TableRow AddRowAbove(TableRow existingRow, TableRow newRow)
Parameters:existingRowTableRow

The existing TableRow.

newRowTableRow

The new TableRow.

Returns:

TableRow

The added TableRow instance.

Exceptions:

InvalidOperationException

Row must be from the same table.

ArgumentException

Row already added.

AddRowAbove(TableRow)

Copies a specified TableRow and adds the copy above it.

C#
public TableRow AddRowAbove(TableRow existingRow)
Parameters:existingRowTableRow

The existing row.

Returns:

TableRow

The added TableRow instance.

AddRowAtIndex(int, TableRow)

Adds a TableRow at a specific index.

C#
public TableRow AddRowAtIndex(int index, TableRow rowToAdd)
Parameters:indexint

The index.

rowToAddTableRow

The row to add.

Returns:

TableRow

The added TableRow instance.

Exceptions:

ArgumentException

Incorrect index value.

AddRowAtIndex(int)

Adds a copy of the nearest TableRow at a specific index.

C#
public TableRow AddRowAtIndex(int index)
Parameters:indexint

The index.

Returns:

TableRow

The added TableRow instance.

Exceptions:

ArgumentException

Incorrect index value.

AddRowBelow(TableRow, TableRow)

Adds a TableRow below an existing one.

C#
public TableRow AddRowBelow(TableRow existingRow, TableRow newRow)
Parameters:existingRowTableRow

The existing TableRow.

newRowTableRow

The new TableRow.

Returns:

TableRow

The added TableRow instance.

Exceptions:

InvalidOperationException

Row must be from the same table.

ArgumentException

Row already added.

AddRowBelow(TableRow)

Copies a specified TableRow and adds the copy below it.

C#
public TableRow AddRowBelow(TableRow existingRow)
Parameters:existingRowTableRow

The existing TableRow.

Returns:

TableRow

The added TableRow instance.

CopyPropertiesFromOverride(DocumentElement)

Copies the properties of a Table instance to the current object.

C#
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)
Parameters:fromElementDocumentElement

The Table to copy the properties from.

Overrides: DocumentElement.CopyPropertiesFromOverride(DocumentElement)

CreateLayoutBox(DocumentStructureCollection)

Creates a new TableLayoutBox.

C#
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)
Parameters:documentCollectionDocumentStructureCollection

The document collection.

Returns:

LayoutBox

The new TableLayoutBox.

Overrides: DocumentElement.CreateLayoutBox(DocumentStructureCollection)

CreateNewElementInstance()

Creates a new instance of the Table class.

C#
protected override DocumentElement CreateNewElementInstance()
Returns:

DocumentElement

The new instance.

Overrides: DocumentElement.CreateNewElementInstance()

DeleteRow(TableRow)

Deletes a TableRow.

C#
public void DeleteRow(TableRow row)
Parameters:rowTableRow

The row to delete.

Exceptions:

InvalidOperationException

Row must be from the same table.

GetGridColumnWidth(int)

Gets the width of the grid column.

C#
public TableWidthUnit GetGridColumnWidth(int gridColumnIndex)
Parameters:gridColumnIndexint

Index of the grid column. This index should not be affected of any merged cells.

Returns:

TableWidthUnit

A TableWidthUnit representing the width of the column.

OnStyleChanged()

Called after the style of a document element has been changed.

C#
protected override void OnStyleChanged()

Overrides: DocumentElement.OnStyleChanged()

SetGridColumnWidth(int, TableWidthUnit)

Sets the width of the grid column.

C#
public void SetGridColumnWidth(int gridColumnIndex, TableWidthUnit width)
Parameters:gridColumnIndexint

Index of the grid column. This index should not be affected of any merged cells.

widthTableWidthUnit

The width.

Exceptions:

ArgumentOutOfRangeException

gridColumnIndex should be greater than or equal to 0.

In this article
DefinitionConstructorsTable()Table(int, int)FieldsBackgroundPropertyBordersPropertyCellPaddingPropertyCellSpacingPropertyColumnBandSizePropertyFlowDirectionPropertyHorizontalAlignmentPropertyLayoutModePropertyPreferredWidthPropertyRowBandSizePropertyTableIndentPropertyTableLookPropertyThemeBackgroundPropertyThemeFillShadePropertyThemeFillTintPropertyPropertiesBackgroundBordersCellPaddingCellSpacingColumnBandSizeFlowDirectionGridHorizontalAlignmentLayoutModePreferredWidthRowBandSizeRowsTableIndentTableLookThemeBackgroundThemeFillShadeThemeFillTintMethodsAddColumn()AddColumnToTheLeft(TableCell)AddColumnToTheRight(TableCell)AddRow()AddRow(TableRow)AddRowAbove(TableRow, TableRow)AddRowAbove(TableRow)AddRowAtIndex(int, TableRow)AddRowAtIndex(int)AddRowBelow(TableRow, TableRow)AddRowBelow(TableRow)CopyPropertiesFromOverride(DocumentElement)CreateLayoutBox(DocumentStructureCollection)CreateNewElementInstance()DeleteRow(TableRow)GetGridColumnWidth(int)OnStyleChanged()SetGridColumnWidth(int, TableWidthUnit)
Not finding the help you need?
Contact Support