Class
TablePropertiesEditor

Encapsulates logic for editing current table in RadRichTextBox.

Definition

Namespace:Telerik.Windows.Documents.UI.Extensibility

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class TablePropertiesEditor

Inheritance: objectTablePropertiesEditor

Constructors

TablePropertiesEditor(RadRichTextBox)

Initializes a new instance of the TablePropertiesEditor class.

Declaration

cs-api-definition
public TablePropertiesEditor(RadRichTextBox radRichTextBox)

Parameters

radRichTextBox

RadRichTextBox

Properties

GridColumnsCount

Gets the current table grid columns count.

Declaration

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

Property Value

int

The grid columns count.

GridRowsCount

Gets the current table grid rows count.

Declaration

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

Property Value

int

The grid rows count.

InitialGridColumnIndex

Gets the initial grid column index of the current cell in the current table.

Declaration

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

Property Value

int

The initial grid column index of the current cell.

InitialGridRowIndex

Gets the initial grid row index of the current cell in the current table.

Declaration

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

Property Value

int

The initial index of the grid row.

Methods

ChangeTableRowHeight(TableRow, double)

Changes the height of the table row.

Declaration

cs-api-definition
public void ChangeTableRowHeight(TableRow row, double height)

Parameters

row

TableRow

The row.

height

double

The height.

ChangeTableRowRepeatOnEveryPage(TableRow)

Changes the table row repeat on every page property.

Declaration

cs-api-definition
public void ChangeTableRowRepeatOnEveryPage(TableRow row)

Parameters

row

TableRow

The row.

ClearAllTableCellBorders()

Clears all cell borders of the current table.

Declaration

cs-api-definition
public void ClearAllTableCellBorders()

ClearCommands()

Clears all the commands.

Declaration

cs-api-definition
public void ClearCommands()

ClearSelectedCellBorders()

Clears all adjacent cell borders of the currently selected cells.

Declaration

cs-api-definition
public void ClearSelectedCellBorders()

ExecuteCommands()

Executes all the commands.

Declaration

cs-api-definition
public void ExecuteCommands()

GetCurrentTable()

Retrieves the current table from the Table Properties Editor.

Declaration

cs-api-definition
public Table GetCurrentTable()

Returns

Table

The current table as an object of type T, or null if no table is currently selected.

GetGridColumnWidth(int)

Gets the width of the grid column.

Declaration

cs-api-definition
public TableWidthUnit GetGridColumnWidth(int gridColumnIndex)

Parameters

gridColumnIndex

int

Index of the grid column.

Returns

TableWidthUnit

GetTargetCells()

Gets selected cells, or current cell if there isn't selection.

Declaration

cs-api-definition
public IEnumerable<TableCell> GetTargetCells()

Returns

IEnumerable<TableCell>

SelectTableColumn(int)

Selects the table column.

Declaration

cs-api-definition
public void SelectTableColumn(int gridColumnIndex)

Parameters

gridColumnIndex

int

Index of the grid column.

SelectTableRow(int)

Selects the table row.

Declaration

cs-api-definition
public void SelectTableRow(int gridRowIndex)

Parameters

gridRowIndex

int

Index of the grid row.

SetGridColumnWidth(int, TableWidthUnit)

Sets the width of the grid column.

Declaration

cs-api-definition
public void SetGridColumnWidth(int gridColumnIndex, TableWidthUnit tableWidthUnit)

Parameters

gridColumnIndex

int

Index of the grid column.

tableWidthUnit

TableWidthUnit

The table width.

SetTableBorders(TableBorders)

Sets the target cells borders.

Declaration

cs-api-definition
public void SetTableBorders(TableBorders tableBorders)

Parameters

tableBorders

TableBorders

SetTableCellSpacing(double)

Changes the spacing between cells.

Declaration

cs-api-definition
public void SetTableCellSpacing(double cellSpacing)

Parameters

cellSpacing

double

The new cell spacing.

SetTableDefaultCellPadding(Padding)

Changes the table cells default padding.

Declaration

cs-api-definition
public void SetTableDefaultCellPadding(Padding defaultCellPadding)

Parameters

defaultCellPadding

Padding

The default cell padding for the table.

SetTableFlowDirection(FlowDirection)

Changes the table flow direction.

Declaration

cs-api-definition
public void SetTableFlowDirection(FlowDirection flowDirection)

Parameters

flowDirection

FlowDirection

The flow direction.

SetTableHorizontalAlignment(RadHorizontalAlignment)

Sets the horizontal alignment of the table.

Declaration

cs-api-definition
public void SetTableHorizontalAlignment(RadHorizontalAlignment tableAlign)

Parameters

tableAlign

RadHorizontalAlignment

The RadHorizontalAlignment value that specifies the horizontal alignment to set for the table.

SetTableIndent(double)

Changes the table indent.

Declaration

cs-api-definition
public void SetTableIndent(double tableIndent)

Parameters

tableIndent

double

The new indent.

SetTableWidth(TableWidthUnit)

Changes the width of the table.

Declaration

cs-api-definition
public void SetTableWidth(TableWidthUnit tableWidth)

Parameters

tableWidth

TableWidthUnit

Width of the table.

SetTargetCellsBackground(Color)

Sets the target cells background.

Declaration

cs-api-definition
public void SetTargetCellsBackground(Color backgroundColor)

Parameters

backgroundColor

Color

Color of the background.

SetTargetCellsBorders(TableCellBorders)

Sets the target cells borders.

Declaration

cs-api-definition
public void SetTargetCellsBorders(TableCellBorders cellBorders)

Parameters

cellBorders

TableCellBorders

The TableCellBorders.

SetTargetCellsContentAlignment(RadTextAlignment, RadVerticalAlignment)

Changes the table cell content alignment.

Declaration

cs-api-definition
public void SetTargetCellsContentAlignment(RadTextAlignment textAlignment, RadVerticalAlignment verticalAlignment)

Parameters

textAlignment

RadTextAlignment

The text alignment.

verticalAlignment

RadVerticalAlignment

The vertical content alignment.

SetTargetCellsPadding(Padding)

Changes the table cell padding.

Declaration

cs-api-definition
public void SetTargetCellsPadding(Padding cellPadding)

Parameters

cellPadding

Padding

The cell padding.