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

RichEditCommands.changeFloatingObjectRelativePosition Property

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

Declaration

readonly changeFloatingObjectRelativePosition: ChangeFloatingObjectRelativePositionCommand

Property Value

Type Description
ChangeFloatingObjectRelativePositionCommand

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


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