deletechapter
deleteobject
deleteguides
deletemasterpage
deletepage
deletepoint
deletestyletag
deletetext
deletevariable
display
displaygrid
displayguides
displayruler
dissolvecompound
dissolvedrawing
dissolveeps
dissolveobject
distribute
doarexxrequester
documentpalette
drawbox
drawcolumn
drawellipse
draweps
drawgrid
drawline
drawpicture
drawpolygon
drawtextobj
duplicate
Deletes a chapter in a document.
deletechapter [CHAPTER name | WINDOW name] [ALERT]
CHAPTER/s The chapter name. Default=current.
WINDOW/s The window name. Default=current.
ALERT opens an alert box. Default=off.
Examples:
deletechapter chapter 'DocumentName:Chapter 3 alert'
Deletes existing guide(s) from a master page.
deleteguides [type] <AT position MPG name>
type/k The guide axis. Options: HORIZONTAL | VERTICAL.
AT/d The position(s) of the guide(s) to delete.
MPG/s The master page name and side.
Examples:
deleteguides vertical at 2.5 mpg left
Delete an existing master page in a document or chapter.
deletemasterpage [MASTERPAGE name]
MASTERPAGE/s The master page name. Default=current.
Examples:
deletemasterpage 'Two Column Master Page'
Deletes the selected object(s).
deleteobject [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 delete.
Examples:
deleteobject document 'project.doc'
Deletes page(s) in a document.
deletepage [PAGE number] [TO number] [mode]
PAGE/s The number of the first page to delete.
Default=current.
TO/s The number of the last page to delete.
mode/k The user prompt mode.
Options: FORCE | ALERT | QUIET (default). Force deletes without asking for confirmation, alert opens an alert box for confirmation, and quiet deletes without confirmation but returns an error if page(s) are deleted.
Examples:
deletepage page 5 to 7 force deletepage page 'Project.doc~5' to 7
Deletes the selected path point(s).
deletepoint [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:
deletepoint deletepoint 'project.doc~8'
Deletes a style tag.
deletestyle [REPLACEWITH name] <STYLETAG name>
REPLACEWITH/s The style to replace the deleted style with.
STYLETAG/s The name of the style to delete.
Examples:
deletestyletag styletag 'Body Text' deletestyletag replacewith 'SubHeadline' ยจ styletag 'Headline'
Deletes the selected text.
deletetext [DOCUMENT name | WINDOW name]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
deletetext document 'Project.Doc~9'
Deletes a user variable.
deletevariable <STYLEVAR name>
STYLEVAR/s The document/chapter/variable name.
Default=current.
Examples:
deletevariable stylevar MyBook.doc~author
Changes the page and scale displayed in an open window.
display [PAGE <number | shortcut> | MPG name] [SCALE <custom | preset>] [OFFSET offsetx offsety] [WINDOW name]
number/s The page number to display.
shortcut/k The page to display.
Options: LASTUSED Displays the last page viewed.
PREVIOUS Displays the previous page (or spread).
NEXT Displays the next page (or spread).
UP Displays the next page.
DOWN Displays the previous page.
START Displays the first page.
END Displays the last page.
MPG/s The master page name 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 | ZOOMIN | ZOOMOUT.
OFFSET/d The page offset from the top left of the window. Default=current.
WINDOW/s The window name. Default=current.
Examples:
display page 7 scale fullpage display page 'MyDoc~7' scale 85 offset 5.5 '-3' display page previous
Changes the grid display status.
displaygrid <status> [stack] [COLOR red green blue] [WINDOW name]
status/k The grid's display status.
Options: SHOW|HIDE|TOGGLE.
stack/k Specifies whether the grid is drawn on top or below objects.Options: INFRONT|INBACK
(default).
COLOR/i The red, green and blue components of the
grid color. Range: 0-255.
WINDOW/s The window name. Default=current.
Examples:
displaygrid show infront displaygrid color 0 255 255
Changes the guide display status.
displayguides <status> [stack] [RULER status] [RULERCOLOR red green blue]
[PAGE status] [PAGECOLOR red green blue] [WINDOW name]
status/k The guides' display status. Options:
SHOW|HIDE|TOGGLE.
stack/k Specifies whether the guides is drawn on
top or below objects.
Options: INFRONT | INBACK (default).
RULER/k The ruler guides' display status.Options: ON|OFF|TOGGLE.
RULERCOLOR/i The red, green and blue components of
the ruler guide color. Range: 0-255.
PAGE/k The page guides' display status.Options: ON|OFF|TOGGLE.
PAGECOLOR/i The red, green and blue components of the page guide color. Range: 0-255.
WINDOW/s The window name. Default=current.
Examples:
displayguides show infront ruler on page toggle displayguides page on pagecolor 255 100 0
Changes the ruler display status.
displayruler <status> [OFFSET offsetx offsety] [ZERO zerox zeroy] [MSYS horzunits vertunits] [DIRECTION horz vert] [WINDOW name]
status/k The rulers' display status. Options:
SHOW|HIDE|TOGGLE.
OFFSET/d The ruler offset in pixels from the top left corner of the window.
ZERO/d The ruler zero point.
MSYS/k The measurement system units for the
rulers.
Options: INCHES | CENTIMETERS | MILLIMETERS | PICAS | POINTS | PRINTERPICAS | PRINTERPOINTS | CICEROS | DIDOTPOINTS | FEET | METERS | SAMEAS. Sameas sets the rulers to the horizontal and vertical measurement system, as applicable.
DIRECTION/k The direction in which the rulers are measured.
Options: LEFT|RIGHT, UP|DOWN.WINDOW/s The window name. Default=current.
Examples:
displayruler show offset 30 120 msys inches inches displayruler direction left up displayruler zero 1.5 4.25
Dissolves a selected compound object.
dissolvecompound [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:
dissolvecompound document 'project.doc'
Dissolves a selected drawing.
dissolvedrawing [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:
dissolvedrawing document 'project.doc'
Separates an EPS object and its bitmap preview into two separate objects. The bitmap preview will become a separate picture object and the EPS object will no longer have a preview. This command is only applicable to EPS objects with bitmap previews.
dissolveeps [DOCUMENT name | WINDOW name | OBJECTID number]
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object. Default=current.
Examples:
dissolve object dissolve object document 'project.doc'
Dissolves a selected compound object into its subobjects, or a path into its subpaths.
dissolveobject [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:
dissolveobject document 'project.doc'
Distribute objects over an area.
distribute [HORIZONTAL place [BOUNDINGBOX | SPACING space]] [VERTICAL place [BOUNDINGBOX | SPACING space]] [DOCUMENT name | WINDOW name | OBJECTID number]
HORIZONTAL/k The horizontal placement. Options:
LEFT|CENTER|RIGHT|GAP.
VERTICAL/k The vertical placement. Options:
TOP|MIDDLE|BOTTOM|GAP.
BOUNDING BOX Distributes objects in their bounding box. Default.
SPACE/d Distributes objects with a set spacing.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Examples:
distribute horizontal left boundingbox
Displays an allocated dialog box.
doarexxrequester <handle>
handle/i The dialog box to display.
Results:
The handle of the exit control selected will be returned to RESULT.
Notes:
This command displays a dialog box, but the dialog box and its controls must be allocated first.
Warnings:
You must always unallocate your dialog box before exiting the script!
Examples:
doarexxrequester TestDialogBox action=RESULT
Displays the document palette.
documentpalette [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:
documentpalette toggle documentpalette show at 100 200 size 400 200 save documentpalette hide
Draws a new box.
drawbox <left top right bottom> [type] [CORNER radius | ECORNER radiusx radiusy]
[ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [PAGE number | MPG name | DOCUMENT name | WINDOW name]
left.../d The coordinates of the box.
type/k The corner type. Options: NORMAL|ROUND|
SCALLOP|BEVEL|INSET.
CORNER/d The corner radius. Default=0.
ECORNER/d The elliptical corner radius. Default=0.
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.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
Default=current.
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:
drawbox 1.75 1.5 2.75 2.5 drawbox 3 3 6 6 inback page 'project.doc~8' drawbox 6 7 8 9 ecorner 0.1 0.2 skew 0 45
Draws a new text column frame with one or more columns in it.
drawcolumn <left top right bottom> [COLUMNS number] [GUTTER space] [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [PAGE number | MPG name/S | DOCUMENT name | WINDOW name]
left.../d The coordinates of the frame.
COLUMNS/i The number of columns in a text frame.
GUTTER/d The space between columns.
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.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
Default=current.
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.
Notes:
Usme 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:
drawcolumn 1 1 7.5 10 columns 2 gutter 0.25 drawcolumn 1 1 5 6 rotate 45 inback page 'MyDoc~8'
Draws a new ellipse.
drawellipse <centerx centery radiusx radiusy> [type] [ANGLES startangle endangle] [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [PAGE number | MPG name/S | DOCUMENT name | WINDOW name]
center.../d The coordinates of the center point.
radius.../d The radius of the ellipse.
type/k The ellipse type. Options: PIE|ARC|
ELLIPSE (default).
ANGLES/d The starting and ending angles.
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.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
Default=current.
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:
drawellipse 3 3 1.5 1.5 drawellipse 3 3 1.5 1.5 page 'MyDoc~6' constrain drawellipse 5.25 6.125 1.5 2.5 pie angles 45 90 print
Places an Encapsulated PostScript illustration frame.
draweps <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] [stored] [FILE filepath] [PAGE number | MPG name | DOCUMENT name | WINDOW name]
left.../d The coordinates of the frame.
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. stored/k Specifies if the object is internal.
Options: INTERNAL (default)|EXTERNAL.
FILE/s The filepath and name of the object.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
Default=current.
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:
draweps 1.75 1.5 2.75 2.5 draweps 3 3 6 6 offset -2 2 contentscale 80 constrain draweps 2 2.5 3.125 5.625 page 'project.doc~6'
Draws a new grid object.
drawgrid <pointx1 pointy1 pointx2 pointy2 | POINTS pointx1 pointy1 pointx2 pointy2 pointx3 pointy3 pointx4 pointy4> [DIVISIONS horz vert] [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [PAGE number | MPG name/S | DOCUMENT name | WINDOW name]
pointx1.../d The coordinates of a rectangular grid.
POINTS/d The coordinates of the vertices of a
non-rectangular grid. (Numbered counterclockwise)
DIVISIONS/i The number of grid cells in each
direction. Default=4x4.
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.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
Default=current.
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:
drawgrid 2 2 6 6 divisions 5 10 drawgrid 2 2 6 6 divisions 5 10 constrain noprint drawgrid points 1 1 1 3 5 6 2 3 page 'MyDoc~6'
Draws a new line.
drawline <left top right bottom> [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [PAGE number | MPG name/S | DOCUMENT name | WINDOW name]
left.../d The coordinates of the line.
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.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
Default=current.
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:
drawline 1 1 5 5 drawline 2 1.25 8.5 11 page 'project.doc~6' noprint
Places a picture frame.
drawpicture <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] [DPI xdpi ydpi] [frame] [stored] [FILE filepath] [PAGE number | MPG name/S | DOCUMENT name | WINDOW name]
left.../d The coordinates of the frame.
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. stored/k Specifies if the object is internal.
Options: EXTERNAL|INTERNAL (default).
FILE/s The filepath and name of the image.
DPI/i The resolution of the picture.
Default=actual.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
Default=current.
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:
drawpicture 0.5 0.5 2.5 3 dpi 150 150 external
Draws a new regular polygon.
drawpolygon <centerx centery radiusx radiusy> [type] [SIDES number] [OFFSETANGLE angle] [DEFLECTION amount] [ANGLEDEFLECTION amount] [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [PAGE number | MPG name/S | DOCUMENT name | WINDOW name]
center.../d The coordinates of the center point.
radius.../d The radius of the polygon.
type/k The polygon type. Options: NORMAL
(default)|STAR|PUFFY|SCALLOP|WAVY.
SIDES/i The number of sides. Default=5.
Must be >2.
OFFSETANGLE/d The pre-rotation angle. Default=0.
DEFLECTION/d The spike depth. Default=40%.
ANGLEDEFLECTION/d The spike angle. Default=0%.
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.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
Default=current.
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:
drawpolygon 0.3 1.8 1.25 1.5 sides 8 puffy
Starts a new text block.
drawtextobj <left top> [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [PAGE number | MPG name/S | DOCUMENT name | WINDOW name]
left.../d The top left corner of the text block.
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.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
Default=current.
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:
drawtextobj 1 1 drawtextobj 1 1 rotate 45 inback page 'project.doc~8'
Duplicates the selected object(s) once with a small offset.
duplicate [OFFSET offsetx offsety] [DOCUMENT name | WINDOW name | OBJECTID number]
OFFSET/d Overrides the default duplicate offsets.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Examples:
duplicate offset 1.125 -2.5 duplicate document 'project.doc'