ScreenUpdating for command chains

These commands are a screen updating feature which is handy when using command chains. In this way, redrawing in Word will be suspended to perform the chain of commands, and then normal redrawing will be resumed after the command chain.

Module is located here: 

...\ModuleLibrary\BaseExtensions\04_nocontext_MISC\17_screenUpdatingForCommandChain.xml

CMD: <Cmd case="BaseExtensions:ScreenUpdatingSuspend"/>

Description: Suspends redrawing in Word. This command has several parameters to control the behavior of the MS Word UX. Insert the command chain after this command. 

Parameters:

DisableRibbon or disable-ribbon

This parameter specifies whether or not the redrawing of the ribbon should be disabled. Define this parameter to be true if the ribbon should disappear during the execution of the command chain. The parameter should only be set to true for long running processes that potentially require time-consuming, dynamic updates of Word during execution, such as manipulating large tables or making many selections during the process. 

The default value is false, which matches normal behavior. This parameter can be omitted. 

DisableStatusbar or disable-statusbar

This parameter specifies whether or not the redrawing of the status bar in Word should be disabled. Define this parameter to be true if the status bar should disappear during execution of the command chain. Just like the parameter above, this should only be set for long running processes, such as word-counting and spell-checking. 

The default value is false, which matches normal behavior. This parameter can be omitted.  

StatusBarMessage or status-bar-message

This parameter allows for a message to be presented to the user via the status bar whilst screen updating is suspended. Note that this will only work if DisableStatusbar is set to false or ommitted.

LogPerformance or log-performance

This parameter specifies whether or not a stop watch should be activated. This will measure the time spent until the ScreenUpdatingResume command is called. The duration will be written to the log file and a connected debugger.

The default value is true. This parameter can be omitted. 

DisplayElapsedTime or display-elapsed-time

This parameter specifies whether or not to force the ScreenUpdatingResume command to display a modal dialog box containing information about the time spend collected by the parameter above. Define this parameter to be true if the ScreenUpdatingResume command should display the time and stop any other activity until the OK button is pressed. 

The default value is false. This parameter must be omitted in solutions delivered to customers. Instead, this parameter is intended for internal testing only. 

CMD: <Cmd case="BaseExtensions:ScreenUpdatingResume"/>

Description: Restores normal Word behavior. Insert the command chain before this command.