Class
TableRow

Row within a table containing cells, supporting height constraints, page break control, header row repetition, and cell spacing settings.

Definition

Namespace:Telerik.Windows.Documents.Flow.Model

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition
public sealed class TableRow : DocumentElementBase, IElementWithProperties

Inheritance: objectDocumentElementBaseTableRow

Implements: IElementWithProperties

Inherited Members DocumentElementBase.EnumerateChildrenOfType<T>()DocumentElementBase.DocumentDocumentElementBase.Parent

Constructors

TableRow(RadFlowDocument)

Initializes a new TableRow with default formatting and an empty cell collection in the specified document.

Declaration

cs-api-definition
public TableRow(RadFlowDocument document)

Parameters

document

RadFlowDocument

The document in which the element will be added.

Fields

CanSplitPropertyDefinition

Style property definition for controlling whether row content can be split across page breaks.

Declaration

cs-api-definition
public static readonly StylePropertyDefinition<bool?> CanSplitPropertyDefinition

Field Value

StylePropertyDefinition<bool?>

HeightPropertyDefinition

Style property definition for row height, supporting auto, at-least, and exact height modes in device independent pixels (1/96 inch).

Declaration

cs-api-definition
public static readonly StylePropertyDefinition<TableRowHeight> HeightPropertyDefinition

Field Value

StylePropertyDefinition<TableRowHeight>

HorizontalAlignmentPropertyDefinition

Style property definition for horizontal alignment of cells within the row.

Declaration

cs-api-definition
public static readonly StylePropertyDefinition<Alignment> HorizontalAlignmentPropertyDefinition

Field Value

StylePropertyDefinition<Alignment>

RepeatOnEveryPagePropertyDefinition

Style property definition for controlling whether the row repeats as a header at the top of each page.

Declaration

cs-api-definition
public static readonly StylePropertyDefinition<bool?> RepeatOnEveryPagePropertyDefinition

Field Value

StylePropertyDefinition<bool?>

TableCellSpacingPropertyDefinition

Style property definition for cell spacing in the row, overriding the table's default cell spacing when set.

Declaration

cs-api-definition
public static readonly StylePropertyDefinition<double?> TableCellSpacingPropertyDefinition

Field Value

StylePropertyDefinition<double?>

Properties

CanSplit

Controls whether row content can be split across page breaks; when false, the entire row remains on one page.

Declaration

cs-api-definition
public bool CanSplit { get; set; }

Property Value

bool

The default value is true.

Cells

Collection of cells contained in this row, providing add, insert, and remove operations for row structure.

Declaration

cs-api-definition
public TableCellCollection Cells { get; }

Property Value

TableCellCollection

The cells.

GridRowIndex

Zero-based row index in the table grid, automatically calculated based on row positions and cell row spans.

Declaration

cs-api-definition
public int GridRowIndex { get; }

Property Value

int

The index of the row in the table grid.

Height

Row height specification, supporting auto, at-least, and exact height modes with values in device independent pixels (1/96 inch).

Declaration

cs-api-definition
public TableRowHeight Height { get; set; }

Property Value

TableRowHeight

The height.

HorizontalAlignment

Horizontal alignment of cells in this row, controlling left, center, or right positioning within the table width.

Declaration

cs-api-definition
public Alignment HorizontalAlignment { get; set; }

Property Value

Alignment

Properties

Row formatting properties, providing access to height, cell spacing, page break behavior, header repetition, and horizontal alignment settings.

Declaration

cs-api-definition
public TableRowProperties Properties { get; }

Property Value

TableRowProperties

The properties.

RepeatOnEveryPage

Controls whether this row is repeated as a header at the top of each page when the table spans multiple pages.

Declaration

cs-api-definition
public bool RepeatOnEveryPage { get; set; }

Property Value

bool

The default value is false.

Table

Parent table containing this row, providing access to table-level formatting and the grid structure.

Declaration

cs-api-definition
public Table Table { get; }

Property Value

Table

The table.

TableCellSpacing

Space between adjacent cells in this row in device independent pixels (1/96 inch), overriding the table's default cell spacing when set.

Declaration

cs-api-definition
public double TableCellSpacing { get; set; }

Property Value

double

The default value is 0.

Methods

Clone()

Creates a deep copy of this row including all cells and formatting properties, associated to the same document.

Declaration

cs-api-definition
public TableRow Clone()

Returns

TableRow

The cloned element.

Clone(RadFlowDocument)

Creates a deep copy of this row including all cells and formatting properties, associated to the specified document for cross-document copying.

Declaration

cs-api-definition
public TableRow Clone(RadFlowDocument document)

Parameters

document

RadFlowDocument

The document to which the cloned element should be associated.

Returns

TableRow

The cloned element.

OnChildAdded(DocumentElementBase)

Called when child element is the added.

Declaration

cs-api-definition
protected override void OnChildAdded(DocumentElementBase child)

Parameters

child

DocumentElementBase

The child element.

Overrides DocumentElementBase.OnChildAdded(DocumentElementBase)

OnChildRemoved(DocumentElementBase)

Called when child element is removed.

Declaration

cs-api-definition
protected override void OnChildRemoved(DocumentElementBase child)

Parameters

child

DocumentElementBase

The child element.

Overrides DocumentElementBase.OnChildRemoved(DocumentElementBase)