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	A ForceSyncWithServerCommand 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 ForceSyncWithServerCommand class.

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:

JS

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