ChangeTableFormattingCommand.execute(settings) Method
Executes the ChangeTableFormattingCommand command by applying the specified setting.
May result in taking no action if the command’s state does not allow command execution. Use the object’s getState method to check the command state.
Declaration
execute(
settings: TableFormattingSettings
): boolean
Parameters
Name | Type | Description |
---|---|---|
settings | TableFormattingSettings | A TableFormattingSettings object containing the settings to format a table. |
Returns
Type | Description |
---|---|
boolean | A Boolean value identifying whether method execution was successful or failed. |
Remarks
The execute method checks the command state (obtained using the getState method) before executing, and decides 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 tableSettings = {
alignment: ASPx.TableRowAlignment.Right,
indent: richEdit.unitConverter.pixelsToTwips(200),
allowSpacingBetweenCells: true,
spacingBetweenCells: richEdit.unitConverter.pixelsToTwips(3)
};
richEdit.commands.changeTableFormatting.execute(tableSettings);
See Also