Documentation

Class Table

Block-level flow content element that provides a grid-based organization.

Inheritance

System.Object

DocumentElementBase

BlockBase

Table

Inherited Members

BlockBase.BlockContainer

DocumentElementBase.EnumerateChildrenOfType<T>()

DocumentElementBase.Document

DocumentElementBase.Parent

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Flow.Model

Assembly: Telerik.Windows.Documents.Flow.dll

Syntax

public sealed class Table : BlockBase, IElementWithStyle, IElementWithProperties, ISdtBlock, IChildrenList

Constructors

Table(RadFlowDocument)

Initializes a new instance of the Table class.

Declaration

public Table(RadFlowDocument document)

Parameters

RadFlowDocument document The document in which the element will be added.

Table(RadFlowDocument, Int32, Int32)

Initializes a new instance of the Table class with given number of rows and columns.

Declaration

public Table(RadFlowDocument document, int rows, int columns)

Parameters

RadFlowDocument document The document.
System.Int32 rows The number of rows.
System.Int32 columns The number of columns.

Fields

AlignmentPropertyDefinition

Gets the alignment property definition.

Declaration

public static readonly StylePropertyDefinition<Alignment? > AlignmentPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<Alignment>>

BackgroundColorPropertyDefinition

Gets the background color property definition.

Declaration

public static readonly StylePropertyDefinition<ThemableColor> BackgroundColorPropertyDefinition

Field Value

StylePropertyDefinition<ThemableColor>

ColumnBandingPropertyDefinition

Gets the column banding property definition.

Declaration

public static readonly StylePropertyDefinition<int? > ColumnBandingPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Int32>>

FlowDirectionPropertyDefinition

Gets the flow direction property definition.

Declaration

public static readonly StylePropertyDefinition<FlowDirection? > FlowDirectionPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<FlowDirection>>

IndentPropertyDefinition

Gets the indent property definition.

Declaration

public static readonly StylePropertyDefinition<double? > IndentPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

LayoutTypePropertyDefinition

Gets the layout type property definition.

Declaration

public static readonly StylePropertyDefinition<TableLayoutType? > LayoutTypePropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<TableLayoutType>>

LooksPropertyDefinition

Gets the table looks property definition.

Declaration

public static readonly StylePropertyDefinition<TableLooks? > LooksPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<TableLooks>>

OverlapPropertyDefinition

Gets the overlap property definition.

Declaration

public static readonly StylePropertyDefinition<bool? > OverlapPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Boolean>>

PreferredWidthPropertyDefinition

Gets the preferred width property definition.

Declaration

public static readonly StylePropertyDefinition<TableWidthUnit> PreferredWidthPropertyDefinition

Field Value

StylePropertyDefinition<TableWidthUnit>

RowBandingPropertyDefinition

Gets the row banding property definition.

Declaration

public static readonly StylePropertyDefinition<int? > RowBandingPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Int32>>

ShadingPatternColorPropertyDefinition

Gets the shading pattern color property definition.

Declaration

public static readonly StylePropertyDefinition<ThemableColor> ShadingPatternColorPropertyDefinition

Field Value

StylePropertyDefinition<ThemableColor>

ShadingPatternPropertyDefinition

Gets the shading pattern property definition.

Declaration

public static readonly StylePropertyDefinition<ShadingPattern? > ShadingPatternPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<ShadingPattern>>

TableBordersPropertyDefinition

Gets the top border property definition.

Declaration

public static readonly StylePropertyDefinition<TableBorders> TableBordersPropertyDefinition

Field Value

StylePropertyDefinition<TableBorders>

TableCellPaddingPropertyDefinition

Gets the table cell padding property definition.

Declaration

public static readonly StylePropertyDefinition<Padding> TableCellPaddingPropertyDefinition

Field Value

StylePropertyDefinition<Padding>

TableCellSpacingPropertyDefinition

Gets the table cell spacing property definition.

Declaration

public static readonly StylePropertyDefinition<double? > TableCellSpacingPropertyDefinition

Field Value

StylePropertyDefinition<System.Nullable<System.Double>>

Properties

Alignment

Gets or sets the alignment of the table.

