savedocument
savefontprefs
saveprintprefs
savesettings
savesnapshot
savestyletags
scaleobject
screentoback
screentofront
scriptpalette
selectmasterpage
selectobject
selectonpaste
selectpoint
selecttext
sendbackward
sendtoback
setalignment
setarcdefaults
setarexxgadget
setarticle
setarticledesc
setarticlename
setautocolumns
setbackup
setbaseline
setbaselineleading
setbitmapeditor
setbold
setboxdefaults
setbullet
setbusyrequester
setcase
setchapterdesc
setchaptername
setchapternumbering
setcharacterstyle
setcolor
setcolorcount
setcolorstyle
setcolortint
setcolumnguides
setcolumndefaults
setdefaulttabstop
setdimensions
setdocumentdesc
setdocumentname
setdocumentpath
setdocumentstatus
setdoubleclick
setdrawing
setdrawingeditor
setdropcap
setduplicatedefaults
seteps
setfill
setfirstline
setfont
setfpattern
setfpatternstyle
setgraphicpath
setgrid
setgriddefaults
setguide
setguides
sethyphenation
sethyphenlanguage
setindent
setitalic
setjobnumbering
setjustification
setkerning
setlanguage
setlastlineflush
setleading
setligature
setmagnifyincrement
setmarginguides
setmasterpagedesc
setmasterpagename
setmeasurements
setminlinelength
setmovedefaults
setnormal
setobjectlock
setobjectstyle
setoutline
setnudgedefaults
setpagedesc
setpagename
setpagenumbering
setpairkern
setparagraphleading
setparagraphstyle
setpicture
setpolygondefaults
setreverse
setrevisiontracking
setscreen
setscript
setscriptpath
setshadow
setsmallcaps
setsmart
setstroke
setstrokebegin
setstrokecap
setstrokecount
setstrokeend
setstrokejoin
setstrokeoffset
setstrokestyle
setstrokeweight
setstyletag
setstyletagname
setsubscript
setsuperscript
settabruler
settexteditor
settextframe
settextpath
settextrouting
settextwrap
settoolmode
settoolbar
settracking
settrackrange
settracktable
settypeangle
settypesize
settypewidth
setunderline
setundolevels
setvariablename
setvariablevalue
setviewdefaults
setwindowdefaults
setwindowname
setwindowpos
simplifypath
skew
smoothpath
snaptogrid
snaptoguides
splitpaths
splitpoint
stroked
stylepalette
This saves an open document.
savedocument <DEFAULT | FILE filepath> [FILTER name] [TEMPLATE] [progress] [mode] [DOCUMENT name]
DEFAULT Saves using the existing filename and path.
FILE/s The filename and path to which to save.
FILTER/s The filter to use.
Options: IFFDOC
(default).
TEMPLATE/k Saves the document as a template.
progress/k Toggle to display a progress meter.
Options: STATUS | NOSTATUS (default).
mode/k The user prompt mode.
Options: FORCE | ALERT | QUIET (default).
Force overwrites without asking for confirmation, alert opens an alert box for confirmation, and quiet overwrites without confirmation but returns an error if a file is overwritten.
DOCUMENT The document name. (Default=current)
Notes:
If DEFAULT is used and the file has not been previously saved, the file dialog box will open.
Examples:
savedocument file 'Documents:Project' status savedocument default nostatus force
This saves the current font paths added in the Font Preferences dialog box.
savefontprefs <FILE filepath | DEFAULT>
FILE/s The filename and path of the fontprefs file to save.
DEFAULT Saves to PageStream3.fontprefs.
Examples:
savefontprefs file 'NewsletterFonts.fontprefs' savefontprefs default
This saves the current print settings in the Printing Preferences dialog box.
saveprintprefs <FILE filepath | DEFAULT>
FILE/s The filename and path of the preferences file to which to save.
DEFAULT Saves to the PageStream3 Preferences file.
Notes:
You can save printing preferences to a preferences file containing other preference items.
Examples:
saveprintprefs default saveprintprefs file 'PageStream3:ServiceBureau.prefs'
This saves all of the program preferences.
savesettings <FILE filepath | DEFAULT>
FILE/s The filename and path of the preferences file to save.
DEFAULT Saves to the PageStream3 Preferences file.
Examples:
savesettings default savesettings file 'PageStream3:Letters.prefs'
This saves the position and size of the current window and all palettes.
savesnapshot <FILE filepath | DEFAULT>
FILE/s The filename and path of the preferences file to which to save.
DEFAULT Saves to the PageStream3 Preferences file.
Examples:
savesnapshot default savesnapshot file 'PageStream3:tiled.prefs'
This saves the current style tags in an IFF CTAG file.
savestyletags <FILE filepath | ASK> [type] [progress] [DOCUMENT name | WINDOW name | CHAPTER name]
FILE/s The filename and path of the style tag file to save.
ASK Opens a file selector to select the file.
type/k The type of style tags to save.
Options: ALL (default) | CHARACTER | PARAGRAPH | OBJECT | COLOR.
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.
CHAPTER/s The document/chapter name.
Default=current.
Notes:
Colors are stored as color style tags, so colors are also saved in IFF CTAG files.
Examples:
savestyletags file 'Work:Documents/MyColors' color savestyletags ask status
Scales objects by a percentage or relative amount.
scaleobject <[SCALE scalex scaley] | [OLDPOINT oldx oldy NEWPOINT newx newy]> [ROTATE angle | SKEW slantangle twistangle] [ABOUT <pointx | axisx> <pointy | axisy> | ABOUTCENTER] [DOCUMENT name | WINDOW name | OBJECTID number]
SCALE/d The percentage scale.
OLDPOINT/d The relative scale start point.
NEWPOINT/d The relative scale end point.
ROTATE/d The rotation angle. Default=0.
SKEW/d The slant and twist angle.
SLANT/d The slant angle.
TWIST/d The twist angle.
ABOUT The scale reference point.
pointx/d The horizontal scale point.
axisx/k The horizontal scale axis.
Options: LEFT | CENTER | RIGHT.
pointy/d The vertical scale point.
axisy/k The vertical scale axis.
Options: TOP | MIDDLE | BOTTOM.
ABOUTCENTER Scales about its center. Default.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Default=current.
Notes:
When OLDPOINT and NEWPOINT are used to scale an object, the amount the object is scaled is determined by taking the differences between the horizontal and vertical positions of these points and relating them to the size of the object.
Examples:
scaleobject scale 80 100 scaleobject oldpoint 1.25 newpoint 4.15 scaleobject scale 50 50 about left top
Sends the screen on which PageStream is open to the back of all screens.
screentoback @{FG Fill}(no parameters)@{FG Text}
Examples:
screentoback
Brings the screen on which PageStream is open to the front of all screens.
screentofront @{FG Fill}(no parameters)@{FG Text}
Examples:
screentofront
Displays the Script palette.
scriptpalette [status] [AT pointx pointy] [SIZE width height] [COLLAPSED state] [SAVE]
status/k The palette's display status.
Options: SHOW | HIDE |T OGGLE.
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:
scriptpalette toggle scriptpalette show at 500 300 size 180 172 save scriptpalette hide
Select the master page for a page and set how to show its objects.
selectmasterpage <NAME name> [PAGE number] [stack] [status] [RIPPLE | TO number]
NAME/s The master page name to use for the page.
PAGE/s The number of the page to set.
Default=current.
stack/k The stack position.
Options: INFRONT | INBACK.
status/k The master page's objects' display status.
Options: SHOW | HIDE. Default=current.
RIPPLE Sets the master page for all following pages until the next page which has been specifically set.
TO/s Sets the master page for pages from PAGE to this page number.
Examples:
selectmasterpage name 'Default MPage' page 5 inback selectmasterpage name '2 Column Layout' ripple selectmasterpage 'Newsletter pages' page 3 to 9
Selects object(s).
selectobject <NONE | ALL | <OBJECTID [number] [how]>| <RANGE left top right bottom [stack] [how]> | <AT pointx pointy>[stack] [how]>> [PAGE number | MPG name | WINDOW name]
NONE Deselects all objects.
ALL Selects all the objects on the page.
OBJECTID/i Selects an object by its ID.
RANGE/d Selects objects inside these coordinates.
AT/d Selects the objects at this point.
how/K Specifies how to add new objects to an
existing selection.
Options: REPLACE Replaces selected objects with these objects.
ADD Adds to the selected object list.
REMOVE Removes these objects from the selected object list.
TOGGLE Adds these objects to the selected object list if they are not already selected; removes them if they are selected.
AND Selects only the objects common to the new selected objects and to the previous selection list.
stack/k Specifies which objects to select.
Options: FRONTMOST Selects the frontmost object at the point. Default for AT.
BACKMOST Selects the backmost object at the point.
EVERY Selects all the objects in the stack at the point. Default for RANGE.
PAGE/s The page number.
MPG/s The master page name and side.
WINDOW/s The window name. Default=current.
Notes:
You cannot select objects on more than one page simultaneously. If an object is selected, selecting an object on another page will deselect the first object.
Examples:
selectobject at 4.24 5.382 backmost selectobject range 1 1 5 5 remove selectobject all
Automatically selects text when imported or pasted. This is useful if you want to apply text immediately after importing it or pasting it.
selectonpaste [status] [SAVE]
status/k Select on paste status.
Options: ON | OFF | TOGGLE.
SAVE Saves to the PageStream3 Preferences file.
Examples:
selectonpaste on save selectonpaste toggle
Selects a path point.
selectpoint [neighbor] [POINTINDEX point] [DOCUMENT name | WINDOW name | OBJECTID number]
neighbor/k Selects a neighboring point.
Options: NEXT | PREVIOUS.
POINTINDEX/i The number of the point to select.
Default=selected point(s).
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Default=current.
Notes:
Pointindex identification numbers are numbered from 0 starting with the first moveto in a path.
Examples:
selectpoint previous selectpoint pointindex 23
Selects a block of text.
selecttext <what | AT pointx pointy [how] [stack] | RANGE left top right bottom [how] [stack]> [PAGE number | MPG name | DOCUMENT name | WINDOW name]
what/k Specifies what text to select.
Options: ALL Selects all the text in the article.
PARAGRAPH Selects the current paragraph(s).
WORD Selects the current word(s).
FRAME Selects the current frame(s).
LINE Selects the current line(s).
NONE Deselects selected text.
AT/d Places the insertion point and selects the article at this position.
RANGE/d Selects all the text in this area.
how/K Specifies how to add new text to an existing selection.
Options: REPLACE Replaces selected text with this text. Default.
ADD Adds to the selected text.
stack/k Specifies which articles to select in.
Options: FRONTMOST Selects in the frontmost article at the point. Default.
BACKMOST Selects in the backmost article at the point.
PAGE/s The page number. Default=current insertion point.
MPG/s The master page name and side.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
selecttext all selecttext range 1.25 3.3 1.75 5.25 add
Sends selected object(s) backward one level in the stack.
sendbackward [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.
Default=current.
Examples:
sendbackward sendbackward document 'project.doc'
Sends selected object(s) backward to the bottom of the stack.
sendtoback [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.
Default=current.
Examples:
sendtoback sendtoback document 'project.doc'
Sets the paragraph alignment for the paragraph at the insertion point, for selected paragraphs or for a style tag.
setalignment <alignment> [DOCUMENT name | WINDOW name | STYLETAG name]
alignment/k Sets the alignment type.
Options: JUSTIFY Sets justified alignment.
LEFT Sets flush left alignment.
CENTER Sets centered alignment.
RIGHT Sets flush right alignment.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setalignment left styletag 'Body Text' setalignment justify document 'project.doc'
Sets the default type of arcs drawn.
setarcdefaults [type] [ANGLES start end] [SAVE]
type/k Sets the ellipse type.
Options: PIE A closed arc of an ellipse.
ARC An open arc of an ellipse
ANGLES/d The starting and ending angles.
Default=90,360.
SAVE Saves the values to the PageStream3 Preferences file.
Examples:
setarcdefaults pie angles 90 155.3 save
Resets a control's parameters. The dialog box and control must first be added.
setarexxgadget <dbox chandle> [LEFT left] [TOP top] [WIDTH width] [HEIGHT height] [LABEL name] [LABELPOS pos] [STRING text] [BORDER style] [CHECKED status] [LIST handle] [CURRENT value] [TOTAL value]
dbox/i The dialog box handle.
dhandle/i The control handle.
LEFT/i The left edge of the control.
TOP/i The top edge of the control.
WIDTH/i The width of the control.
HEIGHT/i The height of multiline and scrollist
controls. Minimum=36
LABEL/s The control's label.
LABELPOS/s The label position relative to the
control.
Options: LEFT | RIGHT | ABOVE| ABOVELEFT | ABOVERIGHT | BELOW | BELOWLEFT | BELOWRIGHT | CENTER | CENTERLEFT | CENTERRIGHT | LEFTABOVE | LEFTBELOW | RIGHTABOVE | RIGHTBELOW.
Default=left except for checkbox=right.
STRING/s The default text of a string, multiline or text control.
BORDER/k The border type of a text control.
Options: NONE | RAISED | RECESSED | SHINE | SHADOW | TEXT.
CHECKED/k The default state of a checkbox.
Options: TRUE | FALSE.
LIST/i The list handle for a popup, cycle or scrollist control.
CURRENT/i The default list item for a popup, cycle or scrollist, or the default slider position (decimal).
TOTAL/d The range of a slider.
Notes:
The width and position of controls does not include the label. Position is not applicable to exit buttons because the label is centered on the button.
String controls are editable text fields; multilines allow multiple lines of text. Text controls are non- editable text displays.
Precede the character to underscore as a keyboard shortcut in the label name. For example, "_Add" would make "A" the keyboard shortcut for an "Add" control.
Examples:
setarexxgadget reqhandle check1 checked true setarexxgadget req iList1 list fonts current 'Times' setarexxgadget iDBox nametext 'Simple' setarexxgadget req cyanslider current 15 total 100
Sets an article to be internal or external. Internal articles are saved in the document file. External articles store only the article filename and path in the document file.
setarticle [stored] [FILE filepath] [ARTICLE name | DOCUMENT name | WINDOW name | ARTICLEID number]
stored/k Specifies if the article is internal.
Options: INTERNAL | EXTERNAL.
FILE/s The filepath and name of the article.
ARTICLE/s The name of the article to set.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
ARTICLEID/i The number of the article.
Default=current.
Examples:
setarticle internal setarticle external article 'Story1' setarticle external file 'Essay.2' setarticle external path 'Text:Essay.2'
Sets the description of an article.
setarticledesc <description> [ARTICLE name | DOCUMENT name | WINDOW name | ARTICLEID number]
description/s The article description.
ARTICLE/s The name of the article to set.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
ARTICLEID/i The number of the article.
Default=current.
Examples:
setarticledesc 'Lead story on Olympics' setarticledesc '1996 Olympics' article 'Story1'
Sets the name of an article.
setarticledesc <name> [ARTICLE name | DOCUMENT name | WINDOW name | ARTICLEID number]
name/s The new name of the article.
ARTICLE/s The name of the article to set.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
ARTICLEID/i The number of the article.
Default=current.
Examples:
setarticlename 'LeadStory' setarticlename 'LeadStory' article 'Story1'
Set the automatic column frame creation feature for importing text.
setmeasurements [status] [SAVE]
status/k Automatic text frames status.
Options: ON | OFF | TOGGLE.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setautocolumns on save setautocolumns toggle
Changes the autobackup and autosave status.
setbackup [AUTOBACKUP status [COUNT number]] [AUTOSAVE status [INTERVAL time]] [PATH filepath] [SAVE]
status/k Sets the feature status.
Options: ON |OFF| T OGGLE.
AUTOBACKUP/k Sets the autobackup status.
COUNT/i Sets the number of backup copies.
AUTOSAVE/k Sets the autosave status.
INTERVAL/i Sets the autosave interval in minutes.
PATH/s Sets the autosave and autobackup path.
SAVE Saves to the PageStream3 Preferences file.
Notes:
The TOGGLE parameter may not be used in conjunction with the SAVE parameter.
Examples:
setbackup autobackup toggle count 3 path 'work:back' setbackup autosave off setbackup autobackup on autosave on interval 5 save
Sets the baseline offset at the insertion point, for selected text or for a style tag. This command has no menu equivalent since super and subscripts can be created with Type Style commands.
setbaseline <offset> [DOCUMENT name | WINDOW name | STYLETAG name]
offset/d The baseline offset.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setbaseline 6 setbaseline '0p2' setbaseline '0.5"' document 'project.doc' setbaseline 8 styletag 'Superior Text'
Sets the leading method at the insertion point, for selected text or for a style tag.
setbaselineleading <method amount> [DOCUMENT name | WINDOW name | STYLETAG name]
method/k The leading method.
Options: RELATIVE Sets the baseline to a relative value from the top of the slug.
TRELATIVE Sets to relative top of caps leading. The baseline is a relative value measured from the hightest point of any character in the font.
TFIXED Sets to top of caps leading. The baseline is a fixed value measured from the highest point of any character in the font. font. No interface equivalent.
FIXED Sets the baseline to a fixed value offset from the top of the slug. No interface equivalent.
amount/d The baseline or top of caps offset.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setbaselineleading relative 66 setbaselineleading fixed 8 styletag 'Body Text'
Set the default picture editor script for the Sned to Editor command.
setbitmapeditor <script> [SAVE]
script/s The filename and path of the script to use.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setbitmapeditor 'Scripts/SendtoBME.rexx'
Sets the bold style option at the insertion point, for selected text or for a style tag.
setbold <toggle> [DOCUMENT name | WINDOW name | STYLETAG name]
toggle/k Toggles on or off the style.
Options: on | off.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setnormal on setnormal off document 'project.doc'
Sets the default radii for round cornered boxes.
setboxdefaults [type] [CORNER radius | ECORNER radiusx radiusy] [SAVE]
type/k Sets the corner type.
Options: NORMAL Square corners. Corner radii=0.
ROUND Outward rounded corners.
SCALLOP Inward rounded corners.
BEVEL Angled corners.
INSET Square insert corners.
CORNER/d The corner radius.
ECORNER/d The elliptical corner radius.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setboxdefaults round corner 0.25 save
Sets the bullet paragraph type for the paragraph at the insertion point, for selected paragraphs or for a style tag.
setbullet <OFF | ON <character/S [FONT name] [STYLE name]>>[DOCUMENT name | WINDOW name | STYLETAG name]
OFF Toggles automatic bullets off.
ON Toggles automatic bullets on
FONT/s The name of the font. Default=current.
STYLE/s The style of the font. Default=current.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
To set the paragraph type to Normal, set the bullet and drop cap options to off.
You can enter a unicode value if the character for the bullet is not part of the standard character set. Type a backslash followed by the unicode value for a unicode character.
Examples:
setbullet on \8226 setbullet on '' font 'AGaramond-Semibold' setbullet off styletag 'Body Text'
Sets the thermometer and message for an open busy dialog box.
setbusyrequester <handle> [MESSAGE text] [THERMOMETER status] [ABORT status] [TOTAL value] [CURRENT value]
handle/i The handle of the dialog box to set.
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.
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
Sets the case of text at the insertion point or for selected text. Unlike the MAKERUPPERCASE and related commands, this command does not change the case of the letters, but merely displays and prints them as the set case because the original case is retained. If the OFF parameter is later used, the original case will be re-applied. This command has no interface equivalent.
setcase <case>
case/k Sets the case.
Options: OFF Does not force set the case.
UPPER Sets the text to uppercase.
LOWER Sets the text to lowercase.
CAPITALIZED Sets the text to capitalized.
Examples:
setcase capitalized
Sets the description of an open chapter.
setchapterdesc <text> [CHAPTER name | WINDOW name]
text/s The chapter description.
CHAPTER/s The document/chapter name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
setchapterdescription 'For discussion of particles.'
Sets the name of an open chapter.
setchaptername <name> [CHAPTER name | WINDOW name]
name/s The new name of the chapter.
CHAPTER/s The document/chapter name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
setchaptername 'Part IV' window 'Book.doc~View.1'
Sets the chapter numbering system for chapters in a chapter or document. All chapters inside the specified (or current) chapter or document will be affected.
setchapternumbering [START <AUTOMATIC | CUSTOM number>] [MASTERPAGE name] [FORMAT type] [LANGUAGE name] [PREFIX string] [DOCUMENT name | CHAPTER name | WINDOW name]
START/k The numbering method.
Options: AUTOMATIC Automatic numbering.
CUSTOM/i Manual numbering and the start number.
MASTERPAGE The master page to use for blank pages.
FORMAT/k
The number format: DEFAULT |LONG | ARABIC | ROMANUPPER | ROMANLOWER | ALPHAUPPER | ALPHALOWER.
LANGUAGE/s The number language:
DEFAULT Document/chapter default.
AMERICAN American English.
ENGLISH International English.
FRANCAIS French.
DEUTSCH German.
PREFIX/s The prefix string.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
CHAPTER/s The document/chapter name.
Default=current.
Notes:
The START parameter is required because you can actually set the ending chapter number. This feature is not supported at this time, but the START parameter is required for future compatibility.
Examples:
setchapternumbering start manual 2
Sets the character style for the text at the insertion point or for selected text.
setcharacterstyle <style> [DOCUMENT name | WINDOW name | STYLETAG name]
style/s The character style to set.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
STYLETAG/s --unknown--
Examples:
setcharacterstyle 'Body Text'
Sets the color for an object or text, or for a style tag. If object or text is chosen and nothing is selected, it sets the color for future objects or text, as applicable.
setcolor [TINT value] [method] [type] <BLACK | WHITE | GRAY value | RGB red green blue | CMYK cyan magenta yellow black | PANTONE name | HLS hue lightness saturation | HSV hue saturation value> [ALL | FILL | STROKENUMBER number] [COLORNUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
TINT/d The tint percentage.
method/k The print method.
Options: KNOCKOUT Knocks out the background.
OVERPRINT Prints over the background.
type/k The color type.
Options: PROCESS A process (separable) color.
SPOT A spot (mechanical) color.
BLACK Sets the color to black.
WHITE Sets the color to white.
GRAY/d Sets the color to a grayscale.
RGB/d Defines a RGB color.
CMYK/d Defines a CMYK color.
PANTONE/s Selects a PANTONE color.
HLS/d Defines an HLS color.
HSV/d Defines an HSV color.
ALL Sets the fill and stroke. Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
COLORNUMBER Sets a gradient's TO color. what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate. Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
COLORNUMBER: If Basic fills are used, or if you are setting stroke color, the color number is always 0 and does not need to be specified. This is used for gradient, radial and shape fills. Color number 0 is the From color and 1 is the To color.
TINT: This parameter is equivalent to the Tint control in the Edit Color dialog box, and not the Tint controls in the Line & Fill dialog box.
Examples:
setcolor black setcolor tint 50 PANTONE 'PANTONE 120 CV' ¨strokenumber 1 object setcolor cmyk 25 43 0 12 shadow
Sets the number of colors for the fill or stroke of an object or text, or for a style tag. If object or text is chosen and nothing is selected, it sets the number of colors for future objects or text, as applicable.
Basic fills have one color, while gradient, radial and shape fills have two colors. This command is necessary because future versions may support more than two colors.
setcolorcount <count> [ALL | FILL | STROKENUMBER number] [COLORNUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
count/i The number of colors. Default=1.
ALL Sets the fill and stroke. Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
COLORNUMBER Sets a gradient's TO color.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate. Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
Use the SETFILL command to set the fill type to gradient, radial or shape, then use this command to set the color count to 2. If you set the fill to basic, then set the color count to 1.
If Basic fills are used, or if you are setting stroke color, the color number is always 0 and does not need to be specified. This is used for gradient, radial and shape fills. Color number 0 is the From color and 1 is the To color.
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
setcolorcount 2 setcolorcount 1 strokenumber 1 object
Sets the color style tag for the selected object(s) or text, as specified. If no objects or text is selected, it sets the color style for future objects or text.
setcolorstyle <color> [ALL | FILL | STROKENUMBER number] [COLORNUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
color/s The color style to set.
ALL Sets the fill and stroke. Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
COLORNUMBER Sets a gradient's TO color.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to
manipulate. Default=current.
STYLETAG/s --unknown--
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
COLORNUMBER: If Basic fills are used, or if you are setting stroke color, the color number is always 0 and does not need to be specified. This is used for gradient, radial and shape fills. Color number 0 is the From color and 1 is the To color. This format is used to allow future expansion. Default=0.
Examples:
setcolorstyle 'NeonPink' setcolorstyle 'Orange' all text setcolorstyle 'Red' strokenumber 2 setcolorstyle 'Blue' colornumber 1 object
Sets the color tint for an object or text, or for a style tag. If object or text is chosen and nothing is selected, it sets the color for future objects or text, as applicable.
setcolortint <value> [ALL | FILL | STROKENUMBER number] [COLORNUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
value/d The tint percentage.
ALL Sets the fill and stroke. Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
COLORNUMBER Sets a gradient's TO color.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to
manipulate. Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
COLORNUMBER: If Basic fills are used, or if you are setting stroke color, the color number is always 0 and does not need to be specified. This is used for gradient, radial and shape fills. Color number 0 is the From color and 1 is the To color.
This command is equivalent to the Tint controls in the Line & Fill dialog box.
Examples:
setcolortint 50
Sets the default type of columns drawn.
setcolumndefaults [COLUMNS number] [GUTTER space] [fill] [SAVE]
COLUMNS/i The number of columns in the frame.
GUTTER/d The space between columns.
fill/k Sets the column fill type.
Options: OPAQUE Sets the fill to solid white. TRANSPARENT Sets the fill to none.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setcolumndefaults columns 3 gutter 0.25 transparent ¨save
Change the column guides of a master page in a document or chapter.
setcolumnguides <columns gutter> [SAVE] [MASTERPAGE name]
columns/i The number of columns in the layout.
gutter/d The space between columns.
SAVE Saves to the PageStream3 Preferences file.
MASTERPAGE/s The master page name. Default=current.
Examples:
setcolumnguides 3 0.25 masterpage '3 Column Layout'
Sets the default tab spacing at the insertion point, for selected paragraphs or for a style tag.
setdefaulttabstop <amount> [DOCUMENT name | WINDOW name | STYLETAG name]
amount/d The tab spacing.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setdefaulttabstop 0.333in setdefaulttabstop 10mm styletag 'Body Text'
Change the dimensions of a master page in a document or chapter.
setdimensions <width height> [orientation] [sides] [spread] [SAVE] [MASTERPAGE name]
width The master page width.
height The master page height.
orientation/k The orientation: PORTRAIT | LANDSCAPE.
sides/k The number of sides: SINGLE | DOUBLE.
spread/k The facing pages setting: FACING | INDIVIDUAL.
SAVE Saves to the PageStream3 Preferences file.
MASTERPAGE/s The master page name. Default=current.
Examples:
setdimensions 8.5 14 portrait double setdimensions 17 11 masterpage 'Ledger Sheet'
Sets the description of an open document.
setdocumentdesc <text> [DOCUMENT name]
text/s The document description.
DOCUMENT/s The document name. Default=current.
Examples:
setdocumentdescription 'Lesson 3 exam'
Changes the name of an open document.
setdocumentname <name> [DOCUMENT name]
name/s The new name of the document.
DOCUMENT/s The document name. Default=current.
Examples:
setdocumentname 'Project.doc' document 'Untitled 1'
Sets the default file path for opening and saving documents.
setdocumentpath <filepath> [SAVE]
filepath/s The path for the files.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setdocumentpath 'PageStream3:Documents'
Changes the saved status of an open document.
setdocumentstatus <status> <DOCUMENT name>
status/k Sets the document status.
Options: CHANGED Marks the document as changed.
UNCHANGED Marks the document as unchanged.
DOCUMENT/s The document name. Default=current.
Examples:
setdocumentstatus changed document 'Project.doc'
Set the action to be performed when an object is double clicked.
setdoubleclick [OFF | MACRO name | REQUESTER name] [SAVE]
OFF Sets to no action.
MACRO Sets to any internal PageStream script.
REQUESTER/k Sets to a command.
Options: LINEFILL | RUNAROUND | DUPLICATE | TRANSFORM | ROTATE | MOVE | ALIGN |LOCK | UNLOCK | BRINGTOFRONT | BRINGFORWARD | SENDTOBACK | SENDBACKWARD.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setdoubleclick rotate setdoubleclick macro 'ToggleFill' save
Sets the name and description of a drawing object.
setdrawing [NAME name] [DESC description] [DOCUMENT name | WINDOW name | OBJECTID number]
NAME/s The new name of the object.
DESC/s The new description of the object.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Default=current.
Examples:
setdrawing name 'CorporateLogo'
Set the default drawing editor script for the Send to Editor command.
setdrawingeditor <script> [SAVE]
script/s The filename and path of the script to use.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setdrawingeditor 'Scripts/SendtoArtExp.rexx'
Sets the drop cap paragraph type options for the paragraph at the insertion point, for selected paragraphs or for a style tag.
setdropcap <OFF | ON <characters/I lines/I [FONT name/S] [STYLE name/S]>> [DOCUMENT name/S | WINDOW name/S | STYLETAG name/S]
OFF toggles automatic dropcaps off.
ON toggles automatic dropcaps on and sets the number of characters and lines, and the font.
FONT is the full name of the font. (Default=current)
STYLE is the style of the font. (Default=current)
DOCUMENT is the document name. (Default=current)
WINDOW is the window name. (Default=current)
STYLETAG sets the automatic drop cap option for a style tag.
Notes:
To set the paragraph type to Normal, toggle the drop cap and bullet options off. Note that a paragraph can have both an automatic drop cap and bullet through macros, although this is not recommended.
Examples:
setdropcap on 2 5 setdropcap on 1 4 font 'AGaramond-Semibold' setdropcap off styletag 'Body Text'
Set the default duplicate offset.
setduplicatedefaults <offsetx offsety> [SAVE]
offsetx/d The horizontal offset.
offsety/d The vertical offset.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setduplicatedefaults 0.25 0.25 save
Sets the name and description of an EPS object.
seteps [NAME name] [DESC description] [DOCUMENT name | WINDOW name | OBJECTID number]
NAME/s The new name of the object.
DESC/s The new description of the object.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Default=current.
Examples:
seteps name 'CorporateLogo'
Sets the fill type for an object or text, or for a style tag. If object or text is chosen and nothing is selected, it sets the fill type for future objects or text, as applicable.
setfill <BASIC | [<GRADIENT angle | RADIAL offsetx offsety | SHAPE inset> RAMP taper]> [ALL | FILL | STROKENUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
BASIC Sets the type to basic.
GRADIENT/d Sets the type to gradient and specifies the taper angle.
RADIAL/d Sets the type to radial and specifies the offset.
SHAPE/d Sets the type to shape and specifies the inset.
RAMP/k Sets the taper for gradient, radial and shape fills.
Options: LINEAR | INVLINEAR | LOG | INVLOG | SIN | INVSIN | SAW | INVSAW.
ALL Sets the fill and stroke fill.
Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
The program interface limits gradient, radial and shape fill types to fills, but you can apply these to strokes via this script, even though this may not produce useful results.
Examples:
setfill basic setfill basic strokenumber 1 object setfill gradient 45
Sets the first line indent or outdent amount for the paragraph at the insertion point, for selected paragraphs or for a style tag. The first line's indent or outdent is relative to the left margin position which is set with SETINDENT and cannot outdent the first line to the left of the left margin.
setfirstline [NONE | INDENT margin | OUTDENT margin] [DOCUMENT name | WINDOW name | STYLETAG name]
NONE Aligns the first line with the margin.
INDENT/d Indents the first line.
OUTDENT/d Outdents the first line.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setfirstline none setfirstline indent 0.5 styletag 'Body Text' setfirstline outdent '1p6' document 'project.doc'
Sets the font at the insertion point, for selected text, or for a style tag.
setfont <font> [DOCUMENT name | WINDOW name | STYLETAG name]
font The full name of the font.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setfont 'AGaramond-Semibold' setfont 'Titan' styletag 'Headline'
Sets the fill pattern for an object or text, or for a style tag. If object or text is chosen and nothing is selected, it sets the fill pattern for future objects or text, as applicable.
setfpattern <NONE | PATTERN pattern> [ALL | FILL | STROKENUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
NONE Sets the pattern to none.
PATTERN The pattern. See notes.
ALL Sets the fill and stroke fill.
Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
PATTERN: Patterns are comprised of 8 rows of 8 dots which may be toggled on and off. Fill patterns are set using 16 hexadecimal numbers to save space; each number sets four dots.
Examples:
setstroke none setstroke pattern ff00ff00ff0ff00 fill
Sets the fill pattern style tag for the selected object(s). If no objects are selected, it sets the fill pattern style for future objects.
setfpatternstyle <patternname> [ALL | FILL | STROKENUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
patternname/s The fill pattern style to set.
ALL Sets the fill and stroke fill.
Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
setfpatternstyle '15' setfpatternstyle 'Bricks' fill object
Sets the default file path for placing and exporting graphics.
setgraphicpath <filepath> [SAVE]
filepath/s The path for the files.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setgraphicpath 'Brilliance:Pictures'
Sets the display and/or drawing grids for a master page.
setgrid [SNAP x y] [SNAPALL | SNAPRANGE x y] [SNAPOFFSET x y] [DISPLAYINTERVAL x y] [DISPLAYOFFSET x y] [SAVE] [MASTERPAGE name]
SNAP/d The grid spacing. Default=current.
SNAPALL Always snaps objects to the grid.
Default=current.
SNAPRANGE/d Snaps objects when within this range. Default=current.
SNAPOFFSET/d The offset of the grid from the origin. Default=current.
DISPLAYINTERVAL/i Sets the grid display to a multiple of the SNAP. Default=current.
DISPLAYOFFSET/d Sets the grid display offset from the grid.
SAVE Saves to the PageStream3 Preferences file.
MASTERPAGE/s The master page name.
Default=current.
Notes:
Grid spacing and strength are part of the master page description. The snap-to-grid toggle is part of the window settings.
Examples:
setgrid snap 0.25 0.25 snaprange 0.0625 0.0625
Sets the default divisions for grid objects.
setgriddefaults [DIVISIONS x y] [SAVE]
DIVISIONS/i The number of grid cells in each direction.
SAVE Saves to the PageStream3 Preferences file.
Notes:
This command affects grid objects, not the snap-to-grid.
Examples:
setgriddefaults divisions 3 9 save
Sets new guide(s) for a master page.
setguides [type] <AT position> [MPG name]
TYPE/k The guide axis.
Options: HORIZONTAL | VERTICAL.
AT The position(s) of the new guide(s).
MPG/s The master page name and side.
Examples:
setguides vertical at 2.5 mpg left
Sets how guides will snap for a master page.
setguide [SNAPALL | SNAPRANGE rangex rangey] [MASTERPAGE name]
SNAPALL Always snaps objects to the guides.
Default=current.
SNAPRANGE Snaps objects when within this range.
Default=current.
MASTERPAGE/s The master page name. Default=current.
Notes:
Guide position and strength are part of the master page description. The snap-to-guide toggle is part of the window settings.
Examples:
setguide snapall masterpage '2 Columns'
Sets hyphenation options at the insertion point, for selected text or for a style tag.
sethyphenation <toggle [ZONE zone max]> [DOCUMENT name | WINDOW name | STYLETAG name]
toggle/k Toggles on or off hyphenation.
Options: on | off.
zone/d The hyphenation zone.
max/i The maximum hyphens in a row.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The zone is measured in the horizontal measurement system units unless specified otherwise.
Examples:
sethyphenation on sethyphenation zone 0.5 2 sethyphenation off styletag 'Headline'
Sets hyphenation options at the insertion point, for selected text or for a style tag.
sethyphenlanguage <language> [MINSIZES word before after what] [DOCUMENT name | WINDOW name | STYLETAG name]
language/s The hyphenation language:
DEFAULT Document/chapter default.
AMERICAN American English.
ENGLISH International English.
FRANCAIS French.
DEUTSCH German.
MINSIZES/i Sets the smallest word to hyphenate, and the minimum characters before and after
the hyphen. what/k Sets what to hyphenate.
Options: LOWERONLY Hyphenates lowercase words only.
UPPERLOWER Hyphenates all words.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
Examples:
sethyphenlanguage American minsizes 5 2 2 loweronly sethyphenlanguage Francais minsizes 6 3 2 ¨upperlower styletag 'Body Text'
Sets the left and right margin indents for the paragraph at the at the insertion point, for selected paragraphs or for a style tag.
setindent [NONE | LEFTRIGHT left right | LEFT left | RIGHT right] [DOCUMENT name | WINDOW name | STYLETAG name]
NONE Sets no indent.
LEFTRIGHT/d Sets the left and right margin indents.
LEFT/d Sets the left margin indent.
RIGHT/d Sets the right margin indent.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setindent none setindent leftright 0.5 0.5 styletag 'Body Text' setindent left 0.5 document 'project.doc'
Sets the italic style option at the insertion point, for selected text or for a style tag.
setitalic <preset | CUSTOM angle> [DOCUMENT name | WINDOW name | STYLETAG name]
preset/k Sets the italic style.
Options: OFF Toggles off the style.
STANDARD Default italic style (15).
BACKSLANT Default backslant style (-15).
CUSTOM/d Sets a custom slant. -180 to 180.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
If the STANDARD option is chosen and the font does not have a true italic style, the roman style will be slanted 15.
Examples:
setitalic off setitalic custom '-25' document 'project.doc' setitalic backslant styletag 'Backwards Text'
Changes the job numbering status.
setjobnumbering [status] [NAME name] [NEXTNUMBER number] [SAVE]
status/k Sets the job numbering status.
Options: ON Toggles on job numbering.
OFF Toggles off job numbering.
TOGGLE Toggles job numbering.
NAME/s The job number prefix.
NEXTNUMBER/i The next job number to use.
SAVE Saves to the PageStream3 Preferences file.
Notes:
The TOGGLE parameter may not be used in conjunction with the SAVE parameter.
Examples:
setjobnumbering on name JML nextnumber 128 save
Sets the justification option at the insertion point, for selected text or for a style tag.
setjustification [alignment] [DOCUMENT name | WINDOW name | STYLETAG name]
alignment/k Sets the alignment.
Options: FLUSH | LEFT | CENTER | RIGHT.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setjustification center setjustification flush document 'project.doc' setjustification left styletag 'Body Text'
Sets the kerning options at the insertion point, for selected text or for a style tag.
setkerning <toggle> [KERNABOVE size] [DOCUMENT name | WINDOW name | STYLETAG name]
toggle/k Toggles on or off kerning.
Options: on | off.
KERNABOVE/d kerns text only above a certain size.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setkerning on setkerning off document 'project.doc' setkerning on kernabove 5 styletag 'Body Text'
Sets the text language at the insertion point, for selected text or for a style tag.
setlanguage <language> [DOCUMENT name | WINDOW name | STYLETAG name]
language/s The language:
DEFAULT Document/chapter default.
AMERICAN American English.
ENGLISH International English.
FRANCAIS French.
DEUTSCH German.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
This command does not have an interface equivalent.
Examples:
setlanguage American setlanguage Francais styletag 'Body Text'
Sets the last line flush zone at the insertion point, for selected text or for a style tag.
setlastlineflush <zone> [DOCUMENT name | WINDOW name | STYLETAG name]
zone/d The last line flush zone.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The zone is measured in the horizontal measurement system units unless specified otherwise.
Examples:
setlastlineflush 0.75 setlastlineflush '8p' document 'project.doc' setlastlineflush 1 styletag 'Special Format'
Sets the leading at the insertion point, for selected text or for a style tag.
setleading [type amount] [MAINTAIN <toggle>] [DOCUMENT name | WINDOW name | STYLETAG name]
type/k The leading method.
Options: AUTOMATIC Automatic line spacing.
FIXED Fixed leading.
RELATIVE Relative leading.
amount/d The leading amount.
MAINTAIN/k Toggles maintain leading.
Options: on | off.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
Automatic and fixed leading are measured in the text measurement system unless specified otherwise, while relative leading is a percentage of the type size.
Examples:
setleading automatic 3 setleading relative 120 'project.doc' setleading fixed '14pt'
Sets the ligature options at the insertion point, for selected text or for a style tag.
setligature <toggle [<ANY | NOFFIFFL> min max]> [DOCUMENT name | WINDOW name | STYLETAG name]
toggle/k Toggles ligatures on or off.
Options: ANY Sets autoligatures.
NOFFIFFL Sets autoligatures to do all but ffi and ffl ligatures.
min/d The minimum track range for
autoligatures (-100 to 100%).
max/d The maximum track range for autoligatures (-100 to 100%).
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setligature on setligature on noffiffl '-30 25' setligature on any '-20 20' styletag 'Body Text'
Changes the lock status of an object.
setobjectlock <status> [DOCUMENT name | WINDOW name | OBJECTID number]
status/k The lock status.
Options: on |off | toggle.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object. Default=current.
Examples:
setobjectlock on setobjectlock toggle document 'Project.doc'
Sets the default increment for the Magnify tool.
setmagnifyincrement [SCALE increment] [SAVE]
SCALE/d The magnification increment in percent (>100).
SAVE Saves to the PageStream3 Preferences file.
Notes:
To double the magnification level with the Magnify tool, set SCALE to 200. (Shift Magnify will then halve the magnification.)
Examples:
setmagnifyincrement 150 save
Change the margin guides of a master page in a document or chapter.
setmarginguides <inside outside top bottom> [SAVE] [MASTERPAGE name/S]
inside/d The inside or left margin guide position.
outside/d The outside or right margin guide position.
top/d The top margin guide position.
bottom/d The bottom margin guide position.
SAVE Saves to the PageStream3 Preferences file.
MASTERPAGE/s The master page name. Default=current.
Examples:
setmarginguides 1 0.75 1 1.25 masterpage 'Layout2' setmarginguides 1 1 1 1
Set the description for a master page in a document or chapter.
setmasterpagedesc <text> [MASTERPAGE name]
text/s The master page description.
MASTERPAGE/s The master page name. Default=current.
Examples:
setmasterpagedesc 'Use for inside newsletter pages.'
Set the name of a master page.
setmasterpagename <name> [MASTERPAGE name]
name/s The new name of the master page.
MASTERPAGE/s The old master page name.
Default=current.
Examples:
setmasterpagename 'Layout2' 'Default Master Page'
Set the default measurement system units.
setmeasurements [COORDINATE horz vert] [TEXT units] [RELATIVE units] [FROM <PAGE | SPREAD>] [SAVE]
COORDINATE/k The measurement system units.
Options: INCHES | CENTIMETERS | MILLIMETERS | PICAS | POINTS | PRINTERPICAS | PRINTERPOINTS | CICEROS | DIDOTPOINTS | FEET | METERS | SAMEAS.
TEXT/k The measurement system for text.
Options: same as COORDINATES.
RELATIVE/k The measurement system for non-directional measurements. i.e., corner parameter in DRAWBOX.
Options: same as COORDINATES.
FROM/k Specifies whether the measurements are relative to the page or spread.
SAVE Saves to the PageStream3 Preferences file.
Notes:
SAMEAS is allowed for all but the horizontal measurement system. This sets the measurement system to the same as the horizontal system.
Examples:
setmeasurements coordinate inches points save setmeasurements coordinate inches sameas text points
Sets the minimum line length at the insertion point, for selected text or for a style tag. This is the minimum length of a line on which PageStream will try to fit a line of text. If the column is narrower than the minimum line length, or more likely, if text runaround an object shortens the usable line length to less than this value, PageStream will not place text on this line.
setminlinelength <length> [DOCUMENT name | WINDOW name | STYLETAG name]
length/d The minimum line length. Default = 0.5".
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The length is measured in the horizontal measurement system units unless specified otherwise.
Examples:
setminlinelength 0.75 setminlinelength '8p' document 'project.doc' setminlinelength 0.5 styletag 'Special Format'
Set the default move amount.
setmovedefaults [OFFSET x y] [toggle] [SAVE]
OFFSET/d The amount to move objects.
toggle/k The snap status.
Options: SNAP | NOSNAP.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setmovedefault offset 0.25 1 snap save
Sets the normal style option at the insertion point, for selected text or for a style tag, and toggles off any other type styles.
setnormal [DOCUMENT name | WINDOW name | STYLETAG name]
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
setnormal setnormal document 'project.doc'
Set the default nudge amount.
setnudgedefaults <nudge> [SAVE]
nudge/d The amount to nudge objects.
SAVE Saves to the PageStream3 Preferences file.
Notes:
Nudge is unsigned because the NUDGE command determines the nudge direction.
Examples:
setnudgedefaults 0.125 save
Sets the object style tag for the selected object(s). If no objects are selected, it sets the object style for future objects.
setobjectstyle <style> [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
style The object style to set.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s --unknown--
Examples:
setobjectstyle 'CoolBlend'
Sets the outline style option at the insertion point, for selected text or for a style tag.
setoutline <preset> [DOCUMENT name | WINDOW name | STYLETAG name]
preset/k Sets the outline style.
Options: OFF Toggles off the style.
STANDARD The default outline style.
CUSTOM Sets custom attributes.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The standard outline style is:
You can actually set a fill style for outlined text. The Outline type style is really just a shortcut for an alternate combination of line and fill attributes, and the preset alternate is normal outline.
Examples:
setoutline off setoutline custom document 'project.doc' setoutline standard styletag 'Outlined Text'
Set the description for a page in a document or chapter.
setpagedesc<text> [PAGE number]
text/s The page description.
PAGE The page number. Default=current.
Examples:
setpagedesc 'Alternate title page' page 7
Rename a page in a document or chapter.
setpagename <name> [PAGE number]
name/s The new name of the page.
PAGE/s The page number. Default=current.
Examples:
setpagename 'My page' page 'Your page'
Sets the page numbering system for pages in a chapter or document. All pages inside the specified (or current) chapter or document will be affected.
setpagenumbering [START <AUTOMATIC | CUSTOM number> LENGTH <AUTOMATIC | CUSTOM length>] [MASTERPAGE name] [FORMAT type] [LANGUAGE name] [PREFIX string] [DOCUMENT name | CHAPTER name | WINDOW name]
START/k The numbering method.
Options: AUTOMATIC Automatic numbering.
AUTOODD Automatic, starting on odd pages. (Intended for chapters.) Default.
AUTOEVEN Automatic, starting on even pages.
CUSTOM/i Manual numbering and the start number.
LENGTH/k The subchapter length.Options: AUTOMATIC Does not override the normal chapter length.
CUSTOM Ends the chapter on a specific page.
MASTERPAGE/s The master page to use for blank pages.
FORMAT/k The number format: DEFAULT | LONG | ARABIC | ROMANUPPER | ROMANLOWER | ALPHAUPPER | ALPHALOWER.
LANGUAGE/s The number language:
DEFAULT Document/chapter default.
AMERICAN American English.
ENGLISH International English.
FRANCAIS French.
DEUTSCH German.
PREFIX/s The prefix string.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
CHAPTER/s The document/chapter name.
Default=current.
Examples:
setpagenumbering start automatic length automatic setpagenumbering start autoodd length automatic
Sets the manual kerning for the character pair at the insertion point. This command can only be used when the insertion point is between two characters and text is not selected.
setpairkern <AMOUNT kern> [DOCUMENT name | WINDOW name]
AMOUNT/d Sets manual kerning (-327 to 327).
DOCUMENT/s The document name.
WINDOW/s The window name.
Notes:
If the charater pair are also automatically kerned, the pair kerning will still be measured from zero, but will be applied on top of the automatic design kerning.
Kerning units are 1/100th of an em space.
Examples:
setpairkern amount '-10.5' document 'project.doc'
Sets the inter-paragraph spacing for the paragraph at the insertion point, for selected paragraphs or for a style tag.
setparagraphleading [BEFORE <type amount | GLOBALGRID>] [AFTER <type amount | GLOBALGRID>] [DOCUMENT name | WINDOW name | STYLETAG name]
BEFORE Specifies space before the paragraph.
AFTER Specifies space after the paragraph.
type/k The leading method.
Options: AUTOMATIC Automatic line spacing.
FIXED Fixed leading.
RELATIVE Relative leading.
LOCALGRID The local leading grid. No interface equivalent. amount/d The leading amount.
GLOBALGRID Locks text to the global leading grid.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
Automatic, fixed and grid leading are measured in the text measurement system unless specified otherwise, while relative leading is a percentage of the type size.
A local leading grid is one that can be set for a block of text to align it to a grid offset from the ruler origin. A global leading grid is set for the document as a whole and works in a similar manner.
Examples:
setparagraphleading before globalgrid styletag ¨'Body Text' setparagraphleading after relative 120 'project.doc' setparagraphleading before fixed '14pt' after ¨sameasleading
Sets the paragraph style for the paragraph at the insertion point or for selected paragraphs.
setparagraphstyle <style> [DOCUMENT name | WINDOW name | STYLETAG name]
style/s The paragraph style to set.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s --unknown--
Examples:
setparagraphstyle 'Body Text'
Sets the name and description of a picture object.
setpicture [NAME name] [DESC description] [DOCUMENT name | WINDOW name | OBJECTID number]
NAME/s The new name of the object.
DESC/s The new description of the object.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Default=current.
Examples:
setpicture name 'CorporateLogo'
Sets the default type of polygons drawn.
setpolygondefaults [type] [SIDES number] [OFFSETANGLE angle] [DEFLECTION amount] [ANGLEDEFLECTION amount]
type/k The polygon type.
Options: NORMAL | STAR | PUFFY | SCALLOP | WAVY.
SIDES/i The number of sides.
Must be >2.
OFFSETANGLE/d The pre-rotation angle.
DEFLECTION/d The spike depth.
ANGLEDEFLECTION/d The spike angle.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setpolygondefaults sides 6 puffy save
Sets the reverse style option at the insertion point, for selected text or for a style tag.
setreverse <OFF | STANDARD | CUSTOM left top right bottom>[DOCUMENT name | WINDOW name | STYLETAG name]
OFF Toggles off the style.
STANDARD The default reverse style.
CUSTOM Sets custom offsets.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The standard single reverse style is:
When you specify a color for reverse type, you specify the foreground color. The background color is always the text color.
Examples:
setreverse standard setreverse custom 15 20 25 15 document 'project.doc' setreverse custom 10 10 10 10 styletag 'Reverse 10'
Toggles revision tracking on or off.
setrevisiontracking [status] [SAVE]
status/k Sets the revision tracking status.
Options:ON Toggles on revision tracking.
OFF Toggles off revision tracking.
TOGGLE Toggles revision tracking.
SAVE Saves to the PageStream3 Preferences file.
Notes:
The TOGGLE parameter may not be used in conjunction with the SAVE parameter.
Examples:
setrevisiontracking on setrevisiontracking off save
Sets the screen for an object or text, or for a style tag. If object or text is chosen and nothing is selected, it sets the screen for future objects or text, as applicable.
setscreen <4 (<DEFAULT | frequency> <DEFAULT | angle><type>)...> [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
4 The colors to set. OrderL
1 Cyan
2 Magenta
3 Yellow
4 Black
Repeat once for each color.
DEFAULT Sets the default screen frequency.
frequency/d Sets a custom screen frequency.
DEFAULT Sets the default screen angle.
frequency/d Sets a custom screen angle.
type/k Sets the screen type.
Options: DEFAULT Sets the device's default.
DOT Sets a dot screen.
LINE Sets a line screen.
TRIANGLE Sets a triangle screen.
PROPELLER Sets a propeller screen.
DONUT Sets a donut screen.
RING Sets a ring screen.
ALL Sets the fill and stroke fill.
Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
/* sets the screen of black */ setscreen 4 default default default default default ¨default default default default 133 60 ring object
Sets the subscript or superscript style option at the insertion point, for selected text or for a style tag.
setscript <OFF | SUB | CUSTOMSUB offset scalex scaley | SUPER | CUSTOMSUPER offset scalex scaley> [DOCUMENT name | WINDOW name | STYLETAG name]
OFF Toggles off the style.
SUB Sets the default subscript.
CUSTOMSUB/d Sets a custom offset and scale.
SUPER Sets the default superscript.
CUSTOMSUPER/d Sets a custom offset and scale.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The standard subscript and superscript styles are:
Examples:
setscript off setscript customsub 30 40 40 document 'project.doc' setscript super styletag 'Special Style'
AmigaOnly
Set the default file path for executing and exporting external scripts, and for loading and saving the PageStream3 Scripts file.
setscriptpath <filepath> [SAVE]
filepath/s The path for the files.
SAVE Saves to the PageStream3 Preferences file.
Examples:
setscriptpath 'Rexx:'
Sets the shadow style option at the insertion point, for selected text or for a style tag.
setshadow <OFF | STANDARD | CUSTOM offsetx offsety [ROTATE angle | SKEW slantangle twistangle]> [DOCUMENT name | WINDOW name | STYLETAG name]
OFF Toggles off the style.
STANDARD Sets the default shadow style.
CUSTOM/d Sets custom offsets.
ROTATE/d The rotation angle. Default=current.
SKEW/d The slant and twist angle.
Default=current.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The standard shadow style is:
Examples:
setshadow standard setshadow custom 25 30 skew 5 0 document 'project.doc'
Sets the small cap style option at the insertion point, for selected text or for a style tag.
setsmallcaps <OFF | STANDARD | CUSTOM x y> [DOCUMENT name | WINDOW name | STYLETAG name]
OFF Toggles off the style.
STANDARD Sets the default small caps style.
CUSTOM/d Sets custom scale for the small caps.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
If the STANDARD option is chosen and the font does not have a true small caps or titilng style, the normal style will be scaled.
The standard smallcaps style is:
The standard titlingcaps style is:
Examples:
setsmallcaps standard setsmallcaps custom 30 40 40 document 'project.doc'
Changes the smart typing status.
setsmart [SINGLEQUOTES status] [DOUBLEQUOTES status] [DASHES status] [BULLETS status] [SAVE]
SINGLEQUOTES Toggles smart single quotes.
DOUBLEQUOTES Toggles smart double quotes.
DASHES Toggles smart dashes.
BULLETS Toggles on or off smart bullets.
status/k Toggles the feature.
Options: on | off | toggle.
SAVE Saves to the PageStream3 Preferences file.
Notes:
The TOGGLE parameter may not be used in conjunction with the SAVE parameter.
Examples:
setsmart dashes off bullets toggle setsmart singlequotes on doublequotes on save
Sets the stroke dash for an object or text, or for a stroke style tag. If object or text is chosen and nothing is selected, it sets the stroke dash for future objects or text, as applicable.
setstroke <SOLID | PATTERN pattern> [ALL | FILL | STROKENUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
SOLID Sets the dash to solid.
PATTERN/s The dash pattern. See notes.
ALL Sets the fill and stroke fill.
Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
PATTERN: Dashes are comprised of 16 dots which may be toggled on and off. Use a '1' to toggle a dot on, and a '0' to toggle a dot off. For example, a dash pattern with dashes two dots wide with two dots of space between them, would be '1100110011001100'.
Examples:
setstroke solid setstroke pattern '1010101010101010' strokenumber ¨1 object setstroke pattern 1111000011110000
Sets the beginning arrowhead for an object, or for a stroke style tag. If nothing is selected, it sets the beginning arrowhead for future objects.
setstrokebegin <type> [ALL | STROKENUMBER number] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
type/k Sets the arrowhead type.
Options: FLAT | ROUND | SQUARE.
ALL Sets the fill and stroke fill.
Default.
STROKENUMBER/i Sets a stroke only. See notes.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
setstrokebegin flat setstrokebegin round strokenumber 1 object
Sets the stroke cap for an object, or for a stroke style tag. If nothing is selected, it sets the stroke cap for future objects.
setstrokecap <type> [ALL | STROKENUMBER number] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
type/k Sets the cap type.
Options: BUTT | ROUND | SQUARE.
ALL Sets the fill and stroke fill.
Default.
STROKENUMBER/i Sets a stroke only. See notes.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
setstrokecap butt setstrokecap round strokenumber 1 object
Sets the number of strokes for the selected object(s) or text. If nothing is selected, it sets the number of strokes for future objects or text, as applicable.
setstrokecount <count> [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
count/i The number of strokes to set. (1-5)
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
Strokes are numbered from 0. This is different than the program interface which numbers them from 1. If you create two strokes for an object, they will be numbered 0 and 1. The maximum number of strokes is 5.
Examples:
setstrokecount '3' object
Sets the ending arrowhead for an object, or for a stroke style tag. If nothing is selected, it sets the beginning arrowhead for future objects.
setstrokeend <type> [ALL | STROKENUMBER number] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
type/k Sets the arrowhead type.
Options: FLAT | ROUND | SQUARE.
ALL Sets the fill and stroke fill.
Default.
STROKENUMBER/i Sets a stroke only. See notes.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
setstrokeend flat setstrokeend round strokenumber 1 object
Sets the stroke join for an object, or for a stroke style tag. If nothing is selected, it sets the stroke join for future objects.
setstrokewidth <MITER <limit | DEFAULT> | ROUND | BEVEL>[ALL | STROKENUMBER number] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
MITER/d Sets a miter join.
DEFAULT Sets the default miter limit (11).
ROUND Sets a round join.
BEVEL Sets a bevel join.
ALL Sets the fill and stroke fill.
Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
setstrokejoin bevel setstrokejoin round strokenumber 1 object setstrokejoin miter 15
Sets the stroke offset for an object or text, or for a stroke style tag. If object or text is chosen and nothing is selected, it sets the stroke offset for future objects or text, as applicable.
setstrokeoffset <offset> [ALL | STROKENUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
offset/d The offset of the stroke.
ALL Sets the fill and stroke fill.
Default.
STROKENUMBER/i Sets a stroke only. See notes.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
setstrokeoffset 0.125 setstrokeoffset '3pt' strokenumber 1 object
Sets the stroke dash style tag for the selected object(s) or text. If nothing is selected, it sets the dash style for future objects or text, as applicable.
setstrokestyle <dash> [ALL | FILL | STROKENUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
dash/s The dash style to set.
ALL Sets the fill and stroke fill.
Default.
FILL Sets the fill only.
STROKENUMBER/i Sets a stroke only. See notes.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
setstrokestyle '15' setstrokestyle 'Dots' strokenumber 1 object
Sets the stroke weight for an object or text, or for a stroke style tag. If object or text is chosen and nothing is selected, it sets the stroke weight for future objects or text, as applicable.
setstrokeweight <weight> [ALL | STROKENUMBER number] [what] [DOCUMENT name | WINDOW name | OBJECTID number | STYLETAG name]
weight The weight of the stroke.
ALL Sets the fill and stroke fill.
Default.
STROKENUMBER/i Sets a stroke only. See notes.
what/k Specifies what to set.
Options: OBJECT The object. Default.
TEXT The text.
SHADOW The text shadow.
REVERSE The text reverse.
UNDERLINE The text underline.
OUTLINE The text outline.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
STYLETAG/s Sets the attribute for a style tag.
Notes:
STROKENUMBER: Strokes are numbered from 0. This is different than the program interface which numbers them from 1.
Examples:
setstrokeweight 2 setstrokeweight 1.5 strokenumber 1 object setstrokeweight 5 text
Sets the Next Style option of a style tag.
setstyletagname <nextstyle> [STYLETAG name]
nextstyle/s The Next Style for a style tag.
STYLETAG/s The name of the style tag to change.
Examples:
setstyletag nextstyle 'Body Text' styletag 'Headline'
Changes the name of a style tag.
setstyletagname <name> [STYLETAG name]
name/s The new name of the style tag.
STYLETAG/s The current name of the style tag.
Examples:
setstyletagname 'Body Text' styletag 'paragraph text'
Sets the subscript style option at the insertion point, for selected text or for a style tag.
setsubscript <OFF | STANDARD | CUSTOM offset scalex scaley>[DOCUMENT name | WINDOW name | STYLETAG name]
OFF Toggles off the style.
STANDARD Sets he default subscript style.
CUSTOM Sets a custom offset and scale.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The standard subscript style is:
Examples:
setsubscript off setsubscript custom 30 40 40 document 'project.doc' setsubscript standard styletag 'Special Style'
Sets the superscript style option at the insertion point, for selected text or for a style tag.
setsuperscript <OFF | STANDARD | CUSTOM offset scalex scaley>[DOCUMENT name | WINDOW name | STYLETAG name]
OFF Toggles off the style.
STANDARD Sets he default superscript style.
CUSTOM Sets a custom offset and scale.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The standard superscript style is:
Examples:
setsuperscript off setsuperscript custom 30 40 40 document 'project.doc' setsuperscript standard styletag 'Special Style'
Sets the tabs for the paragraph at the insertion point, for selected paragraphs or for a style tag.
settabruler (<<preset | CUSTOMDECIMAL unicode> position>[LEADER unicode]>)... [DOCUMENT name | WINDOW name | STYLETAG name]
preset/k Sets the alignment type.
Options: LEFT | CENTER | RIGHT | USDECIMAL | EURODECIMAL.
CUSTOMDECIMAL/I Sets a custom alignment character.
position/d Sets the tab position.
LEADER/i Sets the fill character.
Default=none.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
To delete or move tabs from a script, you should get the existing tab positions and then reset them as required.
You can enter a unicode value if the character for the leader or custom decimal is not part of the AmigaDOS character set. Type a backslash followed by the unicode value for a unicode character.
Examples:
settabruler left 0.5 left 1.25 right 2.25 settabruler center 1.5 settabruler usdecimal 6 document 'project.doc' settabruler customdecimal \8226 settabruler customdecimal ''
Set the default drawing editor script for the Send to Editor command.
settexteditor <script> [SAVE]
script/s The filename and path of the script to use.
SAVE Saves to the PageStream3 Preferences file.
Examples:
settexteditor 'Scripts/SendtoPageLiner.rexx'
Toggles the ability of a shape to hold text.
settextframe [status] [COLUMNS number] [GUTTER space] [mode] [DOCUMENT name | WINDOW name | OBJECTID number]
status/k Toggles the text frame status.
Options: ON Makes it a text frame.
OFF Makes it a normal object.
TOGGLE Toggles the text frame ability.
COLUMNS/i The number of columns in the frame.
GUTTER/d The space between columns.
mode/k The user prompt mode for off.
Options: force | alert | quiet (default).
Force deletes text in the frame without asking for confirmation, alert opens an alert box for confirmation, and quiet deletes without confirmation but returns an error if text is deleted.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object. Default=current.
Examples:
settextframe on columns 3 settextframe off quiet
Sets the default file path for inserting and exporting text.
settextpath <filepath> [SAVE]
filepath/s The path for the files.
SAVE Saves to the PageStream3 Preferences file.
Examples:
settextpath 'Work:Wordworth5/Documents'
Links frames together to flow text from one to another.
settextrouting <FROM <OBJECTID number | <x y [stack]>[PAGE number | MPG name | DOCUMENT name | WINDOW name]>> <<TO <OBJECTID number | <x y [stack]> [PAGE number | MPG name | DOCUMENT name | WINDOW name]>>
FROM Where to link from.
TO Where to link to.
OBJECTID/i The identification number of the text frame.
stack/k Specifies which frame to link.
Options: FRONTMOST Selects the frontmost frame at the point.
BACKMOST Selects the backmost frame at the point.
PAGE/s The page number.
MPG/s The master page name and side.
DOCUMENT/s The document name.
WINDOW/s The window name.
Notes:
You cannot link a text frame to a frame in another document. If the DOCUMENT or WINDOW parameters are used, they must specify the same document in both the FROM and TO parameters.
Examples:
settextrouting from 1.25 2.25 page 5 to 1.25 2.25 ¨page 6
Sets the text wrap options for the selected object(s).
settextwrap [type] [STANDOFF x y] [mode] [DOCUMENT name | WINDOW name | OBJECTID number]
type/k The type of wrap.
Options: SHAPE Wraps around the path.
BOUNDINGBOX Wraps around the bounding box.
FENCE Wraps around the clipping path.
mode/k How to wrap text.
Options: STANDOFF Sets the text offset.
NOWRAP Flows text over the objects.
WRAPLEFT Flows text to the left of the objects.
WRAPRIGHT Flows text to the right of the objects.
WRAPJUMP Does not flow text on either side of the objects.
WRAPAROUND Flows text on both sides of the objects.
WRAPINSIDE Flows text inside the objects, but not outside.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object. Default=current.
Examples:
settextwrap wrapjump standoff 0.125 0.125
Sets the toolbox mode.
settoolmode <tool | LASTUSED | PREVIOUS | NEXT> [WINDOW name]
tool/k The tool to select.
Options: OBJECT | RESHAPE | CROP | MAGNIFY | TEXT | EYEDROPPER | COLUMN | LINE | BOX | RBOX | ELLIPSE | ARC | PEN | FREEHAND | GRID | ROUTETEXT.
LASTUSED Sets the last set tool.
PREVIOUS Sets the previous tool in the toolbox; left to right or top to bottom order.
NEXT Sets the next tool in the toolbox; left to right or top to bottom order.
WINDOW/s The window name. Default=current.
Notes:
You do not have to set the toolbox mode in order to draw an object with a script command. This command is only used when you wish to set the interface's toolbox mode.
Examples:
settoolmode text window 'Untitled 1~View.1' settoolmode lastused
Sets the toolbar buttons.
settoolbar (<command | SCRIPT name SPACE>)...
command/s The name of a menu command.
SCRIPT/s The name of an internal script.
SPACE/k Inserts space between buttons.
Notes:
Menu command names are abbreviated. Record the setting of the toolbar to find the names you need because there are too many to list here.
Include the ellipsis for script names.
Examples:
settoolbar new open savedoc print space cut copy ¨paste delete space undo redo space linktext ¨breaktextrouting space indentleft indentright ¨hangingindent space execute preferences settoolbar execute space script "Toggle Fill" ¨
Sets the tracking value at the insertion point, for selected text or for a style tag. Tracking can be applied on top of a tracking table's preset tracking.
settracking <track> [DOCUMENT name | WINDOW name | STYLETAG name]
track/d The tracking value (-327 to 327).
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
Tracking units are 1/100th of an em space.
Examples:
settracking '-10' settracking 15 document 'project.doc' settracking 5 styletag 'Body Text'
Sets the tracking range options at the insertion point, for selected text or for a style tag.
settrackrange <minc optc maxc minw optw maxw> [DOCUMENT name | WINDOW name | STYLETAG name]
minc/d The minimum character spacing.
optc/d The optimum character spacing.
maxc/d The maximum character spacing.
minw/d The minimum word spacing.
optw/d The optimum word spacing.
maxw/d The maximum word spacing.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
settrackrange '-5 0 25 75 100 150' settrackrange '-5 0 25 75 100 150' styletag 'Body'
Sets the tracking table at the insertion point, for selected text or for a style tag. A tracking table is a preset formula which tracks tighter at large sizes. Tracking tables are non-editable. Tracking can be applied on top of a tracking table's preset tracking.
settracktable <table> [DOCUMENT name | WINDOW name | STYLETAG name]
table/k Sets the tracking table.
Options: NONE | VERYLOOSE | LOOSE | NORMAL | TIGHT | VERYTIGHT.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
settracktable loose settracktable normal document 'project.doc' settracktable tight styletag 'Body Text'
Sets the type angle at the insertion point, for selected text or for a style tag.
settypeangle [ROTATE angle] [SKEW slantangle twistangle] [DOCUMENT name | WINDOW name | STYLETAG name]
ROTATE/D The rotation angle. Default=current.
SKEW/D The slant and twist angle.
Default=current.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
This sets the italic slant angle for fonts that lack a true italic style, and also allows you to twist and rotate blocks of text. To set only the italic slant angle, set the slantangle to the desired value and set the twistangle to 0.
Examples:
settypeangle rotate 25 settypeangle skew 15 30 settypeangle rotate 14 styletag 'Rotated Text'
Sets the type size at the insertion point, for selected text or for a style tag.
settypesize <size> [DOCUMENT name | WINDOW name | STYLETAG name]
size/d The type size.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
settypesize 15 settypesize '0.5"' settypesize 14 styletag 'Body Text'
Sets the horizontal scale at the insertion point, for selected text or for a style tag.
settypewidth <width> [DOCUMENT name | WINDOW name | STYLETAG name]
width/d The horizontal scale.
Default=current.
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Examples:
settypewidth 80 settypewidth 120 styletag 'Body Text'
Sets the underline style option at the insertion point, for selected text or for a style tag.
setunderline <preset | CUSTOM <CONTINUOUS | WORD | CHARACTER>offset> [DOCUMENT name | WINDOW name | STYLETAG name]
preset/k Sets the underline style.
Options: OFF Toggles off the style.
SINGLE Standard underlining.
DOUBLE Double underlining.
STRIKETHROUGH Standard strikethrough.
CUSTOM/d Sets a custom format and offset
DOCUMENT/s The document name.
WINDOW/s The window name.
STYLETAG/s Sets the attribute for a style tag.
Notes:
The standard single underline style is:
The standard double underline style is:
The standard strikethrough style is:
Examples:
setunderline off setunderline custom word 20 document 'project.doc' setunderline double styletag 'Table Text 2'
Changes the number of undo levels available.
setundolevels <levels> [SAVE]
levels/i The number of undo levels to permit.
SAVE Saves to the PageStream3 Preferences file.
Notes:
The number of undo levels is limited only by memory. For unlimited levels of undo, set levels to -1. It is recommended that you restrict the number of levels of undo to conserve memory.
Examples:
setundolevels 16 save
Sets the name of a user variable.
setvariablename <name VARIABLE name>
name/s The new name of the variable.
VARIABLE The document/chapter/variable name.
Default=current.
Examples:
setvariablename author variable writer setvariablename author variable MyBook.doc~writer
Sets the string of a user variable.
setvariablevalue <value VARIABLE name>
value/s The new string for the variable.
VARIABLE The document/chapter/variable name.
Default=current.
Examples:
'setvariablevalue "Bill Watson"' 'setvariablevalue "Bill Watson" variable ¨MyBook.doc~author'
Changes the default view options.
setviewdefaults [SCALE <custom | preset>] [SCALERANGE min max] [GRID status] [SNAPTOGRID status] [GRIDCOLOR red green blue] [DISPLAYGIRD status] [GUIDES status] [SNAPTOGUIDES status] [PAGEGUIDECOLOR red green blue] [RULERGUIDECOLOR red green blue] [DISPLAYGUIDES status] [PAGECOLOR red green blue] [PAGESHADOWCOLOR red green blue] [PAGEBORDERCOLOR red green blue] [PASTEBOARDCOLOR red green blue] [DRAWINGS status] [OUTLINE status] [TEXTLINKS status] [INVISIBLES status] [RULER status] [PICTURES status] [SAVE]
custom/d The custom view percentage.
preset/k The view magnification to set.
Options: FULLPAGE | FULLPAGEWIDTH | FULLPAGEHEIGHT | FULLPASTEBOARD | FULLPASTEBOARDWIDTH | FULLPASTEBOARDHEIGHT | LASTUSED.
SCALERANGE/d The minimum and maximum view scale.
GRID/k The grid display status.
Options:show | hide |toggle.
SNAPTOGRID/k The snap-to-grid status.
Options: on | off | toggle.
GRIDCOLOR/i The red, green and blue components
of the grid color. Range: 0-255.
DISPLAYGRID/k The grid depth.
Options: infront | inback | toggle.
GUIDES/k The guides display status.
Options: show | hide | toggle.
SNAPTOGUIDES/k The snap-to-guides status.
Options: on | off | toggle.
PAGEGUIDECOLOR/i The RGB components of the page guide color. Range: 0-255.
RULERGUIDECOLOR/i The RGB components of the ruler guide color. Range: 0-255.
DISPLAYGUIDES/k The guide depth.
Options: infront | inback | toggle.
PAGECOLOR/i The RGB components of the page color. Range: 0-255.
PAGESHADOWCOLOR/i The RGB components of the page shadow color. Range: 0-255.
PAGEBORDERCOLOR/i The RGB components of the page border color. Range: 0-255.
PASTEBOARDCOLOR/i The RGB components of the pasteboard color. Range: 0-255.
DRAWINGS/k The drawings display status.
Options: show | hide | toggle.
OUTLINE/k The column outlines display status.
Options: show | hide | toggle.
TEXTLINKS/k The text links display status.
Options: show | hide | toggle.
INVISIBLES/k The invisibles display status.
Options: show |hide | toggle.
RULER/k The rulers display status.
Options: show |hide | toggle.
PICTURES/k The pictures display status.
Options: show | hide | toggle.
SAVE Saves to the PageStream3 Preferences file.
Notes:
The TOGGLE parameter may not be used in conjunction with the SAVE parameter.
Examples:
setviewdefaults scale 50 grid hide pictures show save
Changes the view name of a window.
setwindowname <name> [WINDOW name]
name/s The new view name of a window.
WINDOW/s The old window name. Default=current.
Notes:
Windowname is just the new view name and cannot include the document name. The document name can be changed separately with the SETDOCUMENTNAME command.
Examples:
setwindowname 'My View' window 'Untitled 1~View.1'
Sets the size and position of the default document window.
setwindowdefaults [AT x y] [SIZE width height] [SAVE]
AT/i Sets the window position in pixels.
SIZE/i Sets the window size in pixels.
SAVE Saves to the PageStream3 Preferences file.
Notes:
If the AT pointy coordinate is set to -1, the window will open immediately below the screen title bar, regardless of the screen font height. If either SIZE coordinate is set to 10000, the window will open at the maximum size of the screen in that direction.
This command does not affect open document windows. It sets the position and size of future document windows. Use the SETWINDOWPOS command to set the position and size of open document windows.
Examples:
setwindowdefaults at 0 -1 size 640 10000
setwindowdefaults at 0 -1 save
Sets the size and position of an open document window.
setwindowpos [AT x y] [SIZE width height] [WINDOW name]
AT/i Sets the window position in pixels.
SIZE/i Sets the window size in pixels.
WINDOW is the window name. Default=current.
Notes:
If the AT pointy coordinate is set to -1, the window will open immediately below the screen title bar, regardless of the screen font height. If either SIZE coordinate is set to 10000, the window will open at the maximum size of the screen in that direction.
This command does not affect future document windows. It sets the position and size of an open document window only. Use the SETWINDOWDEFAULTS command to set the position and size of future document windows.
Examples:
setwindowpos at 0 -1 size 640 10000
Simplfies the path by replacing lines and curves with a minimum number of lines and curves. There is no loss of accuracy. Use this command to simplify an overly complex path.
simplifypath [DOCUMENT name | WINDOW name]
DOCUMENT/s The document name.
WINDOW/s The window name.
Examples:
simplifypath simplifypath window 'Untitled 1~View.1'
Skew selected objects horizontally (slant) and/or vertically (twist).
skew <slant twist> [ABOUT pointx pointy | ABOUTCENTER] [DOCUMENT name | WINDOW name | OBJECTID number]
slant/d The slant angle.
twist/d The twist angle.
ABOUT/d The rotation point.
ABOUTCENTER Rotates around its center. Default.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
Examples:
skew 90 131 about 2.2 3.125 document 'project.doc'
- not currently implemented -
Smoothes the path by replacing lines and curves with a minimum number of curves. There is a loss of accuracy because rough spots will be rounded out. Use this command to smooth a freehand path.
smoothpath [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:
smoothpath smoothpath window 'Untitled 1~View.1'
Changes the snap-to-grid status.
snaptogrid <status> [WINDOW name]
status/k The snap-to-grid status.
Options: on | off | toggle.
WINDOW/s The window name. Default=current.
Notes:
Grid spacing and strength are part of the master page description. The snap-to-grid toggle is part of the window settings.
Snap-to-grid does not affect drawing with script commands; it affects drawing and editing from the interface only.
Examples:
snaptogrid on snaptogrid off window 'Untitled 1~View.1'
Changes the snap-to-guide status.
snaptoguides <status> [WINDOW name]
status/k The snap-to-guides status.
Options: on | off | toggle.
WINDOW/s The window name. Default=current.
Notes:
Guide position and strength are part of the master page description. The snap-to-guide toggle is part of the window settings.
Snap-to-guides does not affect drawing with script commands; it affects drawing and editing from the interface only.
Examples:
snaptoguides on snaptoguides off window 'Untitled 1~View.1'
Splits the paths of selected path(s) into their subpath(s).
splitpaths [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:
splitpaths splitpaths document 'project.doc'
Splits a path apart at a point.
splitpoint [POINTINDEX point] [DOCUMENT name | WINDOW name | OBJECTID number]
POINTINDEX/i The number of the point to split.
Default=selected point.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
Notes:
Pointindex identification numbers are numbered from 0 starting with the first moveto in a path. If the path is open, this will create two subpaths. If the path is closed, this will create an open path.
Examples:
splitpoint pointindex 23
Toggles the stroke for an object or text, or for a style tag. If object or text is chosen and nothing is selected, it toggles the stroke for future objects or text, as applicable.
stroked <status> [DOCUMENT name | WINDOW name | OBJECTID number]
status/k The stroke status.
Options: on | off | toggle.
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object.
Default=current.
Examples:
stroked on stroked toggle document 'project.doc'
Displays the style tag palette.
stylepalette [status] [AT x y] [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:
stylepalette toggle stylepalette show at 500 300 size 180 172 save stylepalette hide