Script command submitted from PageStream internal documentation. Needs to be checked and merged with the command documentation above.

Gets the {...} .

LockInterface (<TRUE|FALSE>)

Parameters:

Results:

Notes:

See Also:

Examples:
Python:

The point of this command is to allow a script to run without the user inadvertently changing something about the document. For example, the SendTextToEditor script uses this. Otherwise the user could potentially, even accidentally, delete the originating text frame/frameless text object while the article was exported to the text editor.

If the script ends before calling LockInterface('false') the interface will remain locked and the only recourse is to force PageStream to exit. When using this command it is important to make sure that the interface will always be unlocked, even if the script crashes. Python: LockInterface("true") Refresh("wait") try: # some code finally: Refresh("continue") LockInterface("false")

This command is redundant for Python scripts because the interface is always locked while a Python script is running. However, it can still make sense to include this command in a Python script if, were the interface to be unlocked, it would be susceptible to user interference. This is a way of future-proofing the script in the event that some future version did not lock the interface when running Python scripts.

The locking of the interface that occurs automatically with Python scripts is safe. There is no danger of the user being locked out as there is with the LockInterface command.