ChangeFloatingObjectTextWrappingCommand.execute(settings) Method

Executes the ChangeFloatingObjectTextWrappingCommand 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(
    settings: FloatingObjectTextWrappingSettings
): boolean

Parameters

Name	Type	Description
settings	FloatingObjectTextWrappingSettings	A FloatingObjectTextWrappingSettings object specifying text wrapping settings.

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.

Usage example (it is implied that selection is set to a floating object):

JS

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);