ClassTable
Represents a table within the document model.
Definition
Namespace:Telerik.Windows.Documents.Model
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class Table : BlockInheritance: objectDocumentElementBlockTable
Inherited Members
Constructors
Table(int, int)
Initializes a new instance of the Table class.
Fields
BackgroundProperty
Declaration
public static readonly StylePropertyDefinition<Color?, TableProperties> BackgroundPropertyField Value
StylePropertyDefinition<Color?, TableProperties>
BordersProperty
Declaration
public static readonly StylePropertyDefinition<TableBorders, TableProperties> BordersPropertyField Value
CellPaddingProperty
Declaration
public static readonly StylePropertyDefinition<Padding?, TableProperties> CellPaddingPropertyField Value
CellSpacingProperty
Declaration
public static readonly StylePropertyDefinition<double?, TableProperties> CellSpacingPropertyField Value
ColumnBandSizeProperty
Represents the size of a column band in a table within the Telerik document model.
Declaration
public static readonly StylePropertyDefinition<int?, TableProperties> ColumnBandSizePropertyField Value
FlowDirectionProperty
Declaration
public static readonly StylePropertyDefinition<FlowDirection?, TableProperties> FlowDirectionPropertyField Value
StylePropertyDefinition<FlowDirection?, TableProperties>
HorizontalAlignmentProperty
Declaration
public static readonly StylePropertyDefinition<RadHorizontalAlignment?, TableProperties> HorizontalAlignmentPropertyField Value
StylePropertyDefinition<RadHorizontalAlignment?, TableProperties>
LayoutModeProperty
Declaration
public static readonly StylePropertyDefinition<TableLayoutMode?, TableProperties> LayoutModePropertyField Value
PreferredWidthProperty
Declaration
public static readonly StylePropertyDefinition<TableWidthUnit, TableProperties> PreferredWidthPropertyField Value
RowBandSizeProperty
Represents the size of a row band in a table, defining the visual layout and appearance of the rows.
Declaration
public static readonly StylePropertyDefinition<int?, TableProperties> RowBandSizePropertyField Value
TableIndentProperty
Declaration
public static readonly StylePropertyDefinition<double?, TableProperties> TableIndentPropertyField Value
TableLookProperty
Declaration
public static readonly StylePropertyDefinition<TableLook, TableProperties> TableLookPropertyField Value
ThemeBackgroundProperty
Declaration
public static readonly StylePropertyDefinition<ThemeColorsEnum?, TableProperties> ThemeBackgroundPropertyField Value
ThemeFillShadeProperty
Declaration
public static readonly StylePropertyDefinition<string, TableProperties> ThemeFillShadePropertyField Value
ThemeFillTintProperty
Declaration
public static readonly StylePropertyDefinition<string, TableProperties> ThemeFillTintPropertyField Value
Properties
Background
Gets or sets the table background.
Declaration
[XamlSerializable]
public Color Background { get; set; }Property Value
Color
The background.
Borders
Gets or sets all borders of the table.
Declaration
[XamlSerializable]
public TableBorders Borders { get; set; }Property Value
The borders.
CellPadding
Gets or sets the cell padding.
Declaration
[XamlSerializable]
public Padding CellPadding { get; set; }Property Value
The cell padding.
CellSpacing
Gets or sets the cell spacing.
Declaration
[XamlSerializable]
public double CellSpacing { get; set; }Property Value
The cell spacing.
ColumnBandSize
Declaration
[XamlSerializable]
public int ColumnBandSize { get; set; }Property Value
FlowDirection
Gets or sets the flow direction of the table contents.
Declaration
[XamlSerializable]
public FlowDirection FlowDirection { get; set; }Property Value
FlowDirection
The flow direction.
Grid
Gets the grid of the table which keeps information about the rows and columns.
HorizontalAlignment
Gets or sets the horizontal alignment.
Declaration
[XamlSerializable(RadHorizontalAlignment.Left)]
public RadHorizontalAlignment HorizontalAlignment { get; set; }Property Value
The horizontal alignment.
LayoutMode
Gets or sets then table layout mode.
Declaration
[XamlSerializable]
public TableLayoutMode LayoutMode { get; set; }Property Value
The layout mode.
PreferredWidth
Gets or sets the preferred width of the table.
Declaration
[XamlSerializable]
public TableWidthUnit PreferredWidth { get; set; }Property Value
The preferred width.
RowBandSize
Declaration
[XamlSerializable]
public int RowBandSize { get; set; }Property Value
Rows
Gets the rows.
Declaration
public TableRowCollection Rows { get; }Property Value
The rows.
TableIndent
Gets or sets the table indent.
Declaration
[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.
Declaration
[XamlCompositePropertySerializable]
public TableLook TableLook { get; set; }Property Value
The table look.
ThemeBackground
Gets or sets the theme background.
Declaration
[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.
Declaration
[XamlSerializable]
public string ThemeFillShade { get; set; }Property Value
ThemeFillTint
Represents the tint applied to the theme fill of a table in the Telerik document model.
Declaration
[XamlSerializable]
public string ThemeFillTint { get; set; }Property Value
Methods
AddColumn()
Adds a column after the last one in the table.
Declaration
public IEnumerable<TableCell> AddColumn()Returns
A collection of the added TableCells.
AddColumnToTheLeft(TableCell)
Adds a column on the left side of an existing cell.
AddColumnToTheRight(TableCell)
Adds a column on the right side of an existing cell.
AddRow()
AddRow(TableRow)
Adds a TableRow as a last row in the table.
AddRowAbove(TableRow)
Copies a specified TableRow and adds the copy above it.
AddRowAbove(TableRow, TableRow)
Adds a TableRow above an existing one.
AddRowAtIndex(int)
Adds a copy of the nearest TableRow at a specific index.
Declaration
public TableRow AddRowAtIndex(int index)Parameters
index
The index.
Returns
The added TableRow instance.
Exceptions
Incorrect index value.
AddRowAtIndex(int, TableRow)
Adds a TableRow at a specific index.
Declaration
public TableRow AddRowAtIndex(int index, TableRow rowToAdd)Parameters
index
The index.
rowToAdd
The row to add.
Returns
The added TableRow instance.
Exceptions
Incorrect index value.
AddRowBelow(TableRow)
Copies a specified TableRow and adds the copy below it.
AddRowBelow(TableRow, TableRow)
Adds a TableRow below an existing one.
CopyPropertiesFromOverride(DocumentElement)
Copies the properties of a Table instance to the current object.
Declaration
protected override void CopyPropertiesFromOverride(DocumentElement fromElement)Parameters
fromElement
The Table to copy the properties from.
Overrides
CreateLayoutBox(DocumentStructureCollection)
Creates a new TableLayoutBox.
Declaration
public override LayoutBox CreateLayoutBox(DocumentStructureCollection documentCollection)Parameters
documentCollection
The document collection.
Returns
The new TableLayoutBox.
Overrides
CreateNewElementInstance()
Creates a new instance of the Table class.
Declaration
protected override DocumentElement CreateNewElementInstance()Returns
The new instance.
Overrides
DeleteRow(TableRow)
Deletes a TableRow.
Declaration
public void DeleteRow(TableRow row)Parameters
row
The row to delete.
Exceptions
Row must be from the same table.
GetGridColumnWidth(int)
Gets the width of the grid column.
Declaration
public TableWidthUnit GetGridColumnWidth(int gridColumnIndex)Parameters
gridColumnIndex
Index of the grid column. This index should not be affected of any merged cells.
Returns
A TableWidthUnit representing the width of the column.
OnStyleChanged()
Called after the style of a document element has been changed.
Declaration
protected override void OnStyleChanged()Overrides
SetGridColumnWidth(int, TableWidthUnit)
Sets the width of the grid column.
Declaration
public void SetGridColumnWidth(int gridColumnIndex, TableWidthUnit width)Parameters
gridColumnIndex
Index of the grid column. This index should not be affected of any merged cells.
width
The width.
Exceptions
gridColumnIndex should be greater than or equal to 0.