ChangeFloatingObjectLockAnchorCommand.execute(lockAnchor) Method

Executes the ChangeFloatingObjectLockAnchorCommand command with the specified parameter.

Declaration

execute(
    lockAnchor: boolean
): boolean

Parameters

Name	Type	Description
lockAnchor	boolean	true to lock the anchor; false, otherwise.

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 a floating object):

JS

richEdit.commands.changeFloatingObjectLockAnchor.execute(true);