clearmask
closebusyrequester
closedocument
closepath
closewindow
colorpalette
converttopath
copyobject
copytext
createcolumns
createcompound
createdrawing
createpath
createpoint
currentchapter
currentchapterpath
currentdocument
currentmasterpage
currentmasterpagepath
currentpage
currentpagepath
currentwindow
currentwindowpath
cutobject
cuttext
Deletes the mask for a graphic.
clearmask [DOCUMENT name | WINDOW name | OBJECTID number]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to edit.
Examples:
clearmask clearmask objectid hPic15
Closes a script's progress meter box.
closebusyrequester <handle>
handle/i The handle of the dialog box to close.
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 pressed, else set meter */
getbusyrequester bh
if result=1 then break
else setbusyrequester bh current i
end i
closebusyrequester bh
Close an open document.
closedocument [mode] [DOCUMENT name | WINDOW name]
mode/k The user prompt mode for unsaved documents. Options: FORCE | ALERT | QUIET (default). Force ignores the saved status, alert opens an alert box if it has been changed, and quiet ignores the saved status but returns an error if the document had not been saved.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Notes:
This command closes all open views of the document and the document itself. To close a single view of a document, use the closewindow command.
Examples:
closedocument force document 'project.doc'
Closes the selected open polygon paths.
closepath [PAGE number | WINDOW name | OBJECTID number]
PAGE/s The page name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Examples:
closepath page 'project.doc~6'
Close an open window.
closewindow [WINDOW name]
WINDOW/s The window name. Default=current.
Notes:
This command closes a single view of the document. To close all open views of a document, use the closedocument command. Even if you close the last open window with this command, the document will remain open, albeit invisibly.
Examples:
closewindow window 'Untitled~View.1'
Displays the color palette.
colorpalette [status] [AT pointx pointy] [SIZE width height] [COLLAPSED state] [SAVE]
status/k The palette's display status. Options: SHOW | HIDE | TOGGLE.
AT/i The palette position in pixels.
SIZE/i The palette size in pixels.
COLLAPSED/k The collapsed state of the palette. Options: ON | OFF.
SAVE Saves the palette settings to the PageStream3 Preferences file.
Notes:
TOGGLE may not be used in conjunction with SAVE.
Examples:
colorpalette toggle colorpalette show at 500 300 size 180 172 save colorpalette hide
Converts an object to a path.
converttopath [DOCUMENT name | WINDOW name | OBJECTID number]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Examples:
converttopath converttopath window 'Untitled~View.1'
Copies the selected object(s) to the clipboard.
copyobject [progress] [DOCUMENT name | WINDOW name | OBJECTID number]
progress/k Toggle to display a progress meter. Options: STATUS|NOSTATUS (default).
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to copy.
Examples:
copyobject copyobject status document 'project.doc'
Copies the selected text to the clipboard.
copytext [progress] [DOCUMENT name | WINDOW name]
progress/k Toggle to display a progress meter. Options: STATUS|NOSTATUS (default).
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
copytext copytext status document 'project.doc'
Cuts the selected object(s) to the clipboard.
cutobject [progress] [DOCUMENT name | WINDOW name | OBJECTID number]
progress/k Toggle to display a progress meter. Options: STATUS|NOSTATUS (default).
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to cut.
Examples:
cutobject cutobject status document 'project.doc'
Cuts the selected text to the clipboard.
cuttext [progress] [DOCUMENT name | WINDOW name]
progress/k Toggle to display a progress meter. Options: STATUS|NOSTATUS (default).
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
cuttext cuttext status document 'project.doc'
Draws text frames on a range of pages with one or more columns in them.
createcolumns [DEFAULT | MARGINS inside top outside bottom] [COLUMNS number] [GUTTER space] [link] [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [IDLIST stem] [PAGE number | WINDOW name] [TO number]
DEFAULT Creates frames matching the page guides. Default.
MARGINS/d The coordinates of the frames to create.
COLUMNS/i The number of columns in the frame. Default=1.
GUTTER/d The space between columns. Default=0.
link/k Specifies whether the frames are linked. Options: LINKED|UNLINKED.
ROTATE/d The rotation angle. Default=0.
SKEW/d The slant and twist angle. Default=0.
SLANT/d The slant angle. Default=0.
TWIST/d The twist angle. Default=0.
ABOUT/d The rotation point.
ABOUTCENTER Rotates around its center. Default.
constraint/k The aspect ratio constraint toggle. Options: CONSTRAIN|FREE (default).
printable/k The print object toggle. Options: PRINT (default)|NOPRINT.
stack/k The stack position. Options: INFRONT (default)|INBACK.
IDLIST/a Returns the object IDs for the new frames.
PAGE/s The page number. Default=current.
WINDOW/s The window name. Default=current.
TO/i The number of the last page in the range. Default=same as PAGE.
Results:
The identification number (handle) of the last text frame created is returned to RESULT.
IDLIST stem
count Number of frames created.
0 The object id of the first frame.
1 The object id of the second frame.
etc.
Notes:
Use the drawcolumn command to draw a single column on one page and to draw a fixed size column. Use the createcolumns command to draw columns on more than one page, and to draw columns relative to the page size.
Examples:
createcolumns default columns 2 gutter 0.25 column createcolumns margin 1 1.25 0.75 1 page 5 to 15 createcolumns default rotate 45 inback page 'MyDoc~8'
Merges the selected shapes together to create a compound object.
createcompound [POSITION left top right bottom] [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [DOCUMENT name | WINDOW name]
POSITION/d The coordinates of the object. Default=current bounding box.
ROTATE/d The rotation angle. Default=0.
SKEW/d The slant and twist angle. Default=0.
SLANT/d The slant angle. Default=0.
TWIST/d The twist angle. Default=0.
ABOUT/d The rotation point.
ABOUTCENTER Rotates around its center. Default.
constraint/k The aspect ratio constraint toggle. Options: CONSTRAIN|FREE (default).
printable/k The print object toggle. Options: PRINT (default)|NOPRINT.
stack/k The stack position. Options: INFRONT (default) | INBACK.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Results:
The identification number (handle) of the new object is returned to RESULT.
Examples:
createcompound createcompound position 1.5 2.5 3.25 6.4 constrain
Creates a new drawing.
createdrawing [POSITION left top right bottom] [CONTENTOFFSET offsetx offsety] [CONTENTSCALE scalex scaley] [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [frame] [DOCUMENT name | WINDOW name]
POSITION/d The coordinates of the frame. Default=current bounding box.
CONTENTOFFSET/d The offset in the frame. Default=0,0.
CONTENTSCALE/d The scale of the object in the frame. Default=100%.
ROTATE/d The rotation angle. Default=0.
SKEW/d The slant and twist angle. Default=0.
SLANT/d The slant angle. Default=0.
TWIST/d The twist angle. Default=0.
ABOUT/d The rotation point.
ABOUTCENTER Rotates around its center. Default.
constraint/k The aspect ratio constraint toggle. Options: CONSTRAIN|FREE (default).
printable/k The print object toggle. Options: PRINT (default) | NOPRINT.
stack/k The stack position. Options: INFRONT (default)|INBACK.
frame/k Specifies whether the object is framed. Options: FRAMED|FRAMELESS.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Results:
The identification number (handle) of the new object is returned to RESULT.
Examples:
createdrawing createdrawing position 1.5 2.5 3.25 6.457 contentscale 80.5 constrain
Starts a new path.
createpath <left top right bottom> [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [PAGE number | WINDOW name]
left.../d The coordinates of the object.
ROTATE/d The rotation angle. Default=0.
SKEW/d The slant and twist angle. Default=0.
SLANT/d The slant angle. Default=0.
TWIST/d The twist angle. Default=0.
ABOUT/d The rotation point.
ABOUTCENTER Rotates around its center. Default.
constraint/k The aspect ratio constraint toggle. Options: CONSTRAIN|FREE (default).
printable/k The print object toggle. Options: PRINT (default)|NOPRINT.
stack/k The stack position. Options: INFRONT (default)|INBACK.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Results:
The identification number (handle) of the new object is returned to RESULT.
Examples:
createpath 1.5 2.5 3.25 6.457 scale 80.5 constrain
Adds a point to an existing selected path.
createpoint <NEAR x y> [DOCUMENT name | WINDOW name | OBJECTID number]
NEAR/d The position near which to create the point. The point will be created at the point on the path closest to these coordinates.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Examples:
createpoint near 5.1 6.25 createpoint near 1.025 2.56 'project.doc~8'
Gets the name of the current chapter.
currentchapter [DOCUMENT name | WINDOW name]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name.
Results:
The name is returned to RESULT.
Examples:
currentchapter
Gets the full path of the current chapter. The path is: documentname[:chaptername[:subchaptername]]
currentchapterpath [DOCUMENT name | WINDOW name]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name.
Results:
The path is returned to RESULT.
Examples:
currentchapterpath
Gets the name of the current document.
currentdocument [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
The name is returned to RESULT.
Examples:
currentdocument
Gets the name of the current master page.
currentmasterpage [DOCUMENT name | WINDOW name]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name.
Results:
The name is returned to RESULT.
Examples:
currentmasterpage
Gets the full path of the master page of the current
page. The path is: [document[:chapter[:subchapter]~]masterpage
currentmasterpagepath [DOCUMENT name | WINDOW name]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name.
Results:
The path is returned to RESULT.
Examples:
currentmasterpagepath
Gets the number of the current page.
currentpage [WINDOW name]
PAGE The page number. Default=current.
WINDOW/s The window name.
Results:
The number is returned to RESULT.
Examples:
currentpage
Gets the full path of the current page. The path is: [document[:chapter[:subchapter]~]pagenumber
currentpagepath [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
The path is returned to RESULT.
Examples:
currentpagepath
Gets the name of the current window.
currentwindow
WINDOW/s The window name. Default=current.
Results:
The name is returned to RESULT.
Examples:
currentwindow
Gets the full path of the current window. The path is: [documentname~]windowname
currentwindowpath [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
The path is returned to RESULT.
Examples:
currentwinpath