ChangeFloatingObjectTextWrappingCommand.execute(settings) Method

Executes the ChangeFloatingObjectTextWrappingCommand command with the specified parameter.

Declaration

execute(
    settings: FloatingObjectTextWrappingSettings
): boolean

Parameters

Name Type Description
settings FloatingObjectTextWrappingSettings

A FloatingObjectTextWrappingSettings object specifying text wrapping settings.

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 (it is implied that selection is set to a floating object):

var settings = {
    floatingObjectTextWrapType: ASPx.FloatingObjectTextWrapType.Square,
    floatingObjectTextWrapSide: ASPx.FloatingObjectTextWrapSide.Both,
    leftDistance: rich.unitConverter.pixelsToTwips(10),
    rightDistance: rich.unitConverter.pixelsToTwips(10),
    topDistance: rich.unitConverter.pixelsToTwips(10),
    bottomDistance: rich.unitConverter.pixelsToTwips(10)
};
rich.commands.changeFloatingObjectTextWrapping.execute(settings);
See Also