RichEditCommands.changeTableCellFormatting Property
Gets a command to change the cell formatting of the selected table elements.
Declaration
get changeTableCellFormatting(): ChangeTableCellFormattingCommand
Property Value
Type | Description |
---|---|
ChangeTableCellFormattingCommand | An object that provides methods that execute the command and check its state. |
Remarks
Call the execute(settings) method to invoke the command. The method checks the command state (obtained via the getState method) to determine whether the action can be performed.
The command includes size parameters assigned in twips. Use the ASPxClientRichEdit.unitConverter to convert size measure units (inches, points, pixels, centimeters) to twips.
Usage example
var cellFormatSettings = {marginsSameAsTable: false, marginBottom: richEdit.unitConverter.pixelsToTwips(50)};
richEdit.commands.changeTableCellFormatting.execute(cellFormatSettings);
The vertical margin settings (top and bottom) for each table cell in a row is calculated by getting the maximum vertical margin values from all cells in the row.
The preferredWidth parameter allows you to specify a width value of selected table cells. The parameter is applied when the preferredWidth value of the whole table is cleared. The following code snippet demonstrates how to disable the width settings of the whole table and define the preferredWidth value for the selected table cells.
var tableSettings = {preferredWidth: {type: ASPx.TableWidthUnitType.Nil, value: 0}, resizeToFitContent: false};
richEdit.commands.changeTableFormatting.execute(tableSettings);
var tableCellSettings = {preferredWidth: {type: ASPx.TableWidthUnitType.ModelUnits, value: richEdit.unitConverter.pixelsToTwips(75)}};
richEdit.commands.changeTableCellFormatting.execute(tableCellSettings);
Refer to the following section for more information: Client Commands.