- O -

open
openbusyrequester
opendocument
openwindow

OPEN File Commands

This opens a document and a window.

open <filepath>

filepath/s The filepath and name of the document.

Examples:

open 'PageStream3:documents/Project.doc'

OPENBUSYREQUESTER Dialog Box Commands

Displays a busy dialog box. Use this to provide feedback during a lengthy script process. Returns the dialog box handle to RESULT.

openbusyrequester [MESSAGE text] [THERMOMETER status] [ABORT status] [TOTAL value] [CURRENT value]

MESSAGE/s The single line of text to display.

THERMOMETER/k Specifies whether the thermometer is used.

Options: ENABLED | DISABLED. ABORT

Specifies whether the Stop button is available.

Options: ENABLED | DISABLED.

TOTAL/i Sets the thermometer's total value.

CURRENT/i Sets the thermometer's current value.

Results:

The handle (identification number) of the busy dialog box is returned to RESULT. The handle is required in order to set the thermometer value and message text later, and to get the state of the Stop button.

Examples:

openbusyrequester message 'Thinking...' thermometer ¨   enabled total 100 current 0
   bh=RESULT
do for i = 1 to 100
   /* script does something here */
   /* abort if stop is clicked else set mometer */
   getbusyrequester bh
   if result=1 then break else setbusyrequester bh ¨      current i
end i
closebusyrequester bh

OPENDOCUMENT File Commands

This opens a document without opening a window.

opendocument [FILE filepath] [FILTER name] [progress]

FILE/s The filename and path of the file.

FILTER/k The filter to use.

Options: IFFDOC (PageStream3) | PAGESTREAM2 | PROPAGE | WORDWORTHDOC.

progress/k Toggle to display a progress meter.

Options: STATUS | NOSTATUS (default).

Notes:

If the FILE parameter is not specified, a file selector will open.

If the FILTER parameter is not specified, the appropriate filter will be used.

This command is not equivalent to the menu's Open command. It opens a document file from disk like Open, but does not open a window for the document. To open a window, use the openwindow command. To change the page displayed in an open window, use the display command.

Examples:

opendocument 'PageStream3:Documents/Project' status

opendocument filter 'PGS2.filter'

OPENWINDOW File Commands

This opens a new window for an open document.

openwindow <windowname> [DOCUMENT name] [PAGE number | MPG name] [SCALE <custom | preset>] [OFFSET offsetx offsety]

windowname/s The name of the new window.

DOCUMENT/s The document name. Default=current.

PAGE/s The page number to display.

MPG/s The master page and side to display.

custom/d The custom view percentage.

preset/k The view magnification to set.

Options: FULLPAGE | FULLPAGEWIDTH | FULLPAGEHEIGHT | FULLPASTEBOARD | FULLPASTEBOARDWIDTH | FULLPASTEBOARDHEIGHT | LASTUSED.

OFFSET/d The page offset from the top left of the window. Default=current.

Examples:

openwindow 'MyWindow' document 'Untitled 1' page 6

openwindow 'Workspace' scale fullpage