ChangeTableCellPreferredWidthCommand.execute(preferredWidth) Method

Executes the ChangeTableCellPreferredWidthCommand command with the specified parameter.

Declaration

execute(
    preferredWidth: TableWidthUnit
): boolean

Parameters

Name Type Description
preferredWidth TableWidthUnit

A TableWidthUnit object specifying preferred width of the selected table rows.

Returns

Type Description
boolean

true if the command has been successfully executed; false if the command execution has failed.

Remarks

The command includes size parameters assigned in twips. Use the ASPxClientRichEdit.unitConverter to convert size measure units (inches, points, pixels, centimeters) to twips.

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 cellWidthSettings = {type: ASPx.TableWidthUnitType.ModelUnits, value: richEdit.unitConverter.pixelsToTwips(75)};
richEdit.commands.changeTableCellPreferredWidth.execute(cellWidthSettings);
See Also