cut

RichEditCommands.changeSectionColumns Property

Gets a command to apply column layout settings to a section.

Declaration

readonly changeSectionColumns: ChangeSectionColumnsCommand

Property Value

Type Description
ChangeSectionColumnsCommand

An object that provides methods that execute the command and check its state.

Remarks

Call the execute(columns) 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 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]);

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

See Also