generatemask
getarexxgadget
getarticle
getarticledesc
getarticleids
getarticlename
getarticleoverset
getarticlewordcount
getbox
getbusyrequester
getchapterdesc
getchapternumber
getchapternumbering
getchapters
getchoice
getcolumn
getcolumnguides
getcompound
getcoord
getcursor
getcursorcount
getdimensions
getdisplay
getdocumentdesc
getdocuments
getdocumentstatus
getdrawing
getdrawingdisplay
getellipse
geteps
geterrornumber
geterrorstring
getfacingpagedisplay
getfile
getfilepath
getfontlist
getfontstyles
getgreeking
getgrid
getgriddisplay
getgridobject
getgridsnap
getgroup
getguide
getguidedisplay
getguides
getguidesnap
getinvisibledisplay
getline
getmarginguides
getmasterpages
getmasterpagedesc
getobject
getobjectlock
getoutlinedisplay
getpagedesc
getpagemasterpage
getpagename
getpagenumbering
getpath
getpicture
getpicturedisplay
getpolygon
getportname
getredo
getrefreshmode
getregion
getrotation
getrulerdisplay
getscreendpi
getscreenname
getselectedobjects
getstring
gettextlinkdisplay
gettextframe
gettextobj
gettextwrap
getundo
getwindowpos
getwindows
greeking
group
Generates a new mask for a picture with a white background.
generatemask [DOCUMENT name | WINDOW name | OBJECTID number]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to edit.
Examples:
generatemask generatemask objectid hPic15
Gets the current state of a control. This is normally used after a dorequester command returns.
getarexxgadget <dbhandle ctlhandle attribute>
dbhandle/i The dialog box to interrogate.
ctlhandle/i The is the control to interrogate.
attribute/s The control attribute to get.
Options: CHECKED For checkbox controls. Returns 0 if unchecked, 1 if checked.
STRING For text and multiline controls. Returns the string contents.
CURRENT For popup, cycle, slider and scrolllist controls. Returns the selected item.
Results:
The state of the control is returned to RESULT.
Notes:
You do not need to use this command for exit buttons since the selected exit button is returned to RESULT by the DOREQUESTER command.
Examples:
getarexxgadget iGetName sNameCtl string sName=RESULT getarexxgadget iTestDBox MyControl cycle format=RESULT
Gets information concerning an article.
getarticle [FILEINFO stem] [FRAMES stem] [ARTICLE name | DOCUMENT name | WINDOW name | ARTICLEID number]
FILEINFO/a Gets the status of the article.
FRAMES/a Gets the number and IDs of frames in the article.
ARTICLE/s The name of the article.
DOCUMENT/s The document name.
WINDOW/s The window name.
ARTICLEID/i The number of the article.
Results:
FILEINFO stem
mode/k The storage location: internal|external.
file/s The article filepath and name.
FRAMES stem
count/i The number of frames in the article.
0/i The first frame's object id.
1/i The second frame's object id.
etc.
Notes:
All options default to the current values if not specified.
Examples:
getarticle info
Gets the description of an article.
getarticledesc [ARTICLE name | DOCUMENT name | WINDOW name | ARTICLEID number]
ARTICLE/s The name of the article.
DOCUMENT/s The document name.
WINDOW/s The window name.
ARTICLEID/i The number of the article.
Results:
The article description is returned to RESULT.
Notes:
All options default to the current values if not specified.
Examples:
getarticledesc
Gets the number of articles in a document or chapter and their IDs.
getarticles <stem> [DOCUMENT name | CHAPTER name | WINDOW name]
stem/a Gets the article IDs.
DOCUMENT/s The document name.
CHAPTER/s The chapter name.
WINDOW/s The window name.
Results:
The number of articles in the document or chapter is returned to RESULT.
stem
0/i The first article's ID.
1/i The second article's ID.
etc.
Notes:
All options default to the current values if not specified.
Examples:
getarticles info
Gets the name of an article.
getarticlename [DOCUMENT name | WINDOW name | ARTICLEID number]
DOCUMENT/s The document name.
WINDOW/s The window name.
ARTICLEID/i The number of the article.
Results:
The article name is returned to RESULT.
Notes:
All options default to the current values if not specified.
Examples:
getarticlename
Determines whether an article is overset or not.
getarticleoverset [ARTICLE name | DOCUMENT name | WINDOW name | ARTICLEID number]
ARTICLE/s The name of the article.
DOCUMENT/s The document name.
WINDOW/s The window name.
ARTICLEID/i The number of the article.
Results:
TRUE is returned to RESULT if it is overset; otherwise, FALSE is returned.
Notes:
All options default to the current values if not specified.
Examples:
getarticleoverset
Gets the number of words in an article.
getarticlewordcount [ARTICLE name | DOCUMENT name | WINDOW name | ARTICLEID number]
ARTICLE/s The name of the article.
DOCUMENT/s The document name.
WINDOW/s The window name.
ARTICLEID/i The number of the article.
Results:
The number of words in the article is returned to RESULT.
Notes:
All options default to the current values if not specified.
Examples:
getarticlewordcount
Gets coordinates and information for a box.
getbox [POSITION stem] [CORNER stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
CORNER/a Gets the corner radii.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
CORNER stem
type/k The corner type: NORMAL | ROUND | SCALLOP | BEVEL | INSET.
cornerx/d The horizontal corner radius.
cornery/d The vertical corner radius.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
getbox position coord
Gets the Stop button state in an open busy dialog box.
getbusyrequester <handle>
handle/i The handle of the dialog box.
Results:
0 is returned to RESULT if the Stop button has not been pressed; otherwise, 1 is returned.
Examples:
openbusyrequester message 'Thinking hard...'
thermometer enabled total 100 current 0
bh=RESULT
do for i = 1 to 100
/* script does something here */
/* abort if stop, else set thermometer */
getbusyrequester bh
if result=1 then break
else setbusyrequester bh current i
end i
closebusyrequester bh
Gets the description of a chapter.
getchapterdesc [DOCUMENT name | CHAPTER name]
DOCUMENT/s The document name. Default=current.
CHAPTER/s The chapter name. Default=current.
Results:
The description is returned to RESULT.
Examples:
getchapterdesc document 'Project.doc'
Gets the number of a chapter.
getchapternumber [DOCUMENT name | CHAPTER name]
DOCUMENT/s The document name. Default=current.
CHAPTER/s The chapter name. Default=current.
Results:
The chapter number is returned to RESULT.
Examples:
getchapternumber document 'Project.doc'
Gets the chapter numbering system and start number.
getchapternumbering <stem> [DOCUMENT name | CHAPTER name | WINDOW name]
stem/a Gets the chapter information.
DOCUMENT/s The document name. Default=current.
CHAPTER/s The chapter name. Default=current.
Results:
stem
startmode/k The numbering method: AUTOMATIC | CUSTOM.
start/i The starting chapter number
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.
Examples:
getchapternumbering info
Gets the number of chapters in a document or chapter and their names.
getchapters <stem> [DOCUMENT name | CHAPTER name | WINDOW name]
stem/a Gets the chaper information.
DOCUMENT/s The document name. Default=current.
CHAPTER/s The chapter name. Default=current.
WINDOW/s The window name. Default=current.
Results:
The number of chapters in the document or chapter is returned to RESULT.
stem
0/s The name of the first chapter.
1/s The name of the second chapter.
etc.
Examples:
getchapters chapnames
Opens a dialog box with a short message and allows the user to click on one of one, two or three buttons, to make a choice.
getchoice <MESSAGE message> <BUTTON1 label/S> [BUTTON2 label/S] [BUTTON3 label/S]
MESSAGE/s The message to show the user. Max length = 44 characters.
BUTTON1/s The label for the positive button. Max length = 8 characters. This button will be the default button.
BUTTON2/s The label for the negative button. Max length = 8 characters. This button can be activated by pressing the Esc key.
BUTTON3/s The label for a third button. Max length = 8 characters.
Results:
Returns the number of the button pressed to RESULT.
Notes:
Precede the character to underscore as a bound keyboard equivalent in the label name. For example, "_Huh?" would make "H"the keyboard shortcut for the "Huh?" button.
Examples:
'getchoice message "Click on a button." button1 "_OK"button2 "_Cancel"' buttonid=RESULT
Gets coordinates and information for a text column frame.
getcolumn [POSITION stem] [COLUMNS count] [GUTTER space] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
COLUMNS/i Gets the number of columns in the frame.
GUTTER/d Gets the space between the columns.
CORNER/a Gets the corner radii.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
COLUMNS count/s The number of columns.
GUTTER space/d The space between the columns.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
getcolumn position coord
Gets the column guides for a master page.
getcolumnguides <stem> [MASTERPAGE name]
stem/a Gets the guide information.
MASTERPAGE/s The master page name. Default=current.
Results:
stem
count/i The number of columns.
gutter/d The space between the columns.
Examples:
getcolumnguides info
Gets coordinates and information for a compound object.
getcompound [POSITION stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
getcompound position coord
Opens a small dialog box to instruct the user to click on the page to return a coordinate value to the script. The dialog box has a Cancel button.
getcoord <stem> [MESSAGE message]
stem/a Gets the mouse coordinates.
MESSAGE/s The message to display. Max length = 55 characters.
Results:
If Cancel is chosen, it sets RC to 10. If the user clicks on the page, it sets RC to 0 and returns the coordinates to the stem variable.
stem
x/d The horizontal coordinate.
y/d The vertical coordinate.
Examples:
'getcoord coord message "Click on the page"'
Gets information about the cursor or text selection(s).
getcursor [INDEX number] [TYPE string] [ARTICLEID handle] [FRAMESTART number] [FRAMEEND number] [FRAMESTARTID number] [FRAMEENDID number] [OBJECTID number] [LINESTART number] [LINEEND number] [CHARACTERSTART number] [CHARACTEREND number] [POSITIONSTART stem] [POSITIONEND stem] [DOCUMENT name/S | WINDOW name/S]
INDEX/i The text selection / cursor position about which to get information.
Default=1.
TYPE The type of text block
ARTICLEID/i The article ID of the article of the cursor position or text selection.*
FRAMESTART/i The first frame in the selection.*
FRAMEEND/i The last frame in the selection.*
FRAMESTARTID/i The object ID of the first frame in the selection.*
FRAMEENDID/i The object ID of the last frame in the selection.*
OBJECTID/i The object ID of the text block.**
LINESTART/i The ID of the first selected line.
LINEEND/i The ID of the last selected line.
CHARACTERSTART/i The ID of the first character selected.
CHARACTEREND/i The ID of the last character selected.
POSITIONSTART/a The position of the cursor or start of the selected text.
POSITIONEND/a The position of the end of the selected text.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
* apply only to text frames; will return 0 for
frameless text blocks.
** apply only to text blocks; will return 0 for text
frames.
Results:
TYPE string/k The type of object: ARTICLE (text frame) | TEXTOBJ (text block).
POSITIONSTART stem
x/d The horizontal coordinate
y/d The baseline coordinate
top/d The top of slug coordinate
bottom/d The bottom of slug coordinate
POSITIONEND stem
x/d The horizontal coordinate
y/d The baseline coordinate
top/d The top of slug coordinate
bottom/d The bottom of slug coordinate
Notes:
If there is only one cursor position or text selection, INDEX should be 1. If there are multiple text selections, (found out with getcursorcount, you may want to use this command more than once to get information about each selection.
FRAMESTART and FRAMEEND will be equal if no text is selected.
CHARACTERSTART and CHARACTEREND will be equal if no text is selected.
LINESTART, LINEEND, CHARACTERSTART and CHARACTEREND numbers don't have any value by themselves. They take into account hidden commands and are therefore not suitable for counting the number of characters selected.
Examples:
getcursor characterstart start characterend end
Gets the number of text selections. The user can select multiple blocks of text; this returns how many blocks exist.
getcursorcount [DOCUMENT name/S]
DOCUMENT The document name. Default=current.
Results:
The number of text selections is returned to RESULT.
Notes:
A result of 0 indicates that the cursor is not placed.
Examples:
getcursorcount
Gets the dimensions of a master page.
getdimensions <stem> [MASTERPAGE name]
stem/a Gets the dimensions.
MASTERPAGE/s The master page name. Default=current.
Results:
stem
width/d The width.
height/d The height.
orientation/k The orientation: PORTRAIT | LANDSCAPE.
spreads/k The spread type: FACING | INDIVIDUAL.
sides/k The number of sides: SINGLE | DOUBLE.
Examples:
getdimensions size
Gets the display settings.
getdisplay <stem> [WINDOW name]
stem/a Gets the display settings.
WINDOW/s The window name. Default=current.
Results:
stem
page/s The page number.
mode/k The view magnification mode: CUSTOM | FULLPAGE | FULLPASTEBOARD | FULLPAGEWIDTH | FULLPASTEBOARDWIDTH | FULLPAGEHEIGHT | FULLPASTEBOARDHEIGHT.
scale/d The custom view percentage.
left/d The horizontal page offset from the left of the window.
top/d The vertical page offset from the top of the window.
Examples:
getdisplay displaystuff
Gets the description of a document.
getdocumentdesc [DOCUMENT name]
DOCUMENT/s The document name. Default=current.
Results:
The description is returned to RESULT.
Examples:
getdocumentdesc document 'Project.doc'
Gets the number of open documents and their names.
getdocuments <stem>
stem/a Gets the document names.
Results:
the number of open documents is returned to RESULT.
stem
0/s The name of the first document.
1/s The name of the second document.
etc.
Examples:
getdocuments docnames
Gets the change status of a document.
getdocumentstatus [DOCUMENT name]
DOCUMENT/s The document name. Default=current.
Results:
The status (changed|unchanged) is returned to RESULT.
Examples:
getdocumentstatus document 'Project.doc'
Gets coordinates and information for a drawing.
getdrawing [POSITION stem] [FRAME string] [CONTENTOFFSET stem] [CONTENTSCALE stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [FILEINFO stem] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
FRAME/s Gets the frame state.
CONTENTOFFSET/a Gets the frame contents offset.
CONTENTSCALE/a Gets the frame contents scale.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
FILEINFO/a Gets the file location.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
FRAME string/s The frame state: ON | OFF.
CONTENTOFFSET stem
x/d The horizontal offset.
y/d The vertical offset.
CONTENTSCALE stem
h/d The horizontal scale.
v/d The vertical scale.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
FILEINFO stem
mode/k The file status: INTERNAL | EXTERNAL.
file/s The filepath and name.
Examples:
getdrawing position coord
Gets the drawing display status.
getdrawingdisplay [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
The status (ON | OFF) is returned to RESULT.
Examples:
getdrawingdisplay
Gets coordinates and information for an ellipse.
getellipse [POSITION stem] [ANGLES stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
ANGLES/a Gets the ellipse type and angles.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
centerx/d The horizontal center coordinate.
centery/d The vertical center coordinate.
radiusx/d The horizontal radius.
radiusy/d The vertical radius.
ANGLES stem
type/k The ellipse type: ELLIPSE | PIE | ARC.
begin/d The beginning angle.
end/d The ending angle.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
getellipse position coord
Gets coordinates and information for an EPS object.
geteps [POSITION stem] [FRAME string] [CONTENTOFFSET stem] [CONTENTSCALE stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [FILEINFO stem] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
FRAME/s Gets the frame state.
CONTENTOFFSET/a Gets the frame contents offset.
CONTENTSCALE/a Gets the frame contents scale.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
FILEINFO/a Gets the file location.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
FRAME string/s The frame state: ON | OFF.
CONTENTOFFSET stem
x/d The horizontal offset.
y/d The vertical offset.
CONTENTSCALE stem
h/d The horizontal scale.
v/d The vertical scale.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
FILEINFO stem
mode/k The file status: INTERNAL | EXTERNAL.
file/s The filepath and name.
Examples:
geteps position coord
Gets the number of the last error. Error numbers are different from the RC number, which is merely a measure of the error severity.
geterrornumber @{FG Fill}(no parameters)@{FG Text}
Results:
The number is returned to RESULT.
Examples:
geterrornumber
Gets a short explanation of the last error. This is similar to the ARexx errortext() function, except that this command gets the last PageStream ARexx error.
geterrorstring @{FG Fill}(no parameters)@{FG Text}
Results:
The message is returned to RESULT.
Examples:
geterrorstring
Gets the facing page display status.
getfacingpagedisplay [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
The facing page display status (ON|OFF) is returned to RESULT.
Examples:
getfacingpagedisplay if result='ON' then say 'Facing Pages'
Opens a file selector to get a filename and path from the user.
getfile <TITLE name> [mode] [PATH name] [FILE name] [POSBUTTON label] [NEGBUTTON label]
TITLE/s The file selector title.
mode/k The file selector type: LOAD (default) | SAVE.
PATH/s The default file path. Default=last.
FILE/s The default filename to open.
Default=last.
POSBUTTON/s The label for the positive button.
Default=Ok.
NEGBUTTON/s The label for the negative button.
Default=Cancel.
Results:
If NEGBUTTON is chosen, RC is set to 10. If POSBUTTON is chosen, RC is set to 0 and the full filepath and name are returned to RESULT.
Notes:
The file selector does not support keyboardequivalents for buttons, so do not use underscores in the button labels.
Examples:
'getfile TITLE "Save a file" save path ram: ¨ posbutton Save'
Opens a file selector to get a file path from the user.
getfilepath <TITLE name> [PATH path] [POSBUTTON label] [NEGBUTTON label]
TITLE/s The file selector title.
PATH/s The default file path. Default=last.
POSBUTTON/s The label for the positive button.
Default=Ok.
NEGBUTTON/s The label for the negative button.
Default=Cancel.
Results:
If NEGBUTTON is chosen, RC is set to 10. If POSBUTTON is chosen, RC is set to 0 and the path is returned to result.
Notes:
The file selector does not support keyboard equivalents for buttons, so do not use underscores in the button labels.
The ASL path selector is not used because it is a bad example of interface design. It does not list the files in the path---not even ghosted---so it is difficult for the user to know which path to select. Thus, the file selector is substituted and the selected file is just ignored.
Examples:
'getfilepath title "Choose a path" path ram: ¨ posbutton Choose'
Gets the names of all the added fonts.
getfontlist <stem>
stem/a Gets the font names.
Results:
the number of fonts is returned to RESULT.
stem
0/i The first font name.
1/i The second font name.
etc.
Examples:
getfontlist fontnames
Gets the names of all the styles of an added font family.
getfontstyles <family stem>
family/s The name of the font family.
stem/a Gets the family's styles.
Results:
The number of styles is returned to RESULT.
stem
0/i The first style name.
1/i The second style name.
etc.
Examples:
getfontstyles Times stylenames
Gets the greeking status for a window.
getgreeking [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
Returns the greeking status (ON|OFF) to RESULT.
Examples:
getgreeking say result
Gets the snap-to-grid settings for a master page.
getgrid <stem> [MASTERPAGE name]
stem/a Gets the grid settings.
MASTERPAGE/s The master page name. Default=current.
Results:
stem
h/d The horizontal grid spacing.
v/d The vertical grid spacing.
x/d The horizontal snap offset.
y/d The vertical snap offset.
snap/k The snap method: ALL | RANGE.
rangeh/d The horizontal range.
rangev/d The vertical range.
displayh/i The horizontal display interval.
displayv/i The vertical display interval.
displayx/d The horizontal display offset.
displayy/d The vertical display offset.
Examples:
getgrid info say info.h say info.v
Gets the grid display status.
getgriddisplay [DEPTH layer] [COLOR stem] [WINDOW name]
DEPTH/k Gets the grid depth.
COLOR/i Gets the red, green and blue components of the grid color.
WINDOW/s The window name. (Default=current)
Results:
Returns the grid display status (ON|OFF) to RESULT.
layer/k The depth: INFRONT|INBACK.
COLOR stem
red/i The red component.
green/i The green component.
blue/i The blue component.
Examples:
getgriddisplay depth layer if result='ON' then say 'Grid is shown '||layer
Gets coordinates and information for a grid object.
getgridobject [POSITION stem] [POINTS stem] [DIVISIONS stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the bounding box coordinates.
POINTS/a Gets the coordinates of the vertices of a non-rectangular grid object (numbered counterclockwise).
DIVISIONS/a Gets the number of grid cells in each direction.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
POINTS stem
x1/d Point 1's horizontal coordinate.
y1/d Point 1's vertical coordinate.
x2/d Point 2's horizontal coordinate.
y2/d Point 2's vertical coordinate.
x3/d Point 3's horizontal coordinate.
y3/d Point 3's vertical coordinate.
x4/d Point 4's horizontal coordinate.
y4/d Point 4's vertical coordinate.
DIVISIONS stem
h/i The count of horizontal divisions.
v/i The count of vertical divisions.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
getgridobject position coord say 'Left: '||coord.left say 'Top: '||coord.top say 'Right: '||coord.right say 'Bottom: '||coord.bottom
Gets the grid snap status.
getgridsnap [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
Returns the grid snap status (ON|OFF) to RESULT.
Examples:
getgridsnap say 'Grid Snap: '||result
Gets coordinates and information for a group.
getgroup [POSITION stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [FILEINFO stem] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
FILEINFO/a Gets the file location.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
getgroup position coord say 'Left: '||coord.left say 'Top: '||coord.top say 'Right: '||coord.right say 'Bottom: '||coord.bottom
Gets the horizontal or vertical ruler guides for a master page side.
getguides <stem> <type> [MPG name]
stem/a Gets the guide info.
type/k The guide axis. Options: HORIZONTAL|VERTICAL.
MPG/s is the master page name. Default=current.
Results:
The number of guides is returned to RESULT.
stem
0/i The position of the first guide.
1/i The position of the second guide.
etc.
Examples:
getguides info vertical say 'There are '||result||' vertical guides.'
Gets the snap-to-guide settings for a master page side.
getguide <stem> [MASTERPAGE name]
stem/a Gets the guide info.
MASTERPAGE/s The master page name. Default=current.
Results:
stem
snap/k The snap method: ALL|RANGE.
rangeh/d The horizontal range.
rangev/d The vertical range.
Examples:
getguide info if info.snap='RANGE' then do say 'Snap horizontally within '||info.rangeh say 'Snap vertically within '||info.rangev end
Gets the guide display status.
getguidedisplay [DEPTH layer] [PAGE flag] [PAGECOLOR stem] [RULER flag] [RULERCOLOR stem] [WINDOW name]
DEPTH/k Gets the guide depth.
PAGE/k Gets the page guide display status.
PAGECOLOR/i Gets the red, green and blue components of the page guide color.
RULER/k Gets the ruler guide display status.
RULERCOLOR/i Gets the red, green and blue components of the ruler guide color.
WINDOW/s The window name. Default=current.
Results:
Returns the guide display status (ON|OFF) to RESULT.
If page and/or ruler guides are displayed, ON will be
returned.
DEPTH/k The depth: INFRONT |I NBACK.
PAGE/k The page guide display status: ON | OFF.
RULER/k The page guide display status: ON | OFF.
PAGECOLOR stem
red/i The red component of the color.
green/i The green component of the color.
blue/i The blue component of the color.
RULERCOLOR stem
red/i The red component of the color.
green/i The green component of the color.
blue/i The blue component of the color.
Examples:
getguidedisplay page pflag ruler rflag if result=ON then do say 'Page Guides: '||pflag say 'Ruler Guides: '||rflag end
Gets the guide snap status.
getguidesnap [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
Returns the guide snap status (ON|OFF) to RESULT.
Examples:
getguidesnap say 'Guide Snap: '||result
Gets the invisible symbol display status.
getinvisibledisplay [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
Returns the display status (ON | OFF) to RESULT.
Examples:
getinvisibledisplay say 'Invisible Symbol Display: '||result
Gets coordinates and information for a line.
getline [POSITION stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
x1/d The first endpoint's horizontal coordinate.
y1/d The first endpoint's vertical coordinate
x2/d The second endpoint's horizontal coordinate
y2/d The second endpoint's vertical coordinate.
ANGLES stem
type/k The ellipse type: ELLIPSE | PIE | ARC.
begin/d The beginning angle.
end/d The ending angle.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
getline position coord if coord.x2>coord.x1 then do temp=coord.x1 coord.x1=coord.x2 coord.x2=temp temp=coord.y1 coord.y1=coord.y2 coord.y2=temp end say 'Left Endpoint: '||coord.x1||', '||coord.y1 say 'Right Endpoint: '||coord.x2||', '||coord.y2
Gets the margin guides for a master page.
getmarginguides <stem> [MASTERPAGE name]
stem/a Gets the guide information.
MASTERPAGE/s The master page name. Default=current.
Results:
stem
inside/d The inside margin.
outside/d The outside margin.
top/d The top margin.
bottom/d The bottom margin.
Examples:
getmarginguides info say 'Inside margin: '||info.inside say 'Outside margin: '||info.outside say 'Top margin: '||info.top say 'Bottom margin: '||info.bottom
Gets the description of a master page.
getmasterpagedesc [MASTERPAGE name]
MASTERPAGE/s The master page name. Default=current.
Results:
The description is returned to RESULT.
Examples:
getmasterpagedesc
Gets the number of master pages in a document or chapter and their names.
getmasterpages <stem> [DOCUMENT name | CHAPTER name]
stem/a Gets the names of the master pages.
DOCUMENT/s The document name.
CHAPTER/s The chapter name.
Results:
The number of master pages in the document or chapter is returned to RESULT.
stem
0/i The name of the first master page.
1/i The name of the second master page.
etc.
Examples:
getmasterpages mpagenames
Gets the object ID, rotation status and the status of various flags for an object or objects.
getobject [TYPE type] [PAGENUMBER page] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [LOCK flag] [BOUNDINGBOX stem] [DOCUMENT name | WINDOW name | OBJECTID number]
TYPE/i Gets the object type.
PAGENUMBER/s Gets the full page number path.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
LOCK Gets the object lock flag state.
BOUNDINGBOX Gets the bounding box of the object(s).
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
TYPE/i The object type number:
2 Drawing
3 Group
4 Compound
5 Box
6 Line
7 Ellipse
8 Grid
9 Polygon
10 Path
11 Text Frame
12 Picture
13 EPS
14 Frameless Text
?? Multiple Select (not assigned)
ROTATION stem
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
mode/k The rotation point: POINT | CENTER.
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
LOCK/k The lock flag: ON | OFF.
BOUNDINGBOX stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
Notes:
BOUNDINGBOX: the bounding box includes the stroke thickness of objects, and is expanded to contain rotated objects.
Examples:
getobject constrain cflag print pflag say 'The proportional scale flag is '||cflag say 'The print flag is '||pflag
Gets the lock status of an object.
getobjectlock [DOCUMENT name | WINDOW name | OBJECTID number]
DOCUMENT/s The document name.
WINDOW/s The window name.
OBJECTID/i The number of the object to edit.
Results:
Returns the lock status (ON | OFF | UNKNOWN) to RESULT. Unknown means that objects with conflicting lock attributes are selected.
Notes:
All options default to the current values if not specified.
Examples:
getobjectlock window 'View.1' say 'Object lock is '||result
Gets the text frame outline display status.
getoutlinedisplay [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
Returns the outline display status (ON|OFF) to RESULT.
Examples:
getoutlinedisplay say 'Text Frame Outline Display: '||result
Gets the description of a page.
getpagedesc [PAGE number]
PAGE/s The page number. Default=current.
Results:
The description is returned to RESULT.
Examples:
getpagedesc
Gets the master page name for a page, whether its objects are shown and whether they're shown in front or in back of objects on the page itself.
getpagemasterpage [MASTERPAGE name] [SIDE name] DEPTH level] [PAGE number | DOCUMENT name | WINDOW name]
MASTERPAGE/s Gets the master page name.
SIDE/k Gets the master page side (for double- sided pages).
DEPTH/k Gets the object depth.
PAGE The page number. Default=current.
DOCUMENT The document name.
WINDOW The window name.
Results:
Returns the master page object dislay status (ON|OFF)
to RESULT.
MASTERPAGE/s The name of the master page.
SIDE/k The master page side: LEFT|CENTER|RIGHT.
DEPTH/k The object depth: INFRONT|INBACK.
Examples:
getpagemasterpage masterpage name page 5 say 'The master page for the current page is '||name
Gets the name of a page.
getpagename [PAGE number]
PAGE/s The page number. Default=current.
Results:
The name is returned to RESULT.
Examples:
getpagename
Gets the page numbering system.
getpagenumbering <stem> [DOCUMENT name | CHAPTER name | WINDOW name]
stem Gets the page numbering system.
DOCUMENT/s The document name.
CHAPTER/s The chapter name.
WINDOW/s The window name.
Results:
stem
startmode/k The page numbering system: AUTOMATIC | AUTOEVEN | AUTOODD | CUSTOM.
start/i The starting page number.
lengthmode/k The page length mode: AUTOMATIC|CUSTOM.
length/i The number of pages.
masterpage/s The name of the master page to use for blank pages.
format/k The page numbering format: DEFAULT | LONG | ARABIC | ROMANUPPER | ROMANLOWER | ALPHAUPPER | ALPHALOWER.
language The page numbering language:
DEFAULT Document/chapter default.
AMERICAN American English.
ENGLISH International English.
FRANCAIS French.
DEUTSCH German.
prefix The page number prefix: string.
Examples:
getpagenumbering info
Gets coordinates and information for a path.
getpath [POSITION stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
getpath position coord say 'Left: '||coord.left say 'Top: '||coord.top say 'Right: '||coord.right say 'Bottom: '||coord.bottom
Gets coordinates and information for a picture.
getpicture [POSITION stem] [FRAME string] [CONTENTOFFSET stem] [CONTENTSCALE stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [FILEINFO stem] [DPI stem] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
FRAME/s Gets the frame state.
CONTENTOFFSET/a Gets the frame contents offset.
CONTENTSCALE/a Gets the frame contents scale.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
FILEINFO/a Gets the file location.
DPI Gets the resolution.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
FRAME string/s The frame state: ON | OFF.
CONTENTOFFSET stem
x/d The horizontal offset.
y/d The vertical offset.
CONTENTSCALE stem
h/d The horizontal scale.
v/d The vertical scale.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
FILEINFO stem
mode/k The file status: INTERNAL | EXTERNAL.
file/s The filepath and name.
DPI stem
x/i The horizontal resolution
y/i The vertical resolution
Examples:
getpicture position coord say 'Left: '||coord.left say 'Top: '||coord.top say 'Right: '||coord.right say 'Bottom: '||coord.bottom
Gets the picture display status.
getpicturedisplay [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
Returns the display status (ON|OFF) to RESULT.
Examples:
getpicturedisplay say 'Picure Display: '||result
Gets coordinates and information for a polygon.
getpolygon [POSITION stem] [SHAPE stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
SHAPE/a Gets the polygon shape, sides and angles.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
centerx/d The horizontal center coordinate.
centery/d The vertical center coordinate.
radiusx/d The horizontal radius.
radiusy/d The vertical radius.
SHAPE stem
type/k The shape: NORMAL | STAR | PUFFY | SCALLOP | WAVY.
sides/i The number of sides.
offsetangle/d The pre-rotation angle.
deflection/d The alternate point radius.
deflectionangle/d The alternate point angle.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
getpolygon position coord say 'Horizontal Center: '||coord.centerx say 'Vertical Center: '||coord.centery
Gets the name of PageStream's ARexx port.
getportname (no parameters)
Results:
The name is returned to RESULT.
Examples:
getportname
Gets the type of action that can be redone.
getredo [DOCUMENT name | WINDOW name]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Results:
Returns the type of action that can be redone to RESULT. For example, if the movement of an object had just been undone, it would return "Move".
Examples:
getredo say "Can redo "||result
Gets the refresh mode of a window.
getrefreshmode [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
Returns the refresh mode (ON|OFF|WAIT) to RESULT.
Examples:
getrefreshmode window 'View.1' say 'Refresh Mode: '||result
Opens a small dialog box to instruct the user to click on the page to return a coordinate value to the script. The requester has a Cancel button.
getregion <stem> [MESSAGE message]
stem/a Gets the coordinates of the region.
MESSAGE/s The message to display in the dialog box.
Max length=55.
Results:
If Cancel is chosen, it sets RC to 10. If the user clicks on the page or draws a region, it sets RC to 0 and returns the coordinates to the stem variable.
stem
x1/d The start horizontal coordinate.
y1/d The start vertical coordinate.
x2/d The end horizontal coordinate.
y2/d The end vertical coordinate.
Examples:
'getregion coord message "Drag to define an area"' button=RC if RC=0 then do say coord.x1 say coord.y1 say coord.x2 say coord.y2 end
Gets the rotation (slant and twist) of an object.
getrotation <stem> [DOCUMENT name | WINDOW name | OBJECTID number]
stem/a Gets the rotation values.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
stem
slant/d The slant angle.
twist/d The twist angle.
Examples:
getrotation amount say 'Slant: '||amount.slant say 'Twist: '||amount.twist
Gets the ruler display status.
getrulerdisplay [OFFSET stem] [ZERO stem] [MSYS stem] [DIRECTION stem] [WINDOW name]
OFFSET/a Gets the ruler offset in pixels from the top left corner of the window.
ZERO/a Gets the ruler zero point.
MSYS/a Gets the rulers' measurement systems.
DIRECTION/a Gets the rulers' directions.
WINDOW/s The window name. Default=current.
Results:
Returns the ruler display status (ON | OFF) to RESULT.
OFFSET stem
x/i The horizontal display offset.
y/i The vertical display offset.
ZERO stem
x/d The horizontal zero offset.
y/d The vertical zero offset.
MSYS stem
h/k The horizontal ruler measurement system: INCHES | CENTIMETERS | MILLIMETERS | PICAS | POINTS | PRINTERPICAS | PRINTERPOINTS | CICEROS | DIDOTPOINTS | FEET | METERS | SAMEAS.
v/k The vertical ruler measurement system.
Same as above.
DIRECTION stem
h/k The horizontal measurement direction: LEFT | RIGHT.
v/k The vertical measurement direction: UP | DOWN.
Examples:
getrulerdisplay msys system say 'The rulers are '||result say 'Horizontal measurement system: '||system.h say 'Vertical measurement system: '||system.v
Gets the ID's of all selected objects, as well as their bounding box.
getselectedobjects [IDLIST stem] [BOUNDINGBOX stem] [DOCUMENT name | WINDOW name | OBJECTID number]
IDLIST/a Gets the ID's of each selected object.
BOUNDINGBOX/a Gets the bounding box of the selected objects.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object count is returned to RESULT.
IDLIST stem
0/i The ID of the first selected object.
1/i The ID of the second selected object.
etc.
BOUNDINGBOX stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
Notes:
The bounding box includes the stroke thickness of objects, and is expanded to contain rotated objects.
Examples:
getselectedobjects boundingbox coord say 'Left: '||coord.left say 'Top: '||coord.top say 'Right: '||coord.right say 'Bottom: '||coord.bottom
Gets the number of columns in a frame, and the gutter space between them.
gettextframe [COLUMNS number] [GUTTER space] [DOCUMENT name | WINDOW name | OBJECTID number]
COLUMNS/i Gets the number of columns in the frame.
GUTTER/d Gets the space between columns.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
Returns the object's text frame status (ON | OFF) to RESULT.
COLUMNS/i The number of columns.
GUTTER/d The space between the columns.
Examples:
gettextframe columns count gutter space if result='ON' then say ¨'Columns: 'count', Gutter: 'space
Gets coordinates and information for a frameless text object.
gettextobj [POSITION stem] [ROTATION stem] [ABOUT stem] [CONSTRAIN string] [PRINT string] [DOCUMENT name | WINDOW name | OBJECTID number]
POSITION/a Gets the coordinates.
ROTATION/a Gets the rotation.
ABOUT/a Gets the rotation point.
CONSTRAIN/s Gets the proportional scale flag state.
PRINT/s Gets the print flag state.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
The object ID is returned to RESULT.
POSITION stem
left/d The left coordinate.
top/d The top coordinate.
right/d The right coordinate.
bottom/d The bottom coordinate.
ROTATION stem
mode/k The rotation point: POINT | CENTER.
slant/d The slant angle.
twist/d The twist angle.
ABOUT stem
x/d The point's horizontal coordinate.
y/d The point's vertical coordinate.
CONSTRAIN string/k The constrain flag: ON | OFF.
PRINT string/k The print flag: ON | OFF.
Examples:
gettextobj position coord say 'Left: '||coord.left say 'Top: '||coord.top say 'Right: '||coord.right say 'Bottom: '||coord.bottom
Gets the text wrap status of an object.
gettextwrap [REGION mode] [WRAP type] [STANDOFF stem] [DOCUMENT name | WINDOW name | OBJECTID number]
REGION/k Gets the wrap mode.
WRAP/k Gets the wrap type.
STANDOFF/a Gets the text offset from the object.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The object number. Default=current.
Results:
REGION/k The wrap mode: SHAPE | BOUNDINGBOX | FENCE.
WRAP/k The wrap type: NOWRAP | WRAPLEFT | WRAPRIGHT | WRAPJUMP | WRAPAROUND | WRAPINSIDE.
STANDOFF stem
x/d The horizontal offset.
y/d The vertical offset.
Examples:
gettextwrap region mode wrap type standoff offset if mode~='NOWRAP' then say 'Text will '||type||' by '||offset.x||¨' horizontally, and '||offset.y||' vertically.'
Gets the display resolution of the current screen.
getscreendpi <stem>
stem/a Gets the display dpi.
Results:
x/i The horizontal display dpi.
y/i The vertical display dpi.
Examples:
getscreendpi rez say rez.x say rez.y
Gets the name of the public screen on which PageStream is open.
getscreenname (no parameters)
Results:
The name is returned to RESULT.
Examples:
getscreenname
Opens a dialog box with one text string control into which the user can type a string, and two buttons for exit button.
getstring [STRING default] [TITLE label] [POSBUTTON label] [NEGBUTTON label]
STRING/s The default string for the text control.
Default=blank.
TITLE/s The label for the text string control.
Max length=8. Default=blank.
POSBUTTON/s The label for the positive button.
Default=Ok.
NEGBUTTON/s The label for the negative button.
Default=Cancel.
Results:
If NEGBUTTON is chosen, RC is set to 10. If POSBUTTON is chosen, RC is set to 0 and returns the string to RESULT.
Notes:
Precede the character to underscore as a bound keyboard equivalent in the label name. For example, "_Done" would make "D"the keyboard shortcut for the "Done" button.
Examples:
'getstring string "Erase this." title "_Text" ¨posbutton "_Yes" negbutton "_No"' userstring=RESULT button=RC
Gets the text frame link display status.
gettextlinkdisplay [WINDOW name]
WINDOW/s The window name. Default=current.
Results:
Returns the text link display status (ON|OFF) to RESULT.
Examples:
gettextlinkdisplay say 'Text Frame Link Display: '||result
Gets the type of action that can be undone.
getundo [DOCUMENT name | WINDOW name]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Results:
Returns the type of action that can be undone to RESULT. For example, if an object had just been rotated, it would return "Rotate".
Examples:
getundo say "Can undo "||result
Gets the size and position of a document window.
getwindowpos [AT stem] [SIZE stem] [WINDOW name]
AT/a Gets the window position.
SIZE/a Gets the window size in pixels.
WINDOW/s The window name. Default=current.
Results:
AT stem
x/i The horizontal window position.
y/i The vertical window position.
SIZE stem
w/i The window width.
h/i The window height.
Examples:
getwindowpos at coords size coords say 'Left: '||coords.x say 'Top: '||coords.y say 'Width: '||coords.w say 'Height: '||coords.h
Gets the names of the open view windows for a document.
getwindows<stem> [DOCUMENT name]
stem/a Gets the view names.
DOCUMENT/s The document name. Default=current.
Results:
The number of open windows is returned to RESULT.
stem
0/i The name of the first view.
1/i The name of the second view.
etc.
Examples:
getwindows winnames
Changes the text greeking status.
greeking <status> [WINDOW name]
status/k The greeking status. Options: ON | OFF | TOGGLE.
WINDOW/s The window name. Default=current.
Examples:
greeking off
Groups selected objects into a logical group.
group [POSITION left top right bottom] [ROTATE angle | SKEW slantangle twistangle | SLANT angle | TWIST angle] [ABOUT pointx pointy | ABOUTCENTER] [constraint] [printable] [stack] [DOCUMENT name | WINDOW name]
POSITION/d The coordinates of the object.
Default=current bounding box.
ROTATE/d The rotation angle. Default=0.
SKEW/d The slant and twist angle.
Default=0.
SLANT/d The slant angle. Default=0.
TWIST/d The twist angle. Default=0.
ABOUT/d The rotation point.
ABOUTCENTER Rotates around its center. Default.
constraint/k The aspect ratio constraint toggle.
Options: CONSTRAIN |F REE (default). printable/k The print object toggle.
Options: PRINT (default) | NOPRINT. stack/k The stack position.
Options: INFRONT| I NBACK | BEST (default). Best creates at the optimum stack level.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Results:
The identification number (handle) of the new object is returned to RESULT.
Examples:
group group inback group 1 1 5.23 6.24 document 'project.doc''