ChangeFloatingObjectAlignmentPositionCommand.execute(settings) Method

Executes the ChangeFloatingObjectAlignmentPositionCommand command with the specified parameter.

Declaration

execute(
    settings: FloatingObjectAlignmentPositionSettings
): boolean

Parameters

Name Type Description
settings FloatingObjectAlignmentPositionSettings

A FloatingObjectAlignmentPositionSettings object specifying alignment position settings.

Returns

Type Description
boolean

true if the command has been successfully executed; false if the command execution has failed.

Remarks

Usage example (it is implied that selection is set to an inline or floating picture object):

var settings = {
    horizontalPositionAlignment: ASPx.FloatingObjectHorizontalPositionAlignment.Center,
    horizontalPositionType: ASPx.FloatingObjectHorizontalPositionType.Page,
    verticalPositionAlignment: ASPx.FloatingObjectVerticalPositionAlignment.Top,
    verticalPositionType: ASPx.FloatingObjectVerticalPositionType.Page,
};

rich.commands.changeFloatingObjectAlignmentPosition.execute(settings);
See Also