ChangeTabsCommand.execute(settings) Method

Executes the ChangeTabsCommand command with the specified parameter.

Declaration

execute(
    settings: TabsSettings
): boolean

Parameters

Name Type Description
settings TabsSettings

A TabsSettings object maintaining the information about tab stops.

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.

Usage example:

var tabSettings = {
    defaultTabStop: richEdit.unitConverter.pixelsToTwips(40),
    tabs: [{
        alignment: ASPx.TabAlign.Center,
        leader: ASPx.TabLeaderType.ThickLine,
        position: richEdit.unitConverter.pixelsToTwips(90),
        deleted: false
    }, {
        alignment: ASPx.TabAlign.Right,
        leader: ASPx.TabLeaderType.EqualSign,
        position: richEdit.unitConverter.pixelsToTwips(200),
        deleted: false
    }]
};

richEdit.commands.changeTabs.execute(tabSettings);
See Also