ChangeSectionColumnsCommand.execute(columns) Method

Executes the ChangeSectionColumnsCommand 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(
    columns: SectionColumn[]
): boolean

Parameters

Name	Type	Description
columns	SectionColumn[]	An array of SectionColumn objects.

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.

The parameter array’s length defines the number of columns in the section. Each array element stores the settings of a corresponding column.

Usage example:

JS

var firstColumn = {
    width: richEdit.unitConverter.pixelsToTwips(200),
    spacing: richEdit.unitConverter.pixelsToTwips(20)
}

var secondColumn = {
    width: richEdit.unitConverter.pixelsToTwips(300),
    spacing: 0
}

richEdit.commands.changeSectionColumns.execute([firstColumn, secondColumn]);