Skip to main content
A newer version of this page is available. .
cut

RichEditCommands.forceSyncWithServer Property

Gets a command to force synchronizing the server document model with the client model and execute a callback function if it is necessary.

Declaration

readonly forceSyncWithServer: ForceSyncWithServerCommand

Property Value

Type Description
ForceSyncWithServerCommand

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

Remarks

Call the execute(callback) method to invoke the command. The method checks the command state (obtained via the getState method) to determine whether the action can be performed.

Use this command for sending the latest changes made in a document to the server to avoid losing these changes when a server-side operation (for example, saving) is performed. Note that all changes made in the document after sending client model cannot be handled in the callback.

Usage example:

richEdit.commands.forceSyncWithServer.execute();
richEdit.commands.forceSyncWithServer.execute(function() {});

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

See Also