The requested page is not available for the requested platform. You are viewing the content for Default platform.
cut

RichEditCommands.changeSectionColumns Property

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

Declaration

readonly changeSectionColumns: ChangeSectionColumnsCommand

Property Value

Type Description
ChangeSectionColumnsCommand

A ChangeSectionColumnsCommand object that provides methods for executing the command and checking its state.

Remarks

You can invoke this command by calling the execute method.

The execute method checks the command state (obtained using the getState method) before executing, and decides whether the action can be performed. The execute and getState methods are members of the ChangeSectionColumnsCommand class.

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