Declaration

public Alignment Alignment { get; set; }

Property Value

Alignment The default value is `Left`.

Borders

Gets or sets the borders of the table.

Declaration

public TableBorders Borders { get; set; }

Property Value

TableBorders The borders.

FlowDirection

Gets the flow direction of cells inside the table.

Declaration

public FlowDirection FlowDirection { get; set; }

Property Value

FlowDirection The default value is `LeftToRight`.

GridColumnsCount

Gets the number of columns in the table grid.

Declaration

public int GridColumnsCount { get; }

Property Value

System.Int32 The grid columns count.

GridRowsCount

Gets the number of rows in the table grid.

Declaration

public int GridRowsCount { get; }

Property Value

System.Int32 The grid rows count.

HasCellSpacing

Gets a value indicating whether there is cell spacing in the table.

Declaration

public bool HasCellSpacing { get; }

Property Value

System.Boolean True if there is cell spacing.

Indent

Gets or sets a value which shall be added before the leading edge of the table. The value is in device independent pixels (1/96 inch).

Declaration

public double Indent { get; set; }

Property Value

System.Double The default value is `0`.

LayoutType

Gets or sets a value indicating which algorithm shall be used to lay out the content of the table.

Declaration

public TableLayoutType LayoutType { get; set; }

Property Value

TableLayoutType The default value is `AutoFit`.

Looks

Gets or sets the value indicating which components of the conditional style should be applied if such exists.

Declaration

public TableLooks Looks { get; set; }

Property Value

TableLooks The default value is `BandedRows \| BandedColumns`.

Overlap

Gets or sets a value indicating whether this floating table shall allow other floating tables to overlap its extents.

Declaration

public bool Overlap { get; set; }

Property Value

System.Boolean The default value is `true`.

PreferredWidth

Gets or sets the width of the preferred.

Declaration

public TableWidthUnit PreferredWidth { get; set; }

Property Value

TableWidthUnit The width of the preferred.

Properties

Gets the styling properties of this element.

Declaration

public TableProperties Properties { get; }

Property Value

TableProperties The properties.

Rows

Gets the rows of the table.

Declaration

public TableRowCollection Rows { get; }

Property Value

TableRowCollection The rows.

Shading

Gets the shading which shall be applied to the extents of the table.

Declaration

public Shading Shading { get; }

Property Value

Shading The shading.

StyleId

Gets or sets the style id.

Declaration

public string StyleId { get; set; }

Property Value

System.String The style id.

Implements

IElementWithStyle.StyleId

TableCellPadding

Gets or sets default padding of the cells inside the table.

Declaration

public Padding TableCellPadding { get; set; }

Property Value

Padding The table cell padding.

TableCellSpacing

Gets or sets a value indicating the spacing between adjacent cells and the edges of the table. The value is in device independent pixels (1/96 inch).

Declaration

public double TableCellSpacing { get; set; }

Property Value

System.Double The table cell spacing.

Methods

Clone()

Creates deep copy of this document element, associated to the current document.

Declaration

public Table Clone()

Returns

Table The cloned element.

Clone(RadFlowDocument)

Creates deep copy of this document element, associated to document.

Declaration

public Table Clone(RadFlowDocument document)

Parameters

RadFlowDocument document The document to which the cloned element should be associated.

Returns

Table The cloned element.

OnChildAdded(DocumentElementBase)

Called when child element is added.

Declaration

protected override void OnChildAdded(DocumentElementBase child)

Parameters

DocumentElementBase child The child element.

Overrides

DocumentElementBase.OnChildAdded(DocumentElementBase)

OnChildRemoved(DocumentElementBase)

Called when child element is removed.

Declaration

protected override void OnChildRemoved(DocumentElementBase child)

Parameters

DocumentElementBase child The child element.

Overrides

DocumentElementBase.OnChildRemoved(DocumentElementBase)

Explicit Interface Implementations

IElementWithProperties.Properties

Gets the properties.

Declaration

DocumentElementPropertiesBase IElementWithProperties.Properties { get; }

Returns

DocumentElementPropertiesBase The properties.

Implements

IElementWithProperties.Properties