RichEditCommands.changeFloatingObjectRelativePosition Property

Gets a command to modify a floating object’s relative position.

Declaration

readonly changeFloatingObjectRelativePosition: ChangeFloatingObjectRelativePositionCommand

Property Value

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

Remarks

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

JS

var settings = {
    horizontalRelativePosition: rich.unitConverter.pixelsToTwips(10), 
    horizontalPositionType: ASPx.FloatingObjectHorizontalPositionType.Page,
    verticalRelativePosition: rich.unitConverter.pixelsToTwips(20),
    verticalPositionType: ASPx.FloatingObjectVerticalPositionType.Page,
};

rich.commands.changeFloatingObjectRelativePosition.execute(settings);

Refer to the following section for more information: Client Commands.