Adobe ®

PageMaker 7.0 ®

Script Guide.PDF
© 2001Adobe Systems Incorporated and its licensors. All rights reserved.
PageMaker 7.0 Script Language Guide for Windows and Macintosh

This manual, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. The content of this
manual is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Sys-
tems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in this book.

Except as permitted by such license, no part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechan-
ical, recording, or otherwise, without the prior written permission of Adobe Systems Incorporated.

Adobe, the Adobe logo, and Adobe PageMaker are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Apple,
Macintosh, and Mac OS are trademarks of Apple Computer, Inc., registered in the U.S. and other countries. Microsoft, Windows, and Windows NT are registered trademarks of
Microsoft Corporation in the U.S. and/or other countries. All other trademarks are the property of their respective owners.

Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA
 3

PageMaker Script Language Guide

How to use this reference What's in a command or query

Welcome to the PageMaker Script Language description
Guide. This guide will help you write PageMaker The description of each command and query
scripts. generally includes:
New to scripting? Read the topics in the Scripting • Syntax
section of this guide:
• A list of parameters (if any) and the values each
Introduction to scripting and the script language accepts
Working with variables
• Special notes about the command or query
Writing and running scripts
• An example
Working with other scripting applications
• A list of any related commands or queries.
Command and query reference. The remainder
of this guide describes each command and query in See also:
the PageMaker script language.
Documentation and language conventions

See also:
What's in a command or query description
Documentation and language conventions
 4

Introduction to scripting and the

script language
Documentation and language What are scripts?
conventions Scripts contain text-based commands, queries,
The descriptions of each command and query and controls that automate actions you can
use the following conventions: perform in PageMaker. Commands and queries
are part of the Adobe PageMaker script
Example of con- Description language, and are similar to the PageMaker
vention
menu commands. You don't need programming
Open, MultiplePaste Script-language commands and experience to understand basic scripting. A solid
queries appear in uppercase and working knowledge of PageMaker is the key.
lowercase.
Scripts are the ideal way to automate repetitive
cCopyWhat Command parameters appear as a
word (or words merged together) tasks in PageMaker. For example, a script might
preceded by a lowercase letter. Com- automate the following tasks:
mand parameters usually corre-
spond to dialog-box options. The let- • Defining standard master pages, styles, and
ter before the word indicates the colors
data type of the parameter (see
Parameter types). • Placing ruler guides
[bFacingPages] Optional parameters appear inside • Importing a logo
square brackets.
The following is a script that tells PageMaker to
[bProp[, bBestSize]] Conditionally optional parameters create a new 12-page publication with a page size
appear in nested brackets. The outer
parameters are optional only when of 9 inches by 11 inches, set margins, make the
the inner parameters are not needed. pages double-sided, and then save the
In this example, bProp is optional document:
only if you don't specify bBestSize; if
you want to specify bBestSize, you new 12
must specify bProp.
pagesize 9i, 12i
none or 0 The values or keywords that you type pagemarg ins 1i, .75i, .75i, .75i
as parameters appear in bold. pageoptions 1, 1
nNumOfColors(, Parameters that repeat are enclosed s ave a s " S a m p l e D o c u m e n t "
sColorName)... in either parenthesis (if required) or re tu r n
square brackets (if optional), and are
nNumOfStyles[, followed by an ellipsis.
sStyleName]...

See also:
See also: What is the script language?
Parameter types Script language components defined
 ADOBE PAGEMAKER 7.0 5
Introduction to scripting and the script language

What is the script language? If you want to write the same sort of script for a
publication that does not start on page 1, you
In the PageMaker scripting language, a command
can have the Page command calculate the publi-
is a single word that tells PageMaker what to do.
cation’s last page by using an expression in place
For example, your script may tell PageMaker to
of a single value or variable. An expression is a
open a new publication, import and place a
simple algebraic formula such as:
specific story, and style the text. Parameters are
values that control the action of the command. page (NumOfPages + Star tPage - 1)

In addition to commands and parameters, the

In this example, 1 is subtracted from the total of
PageMaker scripting language has the capability
NumOfPages and StartPage because pages are
to store values as variables. A variable is a word
numbered starting at one, not at zero. The part
that can be used in place of the value it stores.
of the expression that determines how to
For example, a variable such as NumOfPages
combine the variable is called an operator. In the
could be assigned the value of 10 and then be
above example, there are two operators: the
used in multiple instances in a script, as follows:
addition and subtraction symbols.
NumOfPages = 10
The PageMaker scripting language also supports a
new NumOfPages
common programming language capability
page NumOfPages
referred to as a function. A function modifies the
way a command sees the value of a parameter
This script assigns the value of 10 to be equal to
(whether it is in the form of a single value, a
the variable name NumOfPages, creates a new
variable name, or an expression) without changing
publication with 10 pages, and then goes to page
the value itself. The following is an example of a
10.
command that uses a function and an expression
Queries request information from PageMaker. to specify a value:
For example, a query can ask for the location of
textenter quote(NumOfPages + Star tPage - 1)
an element on the page, the attributes of a style,
or the number of stories in a publication. A
Because the TextEnter command requires quotes
query is always followed by a set of two greater-
around the string of text to be entered, the Quote()
than symbols (>>) which point to a variable
function is used to add quotes around the value
name for each returned parameter value. For
determined by the expression. It only adds them in
example:
for single use, leaving the value unmodified in
new 40 other places in a script.
g etp a g es >> Nu mOfPa g es
Controls tell PageMaker which script commands to
page NumOfPages
send under a given set of conditions. By using
controls, you can set up a script to repeat a series of
In this example, the script tells PageMaker to
commands or to execute a series of commands
open the very last page of a publication that
only if a variable has a specific value. Examples of
starts on page 1. The GetPages query asks
commonly used controls are If, Loop, Repeat, and
PageMaker for the number of pages in the
Else statements.
current publication—in this case 40—which the
script specifies to put in the NumOfPages
variable. Then the Page command uses that
variable’s value as the NumOfPages parameter,
switching to that page.
 ADOBE PAGEMAKER 7.0 6
Introduction to scripting and the script language

Sample script • GetFillAndLine returns information about the

This sample script evaluates the page size to see fill and stroke styles of the selected object.
if it is wide or tall (landscape or portrait). If the • GetLockGuides tells you whether Lock Guides
page is wide, the script switches the dimensions is selected on the Options menu.
to make the page tall. To do this, the If control Parameter. To duplicate dialog box options or
evaluates whether the value of the width variable mouse actions, many commands and a few
is greater than the value of the height variable, queries include parameters. (Dialog boxes do
which would make for a wide page. If it is, then not appear on screen when you use commands.)
the script switches the width with the height Parameters correspond directly to the options in
through a third variable, "x," to make the page the related dialog box or to page locations or
tall. If the page is already tall, then it skips the object handles normally specified by dragging
commands to switch the values, and ends: and clicking the mouse. For example:
g etp a g esize >> w i d th, hei g ht
removepages 3, 5
if w idth > heig ht
x = w id th
In this example, RemovePages corresponds to
w idth = heig ht
the Layout > Remove Pages command. The first
heig ht = x
parameter (3) corresponds to the first page in
pagesize w idth, heig ht
the range of pages to be removed, and the
endif
second parameter (5) corresponds to the last
re tu r n
page in the range of pages to be removed. The
parameters are identical to the dialog box
options.
See also:
Menu commands that open complex dialog
What are scripts? boxes may be represented by several commands
Script language components defined in the script language. The command you use in
Working with variables a script depends on which options you want. For
Writing expressions example, four different script-language
commands represent the File > Document Setup
Using functions
menu command:
Using controls
• PageMargins
• PageNumbers
Script language components
• PageOptions
defined
• PageSize
Command. A one-word equivalent of menu,
keyboard, or mouse actions, as well as other • PrinterResol
feature-like private data. For example, the script Control. A type of command that is used to
language equivalent for the PageMaker Control control the flow of a script and thus the
Palette menu command is ControlPalette. execution of other commands, such as If, Loop,
Query. Queries ask questions about the or repeat.
PageMaker publication and use the same one- Evaluation. The result of an expression. For
word approach that commands use. Queries example, if x = 2, then the script language would
always begin with "get." For example: evaluate the expression (x + 1) as 3.
 ADOBE PAGEMAKER 7.0 7
Introduction to scripting and the script language

Variable: A flexible container for a value. See also:

Expression: A series of values combined using Parameter types
operators to calculate a single value. Documentation and language conventions
Operator: A mathematical function that Deciphering PageMaker replies to queries
combines a series of values.
Function: A special command that returns a
Parameter types
value based on the arguments it receives.
Just as a dialog box may include several types of
options, the command and query language also
See also: requires different types of parameters:
What is the script language?
• Numeric values
Command and query syntax
• Coordinates
Parameter types
Documentation and language conventions • Filenames
• Submenu, pop-up menu, and palette choices
• Text
Command and query syntax
In the command and query descriptions, each
The order in which you specify parameter values
parameter name includes a lowercase prefix. The
for a command or query is listed on the top line
prefix indicates the type of value you can use or
of the description with the command or query
that PageMaker will return. The remainder of
name. You must specify parameter values in this
the name identifies the dialog box option,
order for PageMaker to correctly interpret the
mouse action, object handle, and so forth, to
command.
which the parameter relates. For example:
For example, the syntax for the RemovePages
ex p or t fFilename, sFor mat[, bTag s]
command is:
removepages nFirstPage, nLastPage The following table defines each parameter
prefix and notes acceptable values:
The nFirstPage parameter corresponds to the
Remove Pages option in the Remove Pages
dialog box. The nLastPage corresponds to the
Through option.

Prefix Type Description Example

b boolean Values are: true, on, 1 and false, off , 0. Boolean parameters represent check rulers on
boxes and options that you can turn on and off (such as the display of rul-
ers, guides, or palettes).

c choice Values are keywords or their equivalent integers as indicated in the param- linestyle thindash
eter descriptions (for example, none or 0, center or 2). Choice parameters
represent radio buttons, submenu, or pop-up selections. or

Note: Do not enclose keywords in quotation marks. linestyle 13

d decimal Values are decimal numbers, generally accepted to one decimal point (for size 13.5
example, 6.2). Decimal values specify point size, leading, page size, and so
forth.
 ADOBE PAGEMAKER 7.0 8
Introduction to scripting and the script language

Prefix Type Description Example

f filename Values are a filename. The filename must appear in quotation marks. For relink "MyDisk:Newslet-
best results, include the full path with the filename. Filenames are used ter:Art:Chart.eps"
with commands that refer to a file (such as, Place, Relink, or Open).
or
Note: For filenames in scripts intended for both the Macintosh and Win-
dows, avoid upper-ASCII characters (character number 128 and up). relink "c:\News-
Although the first 128 characters are identical in the character sets used by ltr\Art\Chart.eps"
Windows and the Macintosh, the upper-ASCII characters are not. This can
cause a problem if the character on one platform maps to a character that
is illegal for filenames on another.

n number Values are integers. Integers are used for page numbers, columns, new new 5
pages, and so forth.

s string Values are text. The text must be in quotation marks (for example, "Blue- font "Zapf Dingbats"
green"). String parameters are used for entering text, page-number pre-
fixes, and variable palette and submenu options, such as fonts, dictionar-
ies, export filters, master pages, styles, and colors.

Where the string represents a variable palette, pop-up, or submenu option,

you must capitalize, spell, and punctuate the option name exactly as it
appears on screen.

Note: To include a quotation mark within the text, precede the quotation
mark with a backslash, such as "\"Scripting is fun\" said the script writer."
The quotation mark is the only character that requires special treatment.

Note for scripts intended for both the Macintosh and Windows: While
you can enclose strings in either typographer's (curly) or straight quotation
marks, we recommend that you use straight quotation marks if your script
is to be dual-platform.

x x-coordi- Values are coordinates. You can specify coordinates as either numeric loca- move lefttop, (2p5, 3p5)
nate tions (or offsets) or references to a guide, column edge, or the edge of the
y last object drawn. Coordinates identify a location on the page, an offset, or or
y-coordi- a relative position. (For details, see Coordinates.)
nate move lefttop,(rightpage col-
Note for numeric coordinates: You generally specify numeric coordi- umn 2,left,column top)
nates relative to the zero point. To ensure you know the location of the zero
point, set it with either the ZeroPoint or ZeroPointReset commands. You
specify the coordinates using the current measurement system or by
including the appropriate measurement identifier with the coordinate
(such as 3p6 for 3 picas, 6 points). See Specifying the measurement system.

See also: About PMScript

Documentation and language conventions PMScript is a background application that reads
Deciphering PageMaker replies to queries your scripts and executes their instructions.
What is the script language? When you double-click on a script, PageMaker
Writing expressions launches PMScript. Any PageMaker feature
commands are executed by PageMaker itself; the
remaining elements of the Pagemaker script
language, whether they are commands, controls,
functions, operators, or variables, are handled
exclusively by PMScript.
 ADOBE PAGEMAKER 7.0 9
Introduction to scripting and the script language

In addition to PMScript, there is another Deciphering PageMaker replies

background application called PMTrace that is
to queries
used in place of PMScript when you choose the
Trace command from the Scripts palette menu. When you send a query to PageMaker, it returns
PMTrace allows you to follow the progress of a information as a string of numbers or words,
script line by line for troubleshooting purposes. separated by commas. This information is
known as a reply. Depending on the query, a
The script-executing operations carried out by reply may be short or long. For example, the
PMScript and PMTrace happen automatically. If GetRoundedCorners query asks PageMaker to
you have trouble running scripts, be sure these identify the corner style of the selected object.
special applications are located in PageMaker’s PageMaker responds with a single value that
Plug-ins folder and that you have enough RAM identifies the style specified in the "Rounded
available to launch them. corners" dialog box.
On the other hand, replies can be complex. For
See also: example, the GetRuleAbove query asks
What is the script language? PageMaker to identify the settings for all the
Working with variables attributes in the "Paragraph rules" dialog box
Using functions pertaining to rules above paragraphs.
Using controls PageMaker replies with a string of values, the
order of which is shown in the "Reply" section of
the query description:
Dialog boxes, error messages, b O n O f f , c L i n e S t yle , s L i n e Color, c L i n e Wi d t h ,
and alerts xLeftIndent, xRig htIndent, dWeig ht, bOpaque

When a script is running, PageMaker dialog

The parameter names listed correspond to the
boxes, error messages, and alerts do not appear
dialog box options.
on the screen. This is especially important to
note in commands that PageMaker normally lets To decipher the reply, match the values that
you cancel, such as deleting pages with the PageMaker returns with the values listed in the
Layout > Remove Pages option or closing a query description. For example, let's say
publication. In a script, alert messages do not PageMaker returns these values:
appear on screen, so you have no opportunity to
1,1,"Blue-g re en",1,0,0,0,0
cancel commands. However, you can write
scripts in such a way that they invoke dialog
Match the return values with the table in the
boxes in order to present or to get information
GetRuleAbove description to decipher the
from the user.
PageMaker reply:
You cannot undo Script commands.
Returned Parameter Meaning

1 bOnOff Rule Above Paragraph

option is checked (or "on").

1 cLineStyle The rule is a hairline.

"Blue-green" sLineColor The color is Blue-green.

1 cLineWidth The rule is the width of the

text.
 ADOBE PAGEMAKER 7.0 10
Introduction to scripting and the script language

Returned Parameter Meaning Specifying the measurement system:

Individual parameters
0 xLeftIndent There is no left indent.
To override the default measurement system for
0 xRightIndent There is no right indent. a parameter, simply include a measurement
0 dWeight The stroke weight is not abbreviation with the measurement or
custom (a standard weight coordinate value. For example, if the publication
was specified, as noted in
measurement system is picas, PageMaker
the cLineStyle parameter).
assumes the "7" in:
0 bOpaque The background is transpar-
ent. m ove b ot tom , 7

means 7 picas. To specify inches instead of picas,

See also: enter this in your script:
Documentation and language conventions
m ove b ot tom , 7 i
Parameter types
The "i" tells PageMaker to move the object to a
location 7 inches from the vertical-ruler zero
Specifying the measurement point. Once that parameter value is processed,
system PageMaker interprets values using picas again.
Several commands and queries require measure-
The following table lists the measurement
ments or ruler coordinates as parameter values.
abbreviations you can use to override the default
When interpreting the values you specify or
measurement system:
when returning query results, PageMaker uses
the publication default measurement system (set System Abbreviation Example
in the Preferences dialog box) unless you specify Inches i after 5.625i
another system.
Millimeters m after 25m
Using the script language, you can:
Picas p after 18p
• Specify a system for an individual parameter,
Points p before p6
leaving the publication default measurement
system intact for the rest of the script. This Picas and points p between 18p6
technique is useful if you don't know (or don't Ciceros c after 5c
want to alter) the publication measurement
system. See Specifying the measurement system:
Note: Do not insert a space between the
Individual parameters.
measurement and the abbreviation.
• Specify a new default measurement system for
the publication (or, if no publications are open,
See also:
for all future publications). This technique is
useful if you want to use a particular Specifying the measurement system
measurement system for all commands and Specifying the measurement system: Publication
queries. See Specifying the measurement system: default
Publication default.
 ADOBE PAGEMAKER 7.0 11
Introduction to scripting and the script language

Specifying the measurement system: Coordinates

Publication default
For some commands and queries, you must use
To change the measurement system for the coordinates to specify locations on the page.
publication, use the MeasureUnits command. You can specify coordinates either:
The new measurement system becomes the
• Using numeric values (specified relative to the
default and remains in effect after the script has
run. PageMaker uses the default measurement rulers' zero point), for example:
system when interpreting measurements and m ove b ot tom , 7 i
coordinates in commands (unless overridden
with a measurement abbreviation) and when • Relative to page elements, such as columns,
returning measurements and coordinates from guides, and objects, for example:
queries. move bottom, column bottom
Note: If no publication is open when you use the
MeasureUnits command, the new measurement See also:
system becomes the application default and applies
Setting the rulers' zero point
to all new publications.
Using numeric coordinates
The MeasureUnits command syntax is: Specifying locations by page elements
measureunits cMeasurement, cVer tical,
dCustomPoints
Setting the rulers' zero point
The cMeasurement parameter specifies the The default position of the zero point is at the
measurement system for PageMaker to use. In upper left corner of single pages and the upper
the following example, the cMeasurement touching corner of two-page spreads, as shown in
parameter in the first line changes the the following illustration.
measurement system to inches, and thus
PageMaker interprets the "7" in the second line
(for the Move command) as 7 inches from the
zero point of the vertical ruler:
measureunits inches, custom, 12
--cMeasurement value
- - s p e c i fi e s " i n ch e s "
The zero point is moveable and is often not in its
move bo tto m, 7
default position. It's a good idea to explicitly set the
--PageMaker inter prets this
zero point location to ensure that PageMaker
--and all subsequent
places objects and guides where you want them
- - co o rd i n a tes a s in ches.
and to ensure that you understand the locations
returned in query results.

See also:
Specifying the measurement system
Specifying the measurement system: Individual
parameters
 ADOBE PAGEMAKER 7.0 12
Introduction to scripting and the script language

To position the zero point, use the ZeroPoint or Note: Although PageMaker lets you specify a
ZeroPointReset command. separate measurement system for the vertical ruler,
all coordinates and measurements use the
measurement system set in the Measurements In
See also:
option (or with the cMeasurement parameter of the
Coordinates MeasureUnits command). For example, even if the
Using numeric coordinates vertical ruler is set to inches, PageMaker interprets
Specifying locations by page elements any vertical coordinates or measurements using the
default measurement system (which may not be
inches). You can override the default system by
Using numeric coordinates including an abbreviation for the desired system with
Numeric coordinates represent locations in the parameter value; see Specifying the measurement
relation to the PageMaker rulers. Using numeric system.
coordinates lets you specify a precise location
for an object. See also:
Coordinate values can be either negative or Coordinates
positive numbers. Unlike standard coordinates, Setting the rulers' zero point
PageMaker uses positive numbers to express Specifying locations by page elements
vertical locations below the zero point. Vertical
locations above the zero point are expressed as
negative numbers. Horizontal locations match Specifying locations by page
standard coordinates: Locations right of the
elements
zero point are positive and left of the zero point
are negative. You can specify coordinates in relation to elements
on the page. When you specify locations by page
elements, the locations remain valid even after you
move the rulers' zero point, move an object, or
change the publication page size or orientation.
To use this method, you refer to a column guide or
object by the internal number PageMaker assigns it
The following examples specify parameters when it is first placed, typed, or drawn on the page.
using the numeric method:
• Columns are numbered from left to right on the
Precise coordinate Action specified page. You specify "leftpage" or
"rightpage" (as shown in the table below) only
move top, 6i Positions the selected object so its
top edge is 6 inches below the zero
when the publication has facing pages.
point. • Guides are numbered in the order in which they
guidevert 4.25i Creates a vertical ruler guide 4.25 were placed on the page, regardless of their
inches to the right of the zero point. positions on the page. The first guide drawn is
deletevert 4.25i Deletes the vertical guide that is number one. If you delete a guide, PageMaker
located 4.25 inches to the right of renumbers the remaining guides.
the zero point.
 ADOBE PAGEMAKER 7.0 13
Introduction to scripting and the script language

• Objects (text blocks and graphics) are numbered Examples:

in the order in which they were first typed or Command Action
drawn, regardless of position. The first object
placed on the page is number one. Using the move left, guide 1 Positions the left edge of the
selected object on the first guide
BringToFront, BringForward, SendBackward, or drawn on the page.
SendToBack commands changes its drawing order.
deletevert guide 3 Deletes the third vertical ruler guide
If you delete an object, PageMaker renumbers the
placed on the page (regardless of its
remaining objects. location).
The following table shows how to specify coordi- select (rightpage Selects the object that is on the right
nates relative to columns, guides, and objects: column 2 left, page, where the left side of the sec-
guide 2) ond column meets with second hor-
Location x-coordinates y-coordinates izontal guide placed on the page.

Columns column n left column top

column n right column bottom See also:

rightpage column n left Coordinates
Using numeric coordinates
leftpage column n left

rightpage column n right

leftpage column n right

Working with variables
Guides guide n guide n
Variables let you store values in your scripts,
adding a level of intelligence to an otherwise linear
Objects last left last top set of instructions. Variables can contain a single
last right last bottom value or a list of values.

Note that: Writing variables

• "n" in the column and guide references repre- The name of a variable can be a single letter similar
sents the column or guide number. to those commonly used in algebraic formulas,
such as n, I, x, y, or z. These letters are often used in
• "last" in the object descriptions refers to the edge
scripting to represent a number that controls
of the last object drawn (the object with the highest
either a repeat loop or a distance measurement. A
drawing order).
variable name can also be a word that describes the
• If you do not specify a location, PageMaker uses value it represents, such as pagenumber, pubname,
the right page by default. or filedirectory. Many times, the most logical name
for a variable is the name of the parameter from
which it gets its value, such as NumOfPages,
Width, Height, or ParaStyle. Use the following
guidelines when writing variables:
• Write each variable name as a single word
beginning with a letter and with no spaces.
• Use either uppercase or lowercase letters, but use
them consistently.
 ADOBE PAGEMAKER 7.0 14
Introduction to scripting and the script language

• Use a unique name for a variable: it cannot be the • Parse down the values in the list by taking them
same as any command or function supported by in series using the Set command. For example: Set
the PageMaker scripting language. VariableName >> Variable1, Variable2, Variable3,
VariableName. The following script uses the
GetFontList command to see if a font is available in
Assigning variables
a computer system before using it in a script. The
You can assign a value to a variable in a number of repeat loop uses the Set command to parse
ways. The simplest way is to simply set the variable through the variable fontlist for a match with
name equal to the value, as in X = 5. Palatino. The ellipses are placeholder variables.
Another common way to assign a variable is to use getfontlist >> NumOfFonts, fontlist
it with a query command. In this way, the value or loop x = 1, NumOfFonts
values replied by the query are assigned to a list of set fontlist >> font name, ..., ..., ..., fontlist
variables in the order in which they are listed, as in if font name = "Palatino"
this example: getpagesize >> X, Y. For a letter-size s e t s e a rch > > f ou n d
page, this command would set the variable X equal endif
to 8.5, and the variable Y equal to 11. end lo op
if search = found
A variable can also store a list of values, separated
message "Palatino av ailable in cur rent system."
with commas, such as: X = 5, 7, 9. The values listed
else
are stored in the same order in which they are
m e s s a ge " Pa la t i n o n ot av a i la b le . "
assigned, so that you can retrieve them later.
endif
You can also assign a list of values to a single re tu r n
variable. For example:
g e tob j e c t l i s t > > nu m , o b j e c t s i n f o Search the list for a specific value using # or ?
(Includes) operators. The Includes operator
Num represents a value for the number of objects simplifies a process that would otherwise take
currently visible; objectsinfo represents a list of all several lines of instruction. The following script
other information returned by the query. performs the same function as the previous script,
but uses the Includes operator to write a single
expression.
Parsing variable lists
getfontlist >> NumOfFonts, fontlist -- acquire
When you want to work with a single value from a
font list
list, do one of the following:
if "Palatino" # fontlist > 0
• Follow the variable name with a number or message "Palatino av ailable in cur rent system."
expression in parentheses, with no space. The else
following example sets a list of values to the m e s s a ge " Pa la t i n o n ot av a i la b le . "
variable EvenNumbers, and then uses the fifth endif
value to go to a page: re tu r n
EvenNumbers = 2, 4, 6, 8, 10, 12, 14, 16
pageEvenNumbers(5) The Includes operator is used by first listing the
value to search for before the # mark and then the
variable to search within after. The expression’s
calculated result will be the number of the value’s
position in the value list being searched for, or
equal to zero if no occurrence is found.
 ADOBE PAGEMAKER 7.0 15
Introduction to scripting and the script language

Indexed variables Writing expressions

By placing a value (a number or string) in brackets Whenever a parameter or variable is called for in a
after a variable name (variablename[x]) you can script, you can instead use an expression that can be
create different variable "containers" without calculated to a single value. In this way, you can use
having to create additional variable names. fewer variables with more possible results, without
With an indexed variable, a script can create having to create separate scripts just to calculate
variables to meet whatever it’s value storing needs special values. Writing expressions is just like
require, particularly when you can’t predict those writing mathematical formulas. The symbols, or
needs in advance. This is useful, for example, if you commands to calculate a value with another value,
are looping through every publication in a book are called operators.
list and want to get its page numbering options, The following rules outline the use of operators to
then you want to apply those values in another create expressions. If PageMaker returns a syntax
repeating loop. error or your script creates unexpected results, it
The following example demonstrates indexed could be due to an inappropriately used operator.
variables: • Each expression can have as many variables,
a = "red", "blue", "g re en" values, and operators as needed, but must always
b = "cyan", "magenta", "yellow", "black" have a single solution.
y = 1 • You can freely use spaces and parentheses,
loop x = 1,3 modifying the order of precedence for calcula-
colors[x,y]=a(x) tions.
end l o op
• Text string values must always be enclosed in
y =2
quotation marks and can only be added, divided,
loop x=1,4
and multiplied with other strings.
colors[x,y]=b(x)
end l o op • Multiplied string values must contain the values
textenter colors[1,1] in the first operator and be enclosed in paren-
textenter colors[1,2] theses.
• An expression can be used in place of any single
Results: value.
textenter "red" PageMaker’s scripting language supports the
textenter "cyan" following operators:

See also: Special operators

Writing expressions • = (assigns a value)
Using functions • # (checks to see if a value includes a value; called
Using controls the Includes operator)
• : (accompanies a value with comments)
• , (separates a list of values)
• ...(a null or "throw away" variable. Must be three
periods, not an ellipsis character)
 ADOBE PAGEMAKER 7.0 16
Introduction to scripting and the script language

Mathematical operators See also:

• + (add) Parameter types
• - (subtract) Working with variables

• * (multiply)
• / (divide) Using functions
The function of these four basic math operators is When you are working with commands and
obvious when being used with numeric values. expressions, you may want to use a value that may
When strings of text are involved, however, things not be in the proper form. You can use a function
get a bit more complicated. You can use paren- to coerce, or change, a value into another form. To
theses and spaces to help break up lengthy calcula- use a function, you first type the function name
tions and to modify the order of precedence for and then, directly next to it—without a space and
calculations. When multiple string values are within parentheses—the name of the variable or
expressed with an addition symbol, PageMaker value to apply to it. You can use a function with any
will concatenate them together, as in the following command or expression that uses a value; you can
example: even use a function within a function.
X = "o n e" + "two " + "three" The following rules outline the use of functions. If
PageMaker returns a syntax error or your script
Result: creates unexpected results, it could be due to an
inappropriately used function
X = " o n e t wo t h re e "
• Write each function name as a single word,
followed directly by the variable or value to be
Percent sign (Mod) operator
affected in parentheses. Don’t use any spaces.
% (percent sign)
• Use appropriate values specified in the function.
This special operator, which works only with
• You can use a function with any appropriate
number values, divides the first value by the
value, in any type of expression or command.
second and returns the remainder. For example:
• Functions only affect the single use of a variable
X = 22 % 7
value; they do not change the value itself for other
Y = 21 % 7
instances in a script.

Result: The PageMaker Scripting language supports the

following functions:
X = 1
Y = 0 Empty() function: evaluates whether a variable
contains a value or is void of content. When used,
it will equal a Boolean value of false if the specified
Less Than and Greater Than Operators variable evaluated contains data, or true if the
• < (less than) variable has no assigned value, as in the following
• > (greater than) example:

These operators compare which of two given a,b = 42 - - a i s a s s i g n e d 4 2 , b i s le f t e m p t y

values are greater. The results are always in Boolean x = empty(a) -- value will be 0
values of true or false (1 or 0). y = empty(b) -- value will be 1
 ADOBE PAGEMAKER 7.0 17
Introduction to scripting and the script language

Not() function: reverses the value of a Boolean a = "42"

condition. This makes the value 1, or true, when a b = val(a)
variable or expression is 0, or false. When a variable
or expression is not true, the function equals 0, as Result
in the following examples:
b = 42
if n o t(x = 42)
message "Value is not 42" List() and Unlist() functions: put quotes around,
end if or remove quotes from, each item in a list of values
within a single variable. For example:
Result
a = 11, 19, 52
x = 0 b = li s t ( a )
y = n o t(x)
Result
IsNumber() function: determines if a value is a
b = "11", "19", "52"
number, which is useful when you need to make
sure that a value is legal before using it with a
ToUpper() and ToLower() functions: change the
command that requires a numerical value, as in the
case of a string value to be all uppercase or all
following example:
lowercase. For example:
x = i snu mber (36)
a = "PageMaker"
y = i snu mber (thir t y six)
b = toupper(a)

Result:
Result
x = 1
b = " PAG E M AK E R "

Len() function: counts the number of values in a

SubStr() function: selects a subset, or portion, of a
value list. For example:
string value. For example:
a = 2, "two", 4, "four", 6, "six", 8, "eig ht"
a = "PageMaker"
x = len(a)
b = subst r(a,2,3)

Result:
Result
x = 8
b = "age"

Quote() and Unquote() functions: puts quotes

SpecialCharacter() or ^() function: used to enter
around, or removes quotes from, an expression.
PageMaker’s special typesetting characters.
Allows you to put quotes around a variable, as in
the following example:
a = 42
textenter quote(a)

Str() and Val() functions: Str() turns a value into a

string, and Val() turns a string into a value. For
example:
 ADOBE PAGEMAKER 7.0 18
Introduction to scripting and the script language

Path() function: translates file directory paths Rand() function: returns a pseudo-random
between the Windows DOS syntax, which number between two given values. For example:
separates each level of its path with a backslash (\),
a = rand(1, 42)
and the Macintosh syntax, which uses a colon.
Used for cross-platform scripts that use path
Possible result
names. The following example will be translated to
the correct format regardless of the platform that is a = 11.1952
being used:
Sin() and Cos() functions: calculate either the sine
a = " Pro j e c t \ Pu b s \ C h a p ter 1 "
or cosine value, in degrees, for a given value of
open path(a)
angle. For example:
Abs() function: gets the absolute value of a a = sin(36)
number, resulting in a positive value whether it is a
positive or a negative. For example: Result
a = a bs(- 42) a = 0.587785

Result Arctan() function: calculates the arc tangent value,

in degrees, for a given value. For example:
a = 42
a = a rc t a n ( 3 6 )
Trunc() function: truncates a decimal number (or
a string with a period) to its whole value. For Result
example: a = 88.408864
a = t r u n c(11. 11)
Exp(), Log(), and Sqrt() functions: calculate the
Result exponential, logarithm, or square root value for a
given value. For example:
a = 11
a = sqrt(25)
Zstrip() function: strips any trailing zeros from a
fractional value. For example: Result
a = zst r i p (11. 1100) a = 5

Result See also:

a = 11. 11 Writing expressions

Max() and Min() functions: return the largest or

smallest number in a list of values. For example:
a = ma x(11, 19, 5)

Result
a = 19
 ADOBE PAGEMAKER 7.0 19
Introduction to scripting and the script language

Using controls message "The page is tall."

endif
Controls add a level of intelligence to your scripts
and allow you to automate the production of
almost any PageMaker project. PageMaker’s Nesting If controls
scripting language provides several different if width = 8.5
logical control statements common to other if heig ht = 11
programming languages. These controls give you message "This is a letter size page."
the ability to evaluate an expression and act endif
accordingly on the result. endif

A control is used just like a command by writing its

name first, followed by a space and any parameters Loop and EndLoop: repeats a series of instruc-
and expressions. Many controls require an ending tions. The Loop control requires the expression of
counterpart to define the set of instructions they a variable equal to a list of two numerical values for
control, such as EndIf, EndLoop, EndWhile, or the beginning and ending, for example X = 1, 100.
Until. The control will step from the first value to the
If and EndIf: gives you the ability to say "if the
second value in single, whole-number increments.
value of this variable is x, then do y." The If control
works by evaluating an expression and, if it equals Example
true, executes any commands that follow it until an loop x = 1, 100
EndIf control is reached. If the expression is found textenter quote(x) + ", "
to be false, then the script skips to the EndIf end lo op
control.
Repeat Until: loops a series of instructions
Example dependent upon the evaluation of a condition with
if w idth > heig ht the Until control, such as until x = 100.
x = w id th
endif Example
x = 0
Else and ElseIf: The Else control is used within an rep e a t
If control to direct the script to a set of instructions x = x + 1
to carry out when the evaluation equals false. This textenter quote(x) + ", "
is useful when you want an alternate set of instruc- until x = 100
tions carried out when an expression is false
(considering that the instructions that follow an While and EndWhile: acts in the same way as the
EndIf are always carried out, whether or not the Repeat Until controls, except that it evaluates the
result is true or false.) expression at the beginning and will skip the
instructions it encloses if the expression is false
Example (while the Repeat Until controls will execute their
if w idth > heig ht instruction at least once, even if the expression
message "The page is w i de." evaluated with Until is false).
el sei f w i d th = heig ht
message "The page is square."
else
 ADOBE PAGEMAKER 7.0 20
Introduction to scripting and the script language

Example textenter quote(x)

x = 0 break x = 100

while x < 100 textenter ", "

textenter quote(x) + ", " until x = 100

endw hile
Goto and Label: skip from one point in a script to
Switch, CaseOf, Default, Endswitch: evaluate a another. By using a value or expression with the
single variable for a series of values. The Switch Goto control, PageMaker will immediately search
control is accompanied by a variable, which is the whole script to find a Label with a matching
evaluated by each of the subsequently listed value and continue executing instructions from
CaseOf controls. If the CaseOf value matches the that point.
Switch value, then the commands that follow are
all executed to the Endswitch control (ignoring any Example
additional CaseOf or Default controls). To stop a i f " He lve t i c a " # f o n t l i s t
CaseOf from executing all the way to the f o n t " He lve t i c a "
Endswitch, you can use the Break control to exit goto done
the Switch and immediately jump to the endif
Endswitch. If none of the CaseOf values match the i f " He lve t i c a - Na r row " # f o n t l i s t
Switch value, you can use the optional Default m e s s a ge " Su b s t i t u t i n g He lve t i c a - Na r row f or
control to execute instructions instead. He lve t i c a "
f o n t " He lve t i c a - Na r row "
Example goto done

getpagenumber >> pagenum, ... endif

sw itch pagenum message "Default font being used instead of

caseof -3 m i s s i n g He lve t i c a "

message "The cur rent page is a left-hand master label done

page." new

break
caseof -4 Try command: executes a command that might
message "The cur rent page is a r i g ht-hand return an error, without interrupting the execution
master page." of the rest of your script. When the command that
break follows a Try command fails, PMScript simply
default ignores it and continues on.
message "This is not a master page.
endsw itch
Example
Break: escapes from any Repeat Until, While, or t r y f o n t " He lve t i c a "
Loop controls. See above example for using Break
with the Switch control. ErrorChecking command: toggles scripts on and
off when encountering errors generated by
Example PageMaker (not PMScript). This is similar to using
x = 0 a Try command on every line of your script, except
rep e a t that if one of the commands fails, all the subse-
x = x + 1 quent commands are ignored.
 ADOBE PAGEMAKER 7.0 21
Introduction to scripting and the script language

Example 2 Use a carriage return to separate the command

er rorchecking off or query and its parameters from the next
font "Cour ier" command or query. For example:
f o n t " He lve t i c a " s e le c t ( r i g h t p a ge colu m n 2 le f t , gu i d e 2 )
er rorchecking on dele te

Message Command: Displays a message in a 3 Use commas to separate parameters from one
dialog box. Can also be used to display the results another. For example:
of a query. See above for other examples of the
resize r i g httop, 3.5i, 7i, 1,1
message command.
4 Use the correct syntax. Parameter values must
Example always follow the command or query in the order
getalig nment >> my var iable specified in this guide.
message "Cur rent alig nment value is: " + 5 Don't worry about case when entering
st r(myvar iable) commands, queries, and parameter keywords.
They can contain any combination of lowercase
The Message command can be combined with the and capital letters. For example:
GetYesNo command to get information from the
Ma nualKer ning Apar tFine
user while the script is running. The GetYesNo
command replaces the "OK" button in the message
or
box with a Yes and No button..
manualker ning apar tfine

Example
or
messa g e "D o yo u wa n t to Qu it? "
g et yesn o >> my va r i a bl e M A N UA L K E R N I N G Ap a r t fi n e
if my var iable = YES
goto sig noff 6 Always match the case, as well as spelling and
endif punctuation, of submenu, pop-up menu, and
palette options, such as fonts, colors, master pages,
dictionaries, and styles. These parameters appear
See also:
in quotation marks.
About PMScript
You must capitalize, spell, and punctuate an option
Parameter types
name exactly as it appears on screen.
Writing expressions
7 Precede all comments with a double hyphen (--
Using functions
) or two backslashes (\\). Comments may be either
on a line by themselves or on the same line as a
Basic scripting rules command or query. As with commands and
queries, the carriage return marks the end of a
1 Type each command or query as one word, comment.
without spaces. For example, type "lockguides,"
not "lock guides;" type "getlinkinfo," not "get link A comment is optional text within the script that
info." describes the script's actions. (PageMaker ignores
these comments when the script runs.)
 ADOBE PAGEMAKER 7.0 22
Introduction to scripting and the script language

Both of the following examples are correct: You cannot undo PageMaker script commands.
The only way to reverse the result of running a
new 5 -- creates a new, 5-page publication
script is to choose Revert from the File menu or to
use the Revert command in a script and replace the
or
current publication with the last-saved version.
new 5 -- creates a new, 5-page publication
4 Use comments to document your script.
Include comments throughout a script to ensure
See also:
that you (and others) remember what the script
Parameter types does.
Documentation and language conventions
Deciphering PageMaker replies to queries See also:
Scripting tips
Specifying the measurement system
How publication defaults and preferences affect
Coordinates
scripts
Script language components defined
Basic scripting rules
Scripting tips
1 Prepare for varying conditions.
How publication defaults and
Keep in mind the conditions of the environment in
preferences affect scripts
which your script may run. For example, prefer-
ences may be set; document and application Be aware of the possible conditions, preferences,
defaults may vary; objects may be selected; or no and default settings in a publication and on the
publication may be open. Keep in mind that your computer, such as:
script may change application or document • Installed fonts, filters, and plug-ins
defaults, with undesirable results.
• Whether or not an object is selected
To make sure your script runs as planned, set as
• Whether or not a publication is open
many preferences and defaults within the script as
you need to control the running environment. Otherwise, under certain circumstances, your
(For example, set the zero point, specify script may not run correctly or may yield
measurement systems for parameter values, select undesirable results.
the necessary objects, open or close publications, The effect of a command or the values a query
and so forth.) returns depends on the state of PageMaker and the
2 Leave things as you found them. publication when PageMaker executes the
command or query. Here are the effects of
Before changing defaults or preferences, query
commands in each state:
their initial state, store the state in variables, and
then restore the defaults and preferences at the end No publication is open. If no publication is open,
of your script. many commands set PageMaker default values for
new publications, and many queries return the
3 Save the publication at the start, whenever
PageMaker default settings. The default settings in
possible.
existing publications are not affected.
 ADOBE PAGEMAKER 7.0 23
Introduction to scripting and the script language

Publication is open and no object is selected. If a To write a script using the Scripts palette:
publication is open and no object is selected, many 1 If the Scripts palette is not open, choose
commands set the publication defaults and many Window > Plug-in Palettes > Show Scripts.
queries return the publication defaults.
2 Choose New Script from the Scripts palette
Publication is open and an object is selected. If a menu (click the arrow on the upper right corner of
publication is open and objects are selected with the palette to display the menu).
the Select command or pointer tool, object-
3 Name the script file, select a location in the
specific commands and queries apply to those
Scripts folder, and then click OK.
selected objects.
4 Type the script commands in the New Script
Publication is open and text is selected with the
window.
text tool. If a publication is open and text is
selected with the text tool, text-specific commands
To run a script listed in the Scripts palette:
and queries apply only to those selected sections of
the text; paragraph-specific commands and 1 If the Scripts palette is not open, choose
queries apply to all the paragraphs containing the Window > Plug-in Palettes > Show Scripts.
selected text. 2 If the script acts on selected objects in the publi-
Publication is open and the insertion point is cation, select the desired objects.
within a text object. If a publication is open and 3 Double-click the script in the Scripts palette.
the insertion point is within a text object, text-
specific commands and queries apply only to the
next characters inserted; paragraph-specific See also:
commands and queries apply to the paragraph Working with other scripting applications
containing the cursor. Basic scripting rules
Scripting tips
See also: Adding scripts to the Scripts palette
Specifying the measurement system Removing scripts from the Scripts palette
Coordinates
Basic scripting rules
Adding scripts to the Scripts
palette
Writing and running scripts You can add scripts to the Scripts palette by either
You can write scripts directly in the PageMaker using the Add Script command on the Scripts
Scripts palette or in any application that can save palette menu or by copying scripts to the Scripts
the script in the text-only format. Once written, folder.
move the script into the Scripts folder so it will
appear in the Scripts palette. The Scripts folder is To add a script using the Scripts palette:
in: 1 Choose Add Script from the Scripts palette
Windows PageMaker 7.0\RSRC\<language> menu (click the arrow on the upper right corner of
\PLUGINS\SCRIPTS the palette to display the menu).
2 In the Add a Script dialog box, select a script or
Macintosh Adobe PageMaker
7.0:RSRC:Plugins:Scripts folder, and then click Open.
 ADOBE PAGEMAKER 7.0 24
Introduction to scripting and the script language

The script or folder you choose is automatically The script is now stored in the Scripts-Disabled
copied to the Scripts folder and appears in the folder in the Plug-ins folder.
Scripts palette.
To restore a script that has been removed from the
Note: In Windows, you can type a descriptive title in
Scripts palette:
the Script Title text box. The title will appear in the
palette instead of the script's filename. If you leave 1 Choose Restore Script from the Scripts palette
the Script Title blank, the palette displays the script's menu (click the arrow on the upper right corner of
filename. the palette to display the menu).
2 From the list of removed scripts, select a script
To rearrange scripts in the Scripts palette: and click Restore.
1 Open the Scripts folder, located in the following
location: See also:
Windows PageMaker 7.0\RSRC\<language>
Adding scripts to the Scripts palette
\PLUGINS\SCRIPTS
Writing and running scripts
Macintosh Adobe PageMaker
7.0:RSRC:Plugins:Scripts
2 Rearrange the order of the scripts in the folder;
Working with other scripting
that order will be reflected in the Scripts palette. applications
Because scripts written in other applications
See also: contain more than PageMaker commands and
queries, you must know the following to write a
Writing and running scripts
successful script:
Removing scripts from the Scripts palette
• The language used by the application in which
you write the script
Removing scripts from the • The method by which that application commu-
Scripts palette nicates with PageMaker
You can remove scripts from the Scripts palette. • The PageMaker script language
When you remove a script, you merely prevent it
• How to use Apple Events or Windows Dynamic
from being displayed on the palette; the script file
Data Exchange (DDE)
itself is not deleted. On the Macintosh, scripts you
remove from the palette are moved into the This guide describes only how to use Apple Events
Scripts-Disabled folder. To redisplay a script you've and DDE to communicate with PageMaker. Refer
removed from the palette, use the Restore to the documentation provided with your
command. scripting or programming application for details
on how to send Apple Events or DDE messages.
To remove a script from the Scripts palette: Note that most applications can send and receive
1 Select a script in the Scripts palette. (You can only certain Apple Events, and that PageMaker
remove only one script at a time.) recognizes only the "Do Script" and "Evaluate
2 Choose Remove Script from the Scripts palette
Script" Apple Events. Therefore, not all applica-
menu (click the arrow on the upper right corner of tions that support Apple Events can communicate
the palette to display the menu). with PageMaker. Refer to your scripting appli-
cation documentation for the necessary details.
 ADOBE PAGEMAKER 7.0 25
Introduction to scripting and the script language

See also: See also:

Using Apple Events to communicate with Page- Apple Events: Required constants
Maker Apple Events: Sending commands and queries
Using DDE to communicate with PageMaker Apple Events: Receiving a reply
Using Apple Events to communicate with Page-
Maker
Using Apple Events to
communicate with PageMaker
On the Macintosh, you can communicate directly Apple Events: Required
with PageMaker using any application that constants
supports the "Do Script" or "Evaluate Expression" To communicate with PageMaker using AESend,
Apple Events. These applications include: your script must identify these constants:
• Apple Script
Constant Description
• Frontier
kAEMiscStdSuite = 'misc' Miscellaneous standard
PageMaker does not distinguish between suite
commands and queries at the Apple Event level. kAEDoScript = 'dosc' Standard DoScript event
You can use either Do Script or Evaluate (or you can identify kAE-
Expression to send commands and queries to Evaluate below; both are
not required)
PageMaker.
kAEEvaluate = 'eval' Standard Eval event (or you
can identify kAEDoScript
See also: above; both are not
required)
Apple Events: Addressing
Apple Events: Required constants keyAEDirectParameter = ' -- --' Direct parameter of AEDe-
scriptor
Apple Events: Sending commands and queries
keyErrorNumber = 'erno' Error number returned
Apple Events: Receiving a reply from PageMaker

keyErrorString = 'errs' Error string returned from

PageMaker
Apple Events: Addressing
typeText = 'TEXT' Raw text data
You can use several methods to address Apple
Events to a specific application: typeLongInteger = 'long' Long integer

• The application signature (ADPM for

PageMaker 7.0) See also:
• The session ID Apple Events: Addressing
• The target ID Apple Events: Sending commands and queries
• The process serial number Apple Events: Receiving a reply
Using Apple Events to communicate with Page-
The approach depends on the scripting application
Maker
you're using. To learn about each, refer to your
scripting or programming application documen-
tation and Inside Macintosh, Interapplication
Communication.
 ADOBE PAGEMAKER 7.0 26
Introduction to scripting and the script language

Apple Events: Sending Apple Events: Required constants

commands and queries Apple Events: Sending commands and queries
Using Apple Events to communicate with Page-
When you send commands and queries to
Maker
PageMaker using an Apple Event, you can send
only one query per event. If you send more than
one query per event, PageMaker replies to only the
Using DDE to communicate with
last query.
PageMaker
Note: It is possible to send commands and queries to
You can communicate with PageMaker by sending
PageMaker faster than PageMaker can process them.
DDE messages directly to PageMaker from any
If that happens, events may be ignored. To avoid this
application that supports DDE commands. These
problem, always specify a kAEWaitReply in the
applications include Microsoft Excel, Microsoft
sendMode parameter of AESend.
Word for Windows, ToolBook, and Visual Basic.
For more information about kAEWaitReply, see
PageMaker recognizes and uses the following DDE
Inside Macintosh, Interapplication Communication.
messages:

Message Use
See also:
Apple Events: Addressing WM_DDE_INITIATE Use this message to begin a con-
versation. PageMaker registers
Apple Events: Required constants itself as "PageMaker" and responds
Apple Events: Receiving a reply to WM_DDE_INITIATE messages for
"PageMaker" that use any topic
Using Apple Events to communicate with Page- name (including NULL).
Maker
WM_DDE_EXECUTE Use this message to send com-
mands.

Apple Events: Receiving a reply WM_DDE_REQUEST Use this message to send queries.
Queries must use the CF_TEXT for-
PageMaker uses a reply Apple Event to provide mat.
error information and query results to the appli-
WM_DDE_DATA PageMaker uses this message to
cation sending the Apple Event. Replies may transmit its reply to the application
contain one of the following: that issued the
WM_DDE_REQUEST.
• A query reply (keyAEDirectParameter)
WM_DDE_ACK Use this message to acknowledge
• An error number (keyErrorNumber) the receipt of a command or
request.
• An error string (keyErrorString), if PageMaker
generates a string for the error code WM_DDE_TERMINATE Use this message to end a conver-
sation.
Note: If an error occurs, the reply may also contain
invalid data in keyAEDirectParameter. To verify
whether the data is valid, make sure the reply Sending queries to PageMaker using DDE
contains the keyAEDirectObject parameter and does You use WM_DDE_EXECUTE to send commands
not contain the keyErrorNumber parameter. and WM_DDE_REQUEST to send queries.
You can send only one query per message. If you
See also: send more than one, PageMaker replies only to the
Apple Events: Addressing last query.
 ADOBE PAGEMAKER 7.0 27
Introduction to scripting and the script language

Receiving replies from PageMaker To use this threading utility, you should have a
PageMaker uses WM_DDE_DATA to transmit the publication open in PageMaker with at least two
result of the query to the application that issued stories on the page.
the WM_DDE_REQUEST. Replies may contain Note: You must use HyperCard version 2.1 or later.
one of the following: Also, program linking must be active in the Sharing
• An error string, if PageMaker can generate a Setup control panel for this example to work.
string for that error code. Stack or project script. The following function is
• A query result, if the script contains a query. the stack or project script for the utility:
For more information about deciphering - - T h re a d i n g u t i li t y cou r te s y D av i d But le r
replies, see Deciphering PageMaker replies to function sendQuer y ToPM pmscr ipt
queries. g l obal PMAPP
-- put Pa geMa ker name into var iable PMAPP
See also: if PMAPP is empt y then
a n s we r p rog r a m " S e le c t Pa ge Ma ker f rom li s t o n
Working with other scripting applications
right:"
Sample scripts if it is empt y then exit sendQuer yToPM
put it into PMAPP
end if
Sample scripts re quest pmscr ipt from prog r am PMAPP
These simple examples illustrate how to send re tur n it
commands to PageMaker using a script written in end sendQuer yToPM
another application. For more samples of how to
use the PageMaker script language, see the script Button. The utility has one button named
samples in the Scripts folder (and listed in the Thread. The script for the button is:
Scripts palette).
on mouseUp
- - G e t co o rd i n a te s o f s e l e c te d tex t b l o c k
See also: -- Use co ordinates later to place text back on
Sample scripts: HyperCard or SuperCard page
p u t s e n d Q u e r yTo P M ( " g e to b j e c t l o c top l e f t " )
Sample scripts: Visual Basic for Applications
into TLCo ords
Sample scripts: Visual Basic
p u t s e n d Q u e r yTo P M ( " g e to b j e c t l o c b o t to m -
r i g ht") into BRCo ords

Sample scripts: HyperCard or

-- Hi g hlig ht and cut text from second text block
SuperCard - - S e l e c t fi r s t tex t b l o c k
The following HyperCard or SuperCard example p u t s e n d Q u e r yTo P M ( " tex te d i t ; s e l e c t a l l ;
creates a simple utility that threads (joins) the text c u t ; s e l e c t 1 ; " ) i n to rep l y
of two independent text blocks into one story and
then replaces the second text block in its original -- Get bottom cor n er of first text block
position. The utility consists of a button, which p u t s e n d Q u e r yTo P M ( " g e to b j e c t l o c b o t to m -
sends the commands and queries to select, join, r i g h t " ) i n to B C d
and replace the text, and a simple text field, where
user instructions are displayed. -- Get last char acter of first text block
 ADOBE PAGEMAKER 7.0 28
Introduction to scripting and the script language

put sendQuer yToPM("texte dit;tex tcursor Su b M AI N

+ text b l o c k ; tex t s e l e c t - ch a r " ) i n to rep l y S h e l l " C : \ P M 7 \ P M 7 . E X E " , 1 - - L a u n ch
put sendQuer y ToPM("getstor y text 0 0") into Pa ge Ma ker
rep ly ch a n n e l = D D E In i t i a te ( " Pa ge Ma ke r " , " " ) - -
Open a DDE link
- - If l a s t ch a r a c ter i s n o t a re t u r n, a d d o n e DDEExe cute channel, "new1" -- Send a scr ipt
If char acter 2 of reply is re tur n then com m a n d
put "textcursor +textblock;" into TxtSend re s u lt $ = D D E Re q u e s t $ ( ch a n n e l, " ge t p a ge s " ) - -
else Send a scr ipt quer y
put "textcursor +textblock;textenter " & quote DDETer minate channel-- Close the DDE link
& re tur n & quote & ";" into TxtSend E n d Su b
end if

See also:
- - Pa ste text a n d rep o sitio n text b loc k s
p u t " p a s te ; s e l e c t 1 ; re s i ze b o t to m r i g h t " & & B C d Using DDE to communicate with PageMaker
& ";" after TxtSend Sample scripts: Visual Basic
put "placenext;place" && TLCo ords & ";" after
TxtSend
put "resize topleft" && TLCo ords & ";" after Sample scripts: Visual Basic
TxtSend The following Visual Basic program creates a
put "resize bottomr i g ht" && BRCo ords & ";" simple utility that threads (joins) the text of two
after TxtSend independent text blocks into one story and then
put sendQuer y ToPM( TxtSend) into reply replaces the second text block in its original
end mouseUp position. The utility form consists of a button,
which sends the commands and queries to select,
Text field. The utility has one text field that join, and replace the text, and a simple text
contains the following instructions for the user: window, where user instructions are displayed and
To t h re a d t wo tex t b l o c k s , s e l e c t t h e fi r s t tex t replies from PageMaker are sent.
bl o ck a n d sen d it to the ba ck . Th e n , s e le c t t h e To use this threading utility, you should have a
second block and click Thread. publication open in PageMaker with at least two
stories on the page.
See also: Declarations. Here are the "(general)" declara-
Using Apple Events to communicate with Page- tions for the utility:
Maker
R E M T h re a d i n g u t i li t y cou r te s y D av i d But le r
REM Su broutine to ke ep utilit y on top
Declare Sub SetWindow Pos Lib "User" (ByVal
Sample scripts: Visual Basic for hWnd As In te ger, ByVal hWndInser t After As
Applications In te ger, By Val X As In te ger, By Val Y As In te ger,
You can use Visual Basic for Applications (VBA) to ByVal cx As In te ger, ByVal cy As In te ger, ByVal
write scripts in applications such as Microsoft wFlag s As In te ger)
Word, Excel, and Access. The following example,
written with Microsoft Word 6.0 for Windows, Con s t HWN D _ TO P M O S T = - 1
shows how to initiate a DDE link with PageMaker Con s t HWN D _ N OTO P M O S T = - 2
and send commands and queries. Con s t S WP _ N OAC T I VAT E = & H1 0
 ADOBE PAGEMAKER 7.0 29
Introduction to scripting and the script language

Con st S W P _ S H OW W I N D OW = & H4 0 E n d Su b

Subroutines. Here are the subroutines used by the Text field. The utility has one text field with the
utility: MultiLine property set to True. The LinkClose
procedure contains the following code:
Su b For m _ L o a d ( )
REM Make w indow stay on top of Pa geMa ker Sub Text1_LinkClose ()
S etWin d owPo s hW n d , H W N D _ TO P M O S T, 0 , 0 ,
0, 0, S W P _ N OAC TI VATE Or REM Le t Pa geMa ker finish before utilit y
S W P _ S H OW W I N D OW con t i nu e s
REM This procedure is impor tant for more
Rem Pre vent utilit y from timing out if com p l ex s c r i p t s
Pa geMa ker is not r unning D oEve n t s
Text1. L in k Timeo u t = - 1
Text1.LinkTopic = "PageMaker|DDE_LINK" E n d Su b

REM Put help message in text w indow Command button. The utility has one command
UpdateStatus button with a caption of Thread. The subroutine
for the button follows. Be careful to follow the
E n d Su b PageMaker syntax correctly (for example, inserting
a space between commands and parameters).
Su b Ru n S cr ip tCo mma n d (P M_ C m d As S t r i n g)
The sample code below sends several commands at
Text1. L in k Mo d e = 2
a time. If it becomes necessary to troubleshoot a
problem, you may want to send one command at a
REM Send either commands or quer y based on
time.
fi r s t 3 ch a r a c ter s
REM You can g roup commands, but must send Sub Command1_Click ()
quer ies one by one
REM Use Execute for commands, Re quest for REM Define a par ag r a ph (car r iage re tur n)
quer ies ch a r a c ter
Cr$ = Chr$(34) + Chr$(13) + Chr$(10) +
If Left$(LCase$(PM_Cmd), 3) = "get" Then Chr$(34)
Text1. L in k Item = P M_ C md
Text1.LinkRequest R E M G e t co o rd i n a te s o f s e l e c te d tex t b l o c k
E l se REM Use co ordinates later to place text back on
Text1.LinkExe cute PM_Cmd page
E n d If Ru n S c r i p t Co m m a n d ( " g e to b j e c t l o c top l e f t " )
TLCo ord$ = Text1.Tex t
E n d Su b Ru n S c r i p t Co m m a n d ( " g e to b j e c t l o c b o t to m -
right")
Sub UpdateStatus () BRCo ord$ = Text1.Tex t
REM Define help text to appear in text w indow
M s g $ = " To t h re a d t wo tex t b l o c k s , s e l e c t t h e REM Hi g hlig ht and cut text in second text block
first text block and send to back. " R E M T h e n s e l e c t fi r s t tex t b l o c k
M s g $ = M s g $ + " T h e n , s e l e c t t h e s e con d b l o c k RunScr iptCommand
and click Thread." ( " tex te d i t ; s e l e c t a l l ; c u t ; s e l e c t 1 ; " )
Tex t 1 . Tex t = M s g $
 ADOBE PAGEMAKER 7.0 30
Introduction to scripting and the script language

REM Get bottom cor n er of first text block Testing and troubleshooting
Ru n S c r i p t Co m m a n d ( " g e to b j e c t l o c b o t to m -
The flowchart below illustrates the most successful
r i g ht")
method for testing and troubleshooting a script:
B C d $ = Text1. Text

REM Get last char acter of first text block

RunScr iptCommand ("texte dit;tex tcursor
+ tex t b l o c k ; tex t s e l e c t - ch a r ; " ) These steps are described in detail in the following
sections:
R E M If l a s t ch a r a c ter i s n o t a re t u r n, a d d o n e
Testing scripts using PMTrace
RunScr iptCommand ("getstor y text 0 0")
Common problems
If Asc(Mid$( Text1.Text, 2)) <> 13 Then
Msg$ = "textcursor +textblock;tex tenter " & Cr$
& "; "
Testing scripts using PMTrace
E l se
Msg $ = "textcu rso r +textbl o ck ; " When you run a script, PageMaker interprets and
E n d If executes each command and query in turn. When
it encounters an error, PageMaker stops running
R E M Pa ste text a n d rep o sitio n tex t b loc k s the script at the point where the error occurred and
M s g $ = M s g $ + " p a s te ; s e l e c t 1 ; re s i ze b o t to m - displays an alert message, followed by a brief
r i g ht " + B C d $ + "; " description of the error.
M s g $ = M s g $ + " p l a cen ex t ; p l a ce " + T LCo o rd $ + To find the command causing an error in a script,
"; " you can run the script command by command,
Msg $ = Msg $ + "resize top l eft " + T LCo ord $ + using the Trace option. PageMaker displays the
"; " script text in a window and highlights each
M s g $ = M s g $ + " re s i ze b o t to m r i g h t " + command.
BRCo ord$ + ";"
To locate an error in a script:
Ru n S c r i p t Co m m a n d ( M s g $ )
1 If the Scripts palette is not open, choose
Window > Scripts.
REM Put help message back in text w indow
UpdateStatus 2 Select the script you want to error-check.
3 Choose Trace from the Scripts palette menu
E n d Su b (click the arrow on the upper right corner of the
palette to display the menu).
See also: PageMaker displays the script, highlighting the
Using DDE to communicate with PageMaker first command.
Sample scripts: Visual Basic for Applications 4 Choose Step from the Run menu once for each
command until PageMaker displays an error
message.

See also:
Testing and troubleshooting
Locating errors in other scripting applications
 ADOBE PAGEMAKER 7.0 31
Introduction to scripting and the script language

Locating errors in other scripting If you have moved the Scripts palette file or have
rearranged these folders, return them to their
applications
appropriate locations.
Scripts written in other applications should
perform their own error-checking routines. To get PageMaker needs the following files in order to use
error information from PageMaker, use the the Scripts palette:
GetLastErrorStr query; then display the error On the Macintosh: In Windows:
information in an alert box.
PMScript PMScript.exe

Script Palette.add Scriptpal.add

See also:
Testing and troubleshooting ScriptDLG

See also:
Common problems
Common problems
The following is a list of topics about common
scripting problems and some suggested solutions:
Scripts palette won't open Script not listed in palette
Script not listed in palette A script may not be listed in the Scripts palette
Script stops running before end for any of the following reasons:
Cannot stop a script • The script is not in the Scripts folder. To
Script can't select or misdraws or misplaces appear in the Scripts palette, a script must be in
Script stops when command includes filename the Scripts folder (or a folder within the Scripts
None of the scenarios match your situation folder):
Windows PageMaker 7.0\RSRC\<language>
See also: \PLUGINS\SCRIPTS
Testing and troubleshooting Macintosh Adobe PageMaker
Parameter types 7.0:RSRC:Plugins:Scripts
Basic scripting rules • The script has been removed from the Scripts
Scripting tips palette with the Remove Script option, which
prevents a script from being displayed in the
palette but leaves the script file in the Scripts
Scripts palette won't open folder.
The Scripts palette is actually a plug-in and must To view the list of removed scripts, choose
reside in the Plug-ins folder. It cannot be in Restore Script from the Scripts palette menu.
another folder within the Plug-ins folder. Double-click the name of the script you want to
PageMaker expects to find it in the following restore.
locations:
Windows PageMaker 7.0\RSRC\<language> See also:
\PLUGINS\SCRPTPAL.ADD Common problems
Macintosh Adobe PageMaker
7.0:RSRC:Plugins:Script Palette.add
 ADOBE PAGEMAKER 7.0 32
Introduction to scripting and the script language

Script stops running before end • Does the command require that an object be
selected or that text be highlighted?
PageMaker stops running a script when it
encounters an error. To find the command When you're satisfied that the details of a script
causing the error, run the script command by are correct, run it again. If it still doesn't run,
command, using the Trace option. check to see if the commands are in the correct
sequence. You may have omitted a necessary
To locate an error in a script: command or used the wrong command.
1 If the Scripts palette is not open, choose
Window > Plug-in Palettes > Show Scripts. See also:
2 Select the script you want to error-check. Common problems
3 Choose Trace from the Scripts palette menu
(click the arrow on the upper right corner of the
Cannot stop a script
palette to display the menu).
You cannot interrupt a script when it's running.
PageMaker displays the script, highlighting the
However, you can use the Revert command (or
first command.
choose File > Revert) to restore the publication
4 Choose Step from the Run menu once for to its most recently saved version.
each command until PageMaker displays an
We recommend that you use Save, SaveAs, and
error message.
MiniSave as the first command statement in the
When you have located the offending command, script. That way, Revert will return the publi-
determine why it is causing a problem: cation to its original condition if no other Save or
SaveAs commands are used in the script. (See the
• Are the command and keywords spelled
Revert command description.)
correctly?
• Are the command and keywords each one
word?
See also:
Common problems
• Are all the required parameters specified?
• If a comment is on the same line, is it preceded
by two hyphens? Script can't select or misdraws or
• Does the specified location, guide, or object misplaces
exist in this publication? If your script fails to select an object or places it
• Is the path for an imported graphic or file in the wrong location, check out these possible
complete and correct? causes:
• Are filenames and other text (such as fonts, • Has the location of the object changed since
colors, and styles) enclosed in quotation marks? you wrote the script? If you used numeric
• Are parameters that represent variable menu coordinates, you'll need to edit the script for the
options (such as fonts, colors, master pages, and new location of the object.
styles) spelled and capitalized exactly as they • Is the zero point where you expect it to be? See
appear on the menu? Setting the rulers' zero point
• Is the publication in the correct view for the
command (some commands work only in the
story editor or only in layout view)?
 ADOBE PAGEMAKER 7.0 33
Introduction to scripting and the script language

• Did you specify coordinates using the • If the file is not in the current folder but is on
PageMaker coordinate system? Remember that the same disk, precede the name with the hard
locations below the zero point are positive and disk and folder names, separating each with a
location above are negative. See Using numeric colon (for example, "Disk:Newsletter:Artwork:
coordinates. Chart.eps").
• Are your coordinates in the default measurement • On the PC, follow Windows rules to specify
units of the publication? See Specifying the the path and name of the file (for example,
measurement system. "C:\Artfiles\Newsletter\Charts\Chart.bmp").
• Are you using the correct drawing-order If you either transferred the script from one
number? Remember that sending an object to platform to another as a text file or wrote the
the back or front changes its drawing order. script in a DOS editor, the filename referenced
• Are you selecting a PageMaker object that does in the script may contain an upper-ASCII
not have a fill? To select an unfilled object, you character (character number 128 and up).
must specify a location on its line. See the Select Although the first 128 characters are identical in
command. the character sets used by DOS, Windows, and
the Macintosh, the upper-ASCII characters are
not identical. This can be a problem if the
See also: character on one platform maps to a character
Common problems that is illegal for filenames on another. Try one
of the following solutions:
• If the file was written in a DOS text editor,
Script stops when command import the script into PageMaker for Windows
includes filename using the Text-only filter and select the DOS
PageMaker looks for a file only in the current import option. Then, either run the script in
default folder unless you specify a path. (The PageMaker or export it to a new text file.
current folder is the last folder PageMaker used • If you transferred the script across platforms
when opening, placing, exporting, or saving (Macintosh to Windows, or vice versa), transfer
with File > Save As or with the SaveAs the script again within a PageMaker publication.
command.) PageMaker correctly maps the upper-ASCII
If the file is in the current default folder, make characters of transferred publications. Then,
sure you spelled the filename correctly and you can export the script to a text file or copy it
enclosed it within quotation marks. Do not into the Scripts palette edit box and save it from
include any spaces between the quotation marks there.
and the name (unless the spaces are part of the
filename). See also:
• On the Macintosh, if the file is in a folder Common problems
within the current folder, precede the filename
with a colon, the subfolder name, and another
colon (for example, ":Artwork:Chart.eps").
 ADOBE PAGEMAKER 7.0 34
Introduction to scripting and the script language

None of the scenarios match your • Adobe Technical Support. If the "Testing and
troubleshooting" section of this guide doesn't
situation
answer your questions and you need person-to-
If that's the case, back up a step and examine the person advice, our technical support representa-
logic of your script. Make sure the context in tives can answer questions about commands and
which you're using commands and queries queries. They cannot, however, evaluate the
makes sense. For example: soundness of your scripts, nor can they trouble-
• Check the state of PageMaker. Are you sending shoot for you. If you are in the United States or
a NewStory command when no publication is Canada, technical support is available directly
open? from Adobe. Outside the United States and
Canada, call your local Adobe subsidiary or
• Make sure you're using the correct command.
distributor.
Are you trying to select a text block using
SelectAll instead of TextSelect?
• Make sure the script contains all the necessary
commands. Step through the process you're
scripting manually and compare the sequence
against your script text.

See also:
Common Problems

Getting more information

The best source for scripting information is
other script writers. Check with your local
PageMaker user group. In addition, Adobe has
several online services you can access:
• The Adobe Home Page on the World Wide
Web. To open the Adobe Home Page, use the
URL http://www.adobe.com once you're on the
World Wide Web.
• E-mail at techdocs@adobe.com
You can also find more scripting-related infor-
mation in:
• Other Adobe documents. Most script commands
work just like their corresponding menu
commands.
 35

Commands

Addition sPlugInName[, sFilename] AddPrinterStyle sPrinterStyle

Runs an installed menu plug-in, such as Build Saves the current print settings as a printer style of
Booklet, from the Plug-ins submenu. the given name.

Parameter Values to enter Parameter Value

sPlugInName Name of plug-in, in quotation marks, sPrinterStyle Name of printer style to create, in quota-
exactly as it appears in menu (to a maxi- tion marks (maximum of 31 characters)
mum of 31 characters)

sFilename Exact name of file that contains plug-in, Commands that compose a printer style. To
in quotation marks (to a maximum of 31 create a printer style, set all the print options as
characters; required only if two plug-ins
have same menu name). Include path if
needed and save them using the AddPrinterStyle
the file is not in default PlugIns folder. command. The commands that set print options
saved in a style are:
Running plug-ins. A menu plug-in is a set of PrintColor
commands that combines PageMaker tasks into
one software component; a plug-in is installed on PrintDoc (range set to all pages)
the Plug-ins submenu. Once the plug-in is PrintFeature
executed using the Addition command, the plug-
in continues to run until it reaches the last PrintOptions or PrintOptionsPS
command. PrintPaperPS
Creating the ellipsis. For a Macintosh plug-in, PrintTo
press Option + ; to include the required ellipsis (...)
in the plug-in name. For a Windows plug-in, type Example. The following example sets various
three periods. print settings and saves them as the printer style
LJet Color Seps Letter.
Example. The following example executes the
pr intcolor 1, 0, 0, 1, 1, 0, "60 lpi / 300 dpi"
plug-in that vertically aligns the top and bottom
pr intdoc 1, 1, 0, 0, "", 0, 0, 0, 0, 0, 0
lines of text block handles in selected columns.
pr intoptionsps nor malimage, on, on, nor mal,
Addition Balance Co lumns off, off, on, off, off
pr intpaper ps " Le t ter " , " Pa p e r Tr ay " , - 2 , - 2 , - 2 , -
See also: 2, -2, 0, 0, -2, 0, 1000 0
pr intto "HP LaserJet IIISi PostScr ipt v52.3", "HP
The GetAdditions and GetAdditionsDir queries
L a s e r Je t I I I Si Pos t S c r i p t on L P T 1 "
addpr interst yle "LJet Color Seps Le tter"

See also:
The PrintColors, PrintDoc, PrinterStyle, PrintOp-
tions, PrintOptionsPS, PrintPaperPS, PrintTo, and
RemovePrinterStyle commands
 ADOBE PAGEMAKER 7.0 36
Commands

The GetPrintColor, GetPrintDoc, GetPrinterList, Alignment cKind

GetPrinterStyles, GetPrintFeatureTitles, GetPrint-
Specifies paragraph alignment. The extent of the
OptionsPS, GetPrintPaperPS, GetPrintPPDs, Get-
PrintPS, GetPrintScreens, and GetPrintTo queries action depends on which tool is active, whether
any text is selected, and whether a publication is
open when the command is executed.
AddWord sWord[, sLanguage] Parameter Values to enter
Adds the specified word to the user dictionary for
cKind left or 0 (zero)
spell checking and hyphenation.
center or 1
Parameter Values to enter
right or 2
sWord Word to add to user dictionary, in quota- justify or 3
tion marks (maximum 63 characters)
force or 4
sLanguage Language, in quotation marks and
exactly as it appears in Add Word to User
Dictionary list box (maximum of 15 char- Specifying default alignment. If no text is
acters) selected or the pointer tool is active, this command
"" (empty quotation marks or omit specifies the default alignment setting.
parameter entirely) to add word to dic-
tionary assigned to paragraph contain- Example. The following example right-aligns any
ing insertion point or selected with text selected paragraphs or the next text entered in the
tool publication.
alig nment r i g h t
Multiple paragraphs. If you do not specify a
language and more than one paragraph is selected,
but the paragraphs have different dictionaries See also:
assigned to them, the AddWord command adds The GetAlignment query
the word to the publication default user dictionary.
Text tool not active. In layout view, if you do not
specify a language, and a tool other than the text AppendVertices npoints, xLocation1,
tool is selected, the AddWord command adds the yLocation1[, xLocation2, ... xLocationN,
word to the publication default user dictionary. yLocationN]
Example. The following example adds the word Appends vertices to the currently selected irregular
"PageMaker" to the UK English user dictionary. polygon. For each point, both values must be
provided. The maximum number of points in an
addword "PageMaker", "UK Eng lish"
irregular polygon depends on the system's
memory. In some instances, there is a limit to the
See also: length of a command that can be sent to
The RemoveWord, Spell, and SpellWindow com- PageMaker. For example, if you send commands to
mands PageMaker through a DDE channel from a
separate application, the maximum length of a
The GetPMInfo, GetSpellResult, and GetSpell-
Window queries command is dictated by the DDE channel.

Parameter Values to Enter

nPoints Number of points to add to the polygon

 ADOBE PAGEMAKER 7.0 37
Commands

Parameter Values to Enter tions, LockLayers, MoveLayer, NewLayer, PasteR-

emembers, SelectLayer, ShowLayers, and
xLocation x coordinate for the point to add to the TargetLayer commands
polygon
The GetLayerFromID, GetLayerList, GetLayerOp-
yLocation y coordinate for the point to add to the tions, GetPasteRemembers, and GetTargetLayer
polygon queries

Example. The following example creates a

polygon using the CreatePolygon command and AttachContent [nObjectID]
then adds two points to the polygon using the
Attaches the object with an id of nObjectID to the
AppendVertices command.
selected frame if the object is specified. Attaches
createpolygon 3,1i,1i,1i,2i,2i,2i the selected object to the selected frame if no object
a p p en dver t ices 2, 3i, 3i , 3i, 2i is specified.

Parameter Values to Enter

See Also:
nObjectID Content object (optional)
The CreatePolygon, PolygonMiterLimit, Polygon-
Type, PolygonVertices, and ReversePolyVertices
Layout view only. The AttachContent command
commands
works only in layout view.
The PolygonMiterLimit, GetPolygonType, and
GetPolygonVertices queries Example. The following example attaches a
selected object to a selected frame.
attach content
AssignLayer sFromLayer, sToLayer
Assigns currently selected objects from one layer to
another layer. If sFromLayer is "" then all selected See Also:
objects are assigned to sToLayer. The BreakLinks, DeleteContent, FrameContent-
Pos, FrameInset, LinkFrames, SeparateContent,
Parameter Values to Enter and ToggleFrame commands
sFromLayer Name of the layer to take selected items The GetFrameContentPos, GetFrameInset, GetFr-
from ameContentType, GetIsFrame, and GetNext-
(or "" all layers) Frame queries

sToLayer Name of the layer to assign selected

items to
Autoflow bState
Layout view only. The AssignLayer command Sets autoflow on or off. If set on, the next text
works only in layout view. placed will flow automatically.

Example. The following example assigns all of the Parameter Values to enter
currently selected objects to the layer named bState off or 0 (zero)
"MyLayer".
on or 1
a ssig n l ayer "", "My L ayer"

See Also:
The DeleteLayer, DeleteUnusedLayers, LayerOp-
 ADOBE PAGEMAKER 7.0 38
Commands

Change default to autoflow text. By default, See also:

autoflow is off. In general, specify on to automati- The Hyphenation, NextStyle, ParaOptions, Style-
cally flow a new story or the end of an existing Begin, StyleEnd, and Tabs commands
story into available columns. Automatic text-flow
The GetBasedOn query
creates new pages when necessary.
If turned on, autoflow remains on until turned off
by another command statement or until you select BlackAttributes dBlackLimit,
the Autoflow command on the Layout menu to bOverprintTxt, dOvrprntTxtSz,
turn it off. bOvrprntLines, bOvrprntFlls
Example. The following example turns autoflow Sets the values that control the trapping and
on. automatic overprinting of "black" objects.

autoflow 1 Parameter Values to enter

dBlackLimit dontcare or -2 to leave black limit

unchanged
See also:
Percentage of black, from 0% (0.0) to
The GetAutoflow query
100% (100.0), which sets minimum
amount of black a color needs to be con-
sidered "black" for trapping and auto-
BasedOn sBasedOn overprinting (assuming the color has no
cyan, magenta, or yellow component)
Specifies the style on which the style being edited is
bOverprintTxt off or 0 (zero) to disable auto-overprint-
based.
ing of black text
Parameter Values to enter on or 1 to enable auto-overprinting of
black text
sBasedOn Name of the style on which the edited
style is based, in quotation marks and dontcare or -2 to leave state unchanged
exactly as it appears in the Based On
option in the Edit Style dialog box (to a dOvrprntTxtSz Point size below which black text is auto-
maximum of 31 characters) overprinted, from 4.0 to 650.0

dontcare or -2 to leave overprint text

Use BasedOn with StyleBegin and StyleEnd. Use limit unchanged

this command only after the StyleBegin command, bOvrprntLines off or 0 (zero) to disable auto-overprint-
which marks the beginning of a style definition ing of black lines
and specifies the name of the style being defined or on or 1 to enable auto-overprinting of
edited. Use the StyleEnd command to complete the black lines
definition. dontcare or -2 to leave state unchanged

Example. The following example defines the new bOvrprntFills off or 0 (zero) to disable auto-overprint-
style "Heading 2" (or edits an existing style by that ing of black fills
name), and specifies "Heading 1" as the style on on or 1 to enable auto-overprinting of
which it is based. It then identifies the style in the black fills
paragraphs that follow "Heading 2." dontcare or -2 to leave state unchanged

s t y l e b e g i n " He a d i n g 2 "
basedon "Heading 1" Example. The following example sets a black limit
n ex t s t y l e " Pa r a " of 90%, enables auto-overprinting of black text
styleend below 18 points, and disables auto-overprinting of
lines and fills.
 ADOBE PAGEMAKER 7.0 39
Commands

blackatt r i butes 90.0 on 18.0 off off

Parameter Values to enter

For each publication:

See also:
sPubNames Publication names, including optional
The TrapSettings command pathname to folder and disk, in quota-
The GetTrapSettings and GetBlackAttributes que- tion marks (to a maximum of 91 charac-
ters for each name and path)
ries
Clearing the book list. To remove all publications
from the book list, set nNumOfPubs to zero.
Book cAutoRenum, nNumOfPubs,
sPubNames Example. The following example specifies the
Creates the book list with the specified publication type of automatic renumbering for the book,
names and sets up automatic renumbering. specifies the number of publications in the book
list, and creates a list of the publications.
Parameter Values to enter
b ook n ex t p a ge 4 " myd i s k : my fold e r : toc " ,
cAutoRenum none or 0 (zero) "mydisk:my folder :sec1",
nextpage or 1 "mydisk:my folder :sec2",
"mydisk:my folder :sum3"
nextodd or 2

nexteven or 3
See also:
nNumOfPubs Number of publications in book list
The GetBook query

Box xLeft, yTop, xRight, yBottom

Draws a box from the top-left coordinates to the
bottom-right coordinates.

Parameter Values to enter

xLeft x coordinate of top-left corner

yTop y coordinate of top-left corner

xRight x coordinate of bottom-right corner

yBottom y coordinate of bottom-right corner

Measurement units for scripts. If you do not

specify a unit of measure (e.g., i for inches),
PageMaker uses the default unit of measure,
specified in the Preferences dialog box or with the
MeasureUnits command.
Drawing rounded rectangles. To draw a rounded
rectangle, use the Box command followed by the
RoundedCorners command.
Layout view only. The Box command works only
in layout view.
 ADOBE PAGEMAKER 7.0 40
Commands

Example. The following example draws a box A group is considered an object and has a drawing-
with the specified top-left corner coordinates (five order number like any other object. If you bring
inches, four inches) and the bottom-right corner the group forward, the objects within the group
coordinates (seven inches, six inches). retain their stacking order in relation to each other,
b ox 5 i , 4 I , 7 i , 6 i
but their drawing-order numbers each increase by
one.
Example. The following example selects the first
See also:
object drawn and brings it forward, changing its
The Line and Oval commands drawing order to two.
select 1
BreakLinks br ing for ward

Breaks the links, or threads, of the selected frames.

See also:
Layout view only. The BreakLinks command
works only in layout view. The BringToFront, Move, SendBackward, and
SendToBack commands
Example. The following example breaks the
selected frames out of their threads.
breaklinks BringToFront
Moves the selected text or graphic to the front or
See Also: top layer of the page.

The AttachContent, DeleteContent, FrameCon- Stacking order not affected. If you selected
tentPos, FrameInset, LinkFrames, SeparateCon- multiple elements, the selected objects retain their
tent, and ToggleFrame commands stacking order in relation to each other, but the
The GetFrameContentPos, GetFrameInset, GetFr- selection is brought to the front of the page ahead
ameContentType, GetIsFrame, and GetNext- of everything else.
Frame queries
Command language compared to using pointer
tool. When you move a text block or a graphic
with the pointer tool, PageMaker automatically
BringForward brings the object to the front. However, when you
Brings the selected object forward one position, move an object with the command language, you
bumping up its drawing order by one. Multiple must use BringToFront to bring objects to the
selected objects retain their stacking order in front of the page.
relation to each other.
Layout view only. The BringToFront command
Drawing order. The first object drawn on a page works only in layout view.
(or pages for facing pages) has drawing-order
Example. The following example selects the
number 1 and is the bottom-most object. The top-
bottom-most object by its drawing order (1) and
most object is the last object drawn and has the
brings it to the top layer of the page.
highest drawing-order number.
select 1
br ingtofront
 ADOBE PAGEMAKER 7.0 41
Commands

See also: Specifying smallcaps size. The size of small

The Move and SendToBack commands capitals is specified in the Type Options dialog box
(by selecting the Options button in the Type Speci-
fications dialog box) or with the TypeOptions
Cascade command.

Cascades the displayed windows of either publica- No override for Caps Lock key. You cannot use the
tions in the layout view or stories in story editor. Case command to change the case of characters
The Cascade command stacks the windows on top typed when the Caps Lock key is on.
of each other, offsetting them so that each title is Example. The following example changes the
visible. currently selected text to all caps.
Stories in current publication only. The Cascade case allcaps
command rearranges story-editor windows only
for the current publication. Stories from other
publications remain unaffected. See also:
The TypeOptions command
Example. The following example switches to the
story editor and cascades the displayed story- The GetCase and GetTypeOptions queries
editor windows of the current publication.
editstor y Change sFindWhat, sChangeTo,
cascade [cSearchRange], [bWrapAround],
[bMatchCase], [bWholeWord],
See also: [bClearAttr]
The Tile command Replaces the first occurrence of the specified text,
searching the selected range, the active story, or all
stories of the current publication. Leaves the new
Case cCase text selected.
Formats text as normal, all capitals, or small Parameter Values to enter
capitals. The extent of the action depends on which
sFindWhat Text to search for, in quotation marks.
tool is active, whether any text is selected, and
whether a publication is open when the command sChangeTo Replacement text, in quotation marks.
is executed.

Parameter Values to enter

cCase normal or 0 (zero) to leave uppercase

and lowercase letters as typed

allcaps or 1 to change all letters to full-

size capitals

smallcaps or 2 to change lowercase let-

ters to small capitals
 ADOBE PAGEMAKER 7.0 42
Commands

Change next. The Change command locates and

Parameter Values to enter
changes only one instance of the search text. You
cSearchRange selectedtext or 0 to search selected text must repeat the command, or better yet, use the
currentstory or 1 to search current story ChangeNext command, to find and change the
only, starting from position of insertion next occurrence of the search text. Use the
point (default setting)
ChangeAll command to find and change all occur-
allstories or 2 to search all stories in cur- rences of the search text.
rent publication, starting from beginning
of currently active story bWrapAround. PageMaker disregards the bWrap-
default or -1 to use default or previously Around parameter in two cases, when
defined range cSearchRange is set to either:
dontcare or -2 to let system choose
• selectedtext (or 0), where the search is confined
range based on current text selection. If
text is selected, the Change command to the selected text.
searches only selected text; if no text is
selected, it searches only the current • allstories (or 2), where the search starts at the
story, starting from position of insertion beginning of the active story and automatically
point. wraps to the beginning of the next story.
bWrapAround stopatend or 0 to stop searching when Optional parameters. PageMaker requires only
PageMaker reaches end of story
the sFindWhat and sChangeTo parameters. If you
wrap or 1 to continue searching from do not include values for the other parameters,
beginning of story when PageMaker
PageMaker uses the settings of the most recently
reaches end of story (default setting)
executed Find, Change, or ChangeAll command.
bMatchCase anycase or 0 (zero) to turn off case-sensi- (If none of these commands has been executed this
tive searching (default setting)
session, PageMaker uses the default settings—
matchcase or 1 to turn on case-sensitive noted in the parameter list above.) If you change
searching (to match capitalization of
search text exactly)
the cSearchRange using the Find, Change, or
ChangeAll commands, PageMaker resets the
bWholeWord allinstances or 0 (zero) to search for any starting position of the search.
occurrence of specified text (default set-
ting), even if text is found within another Setting text and paragraph attributes. To search
word (for example, searching for "story"
could yield "history," as well as "story")
for and replace text and paragraph attributes (e.g.,
font, type size, paragraph style), use the
wholeword or 1 to search for specified
text as a whole word only, disregarding
FindTypeAttr1, FindTypeAttr2, FindParaAttr,
occurrences where text is embedded ChangeTypeAttr1, ChangeTypeAttr2, and
within another word. ChangeParaAttr commands, followed by the
bClearAttr useattributes or 0 to use existing text Change command with bClearAttr set to useat-
and paragraph attributes (default set- tributes or 0.
ting)

clear or 1 to clear all attribute settings

(both Find and Change settings)

Story editor only. The Change command works

only in story editor.
Current publication only. Unlike the Change
dialog box, the Change command cannot search
multiple publications. It can search only the stories
in the currently active publication.
 ADOBE PAGEMAKER 7.0 43
Commands

Changing only text attributes. To change text Example. The following example selects a story,
attributes only (e.g., all 10-point, bold text to 9- inserts the insertion point into the story, and
point, Helvetica bold), use the FindTypeAttr1, switches to story editor. It then searches the
FindTypeAttr2, ChangeTypeAttr1, and current story for the word "rumba," regardless of
ChangeTypeAttr2 commands to set the desired the capitalization or attribute settings. The search
attributes. (Be sure to clear the paragraph begins at the position of the insertion point and
attributes with the FindParaAttr and wraps to the beginning of the story, if necessary. It
ChangeParaAttr commands.) Then, using the replaces the first match it finds with the word "cha-
Change command, specify an empty string for cha" and leaves the changed text selected.
both sFindWhat and sChangeTo and set
s e le c t ( colu m n 1 le f t , colu m n top ) - - s e le c t s tor y
bClearAttr to useattributes or 0. For example, to
tex te d i t - - i n s e r t i n s e r t i on p oi n t i n to b e g i n n i ng
change all 10-point, bold text in a publication to 9-
o f s e l e c te d s to r y
point, Helvetica bold, the commands are:
editstor y--sw itch to stor y editor
findt y p eatt r2 -3, -3, "Any", -3 --to clear the change "r umba", "cha-cha", cur rentstor y, w r ap,
other t y pe att r ibutes anycase, wholeword , clear
cha n g et y p ea tt r2 - 3, - 3, "Any ", - 3 - - to c le a r t h e
other t y pe att r ibutes
See also:
findpar aatt r "Any", -3, -3 --to clear the
par ag r aph att r i butes The ChangeAll, ChangeParaAttr,
changepar aatt r "Any", -3, -3 --to clear the
ChangeTypeAttr1, ChangeTypeAttr2,
ChangeWindow, Find, FindNext, FindParaAttr,
par ag r aph att r i butes
FindTypeAttr1, FindTypeAttr2, and FindWindow
fi n d t y p e a t t r 1 " Any " , 1 0 , - 3 , b o l d s t y l e , - 3 , - 3
commands
ch a n g e t y p e a t t r 1 " He lve t i c a " , 9 , - 3 , b o l d s t y l e , - 3 ,
The GetChangeParaAttr, GetChangeTypeAttr1,
-3
GetChangeTypeAttr2, GetChangeWindow, Get-
change "", "", allstor ies, stopatend, anycase,
FindParaAttr, GetFindTypeAttr1,
allinstances, useatt r i butes
GetFindTypeAttr2, and GetFindWindow queries

Searching for and changing special characters.

You enter a special character as part of your search ChangeAll sFindWhat, sChangeTo,
or replacement text using the same key combina- [cSearchRange], [bMatchCase],
tions that you type directly in the Change dialog
[bWholeWord], [bClearAttr]
box.
Replaces all occurrences of the specified text in the
Scripts palette. Do not use the Change command selected range, the active story, or all stories of the
in scripts you plan to run using the Scripts palette. current publication.
When PageMaker finds no match or completes the
search, the Scripts palette interprets this as an error Parameter Values to enter

and stops at that point in the script. sFindWhat Text to search for, in quotation marks.

Plug-ins and external scripts only. PageMaker sChangeTo Replacement text, in quotation marks.
returns the following codes to indicate the success
of the search:
 ADOBE PAGEMAKER 7.0 44
Commands

Optional parameters. PageMaker requires only

Parameter Values to enter
the sFindWhat and sChangeTo parameters. If you
cSearchRange selectedtext or 0 to search selected text do not include values for the other parameters,
currentstory or 1 to search current story PageMaker uses the settings of the last Find,
only, starting from position of insertion Change, or ChangeAll command. (If none of these
point (default setting)
commands has been executed this session,
allstories or 2 to search all stories in cur- PageMaker uses the default settings—noted in the
rent publication, starting from beginning
of currently active story parameter list above.)
default or -1 to use default or previously Setting text and paragraph attributes. To search
defined range for and replace text and paragraph attributes (e.g.,
dontcare or -2 to let system choose a font, type size, paragraph style), use the
range based on the current text selec- FindTypeAttr1, FindTypeAttr2, FindParaAttr,
tion. If text is selected, ChangeAll
searches only selected text; if no text is
ChangeTypeAttr1, ChangeTypeAttr2, and
selected, ChangeAll searches current ChangeParaAttr commands, followed by the
story only, starting from position of inser- ChangeAll command with bClearAttr set to useat-
tion point.
tributes or 0.
bMatchCase anycase or 0 (zero) to turn off case-sensi-
Changing only text attributes. To change text
tive searching (default setting)
attributes only (e.g., all 10 point, bold text to 9-
matchcase or 1 to turn on case-sensitive
searching (match capitalization of search
point, Helvetica bold), first use the FindTypeAttr1,
text exactly) FindTypeAttr2, ChangeTypeAttr1, and
ChangeTypeAttr2 commands to set the desired
bWholeWord allinstances or 0 (zero) to search for any
occurrence of specified text (default set- attributes. (Be sure to clear the paragraph
ting), even if the text is found within attributes with the FindParaAttr and
another word (for example, searching for ChangeParaAttr commands.) Then, using the
"story" could yield "history," as well as
"story")
Change command, specify an empty string for
both sFindWhat and sChangeTo and set
wholeword or 1 to search for specified
text as a whole word only, disregarding
bClearAttr to useattributes or 0. For example,
cases where text is embedded within using the case just mentioned, to change all 10-
another word point, bold text in a publication to 9-point,
bClearAttr useattributes or 0 to use existing text Helvetica bold, the commands are:
and paragraph attribute settings (default
findt y p eatt r2 -3, -3, "Any", -3 --to clear the
setting)
other t y pe att r i butes
clear or 1 to clear attribute settings (both
ch a n ge t y p e a t t r 2 - 3 , - 3 , " Any" , - 3 - - to c le a r t h e
Find and Change settings)
other t y pe att r i butes
Story editor only. The ChangeAll command findpar aatt r "Any", -3, -3 --to clear the
works only in story editor. par ag r a ph att r i butes
changepar aatt r "Any", -3, -3 --to clear the
Current publication only. Unlike the Change All
par ag r a ph att r i butes
button in the Change dialog box, the ChangeAll fi n d t y p e a t t r 1 " Any " , 1 0 , - 3 , b o l d s t y l e , - 3 , - 3
command cannot search multiple publications. ch a n g e t y p e a t t r 1 " He lve t i c a " , 9 , - 3 , b o l d s t y l e , - 3 ,
ChangeAll can search only the stories in the -3
currently active publication. change "", "", allstor ies, stopatend, anycase,
allinstances, useatt r i butes
 ADOBE PAGEMAKER 7.0 45
Commands

Searching for and changing special characters. • The Font submenu or pop-up menu
You enter a special character as part of your search
• The Plug-ins submenu
or replacement text using the same key combina-
tions that you type to enter the character directly Use this command when you have changed,
into the Change dialog box. deleted, or added font metric files, fonts, or plug-
ins during this session with PageMaker.
Scripts palette. Do not use the ChangeAll
command in scripts you plan to run using the Parameter Values to enter
Scripts palette. When PageMaker finds no match cEnvChange fontmetrics or 1 to force PageMaker to
or completes the search, the Scripts palette inter- reload font-metric information
prets this as an error and stops at that point in the installedfonts or 2 to force PageMaker
script. to rebuild the font list for Font submenu
(and pop-up menu)
Plug-ins and external scripts only. PageMaker
plugins or 4 to force PageMaker to
returns the following codes to indicate the success
rebuild the Plug-ins submenu
of the search:
Example. The following example selects a story, Keyword use and order optional. You can include
inserts the insertion point into the story, and one or all of the keywords and place them in any
switches to story editor. It then replaces all order. See the example below.
instances of the word "rumba," regardless of the
Example . The following example forces
capitalization or attribute settings, with "cha-cha."
PageMaker to rebuild the font list for the Font
It searches only the currently active story.
submenu (and pop-up menu) and to rebuild the
sel ect (co l u mn 1 l eft, co l u mn top ) - - s e le c t s tor y Plug-ins submenu.
texted i t- - i n ser t in ser t io n p o in t into b e g i n n i n g
changeenv installedfonts plug ins
o f s e l e c te d s to r y
editstor y--sw itch to stor y editor
changeall "r umba", "cha-cha", cur rentstor y,
anycase, wholeword , clear
ChangeNext
Searches for the next instance of the Find What text
specified in the last Change, ChangeAll, or Find
See also:
command and replaces it with the Change To text
The Change, ChangeParaAttr, ChangeTypeAttr1, specified in the last Change or ChangeAll
ChangeTypeAttr2, ChangeWindow, Find, FindN- commands, using all the same settings. Leaves the
ext, FindParaAttr, FindTypeAttr1, FindTypeAttr2, new text selected.
and FindWindow commands
The GetChangeParaAttr, GetChangeTypeAttr1, Story editor only. The ChangeNext command
GetChangeTypeAttr2, GetChangeWindow, Get- works only in story editor.
FindParaAttr, GetFindTypeAttr1, Current publication only. The ChangeNext
GetFindTypeAttr2, and GetFindWindow queries command cannot search multiple publications. It
can search only the stories in the currently active
publication.
ChangeEnv cEnvChange
Repeat as often as needed. You can send this
Depending upon the parameters, rebuilds one or
command repeatedly until PageMaker finishes
all of the following:
searching the range specified by the previous Find,
• The font metrics information (for example, kern Change, or ChangeAll command.
pairs or track-kerning information)
 ADOBE PAGEMAKER 7.0 46
Commands

Last executed Change, ChangeAll, or Find wins. Scripts palette. Do not use the ChangeNext
As in the Find and Change dialog boxes, the Find, command in scripts you plan to run using the
Change, and ChangeAll commands share the Find Scripts palette. When PageMaker finds no match
What and Change To text, as well as the settings for or completes the search, the Scripts palette inter-
the search options, range, and attributes. (Note: prets this as an error and stops at that point in the
You must know all the current settings before you script.
use the ChangeNext and FindNext commands. If
Plug-ins and external scripts only. PageMaker
you insert a Find command between the Change
returns the following codes to indicate the success
and ChangeNext commands, the Find search-text,
of the search:
options, range, and attributes become the search
text and settings used by ChangeNext, while the Example. The following example switches to story
replacement text and attributes remain active from editor. It searches the current story for the word
the last Change or ChangeNext command.) For "rumba," regardless of the capitalization or
example: attribute settings and replaces the first match it
finds with the word "cha-cha." The search begins at
fi n d t y p ea tt r1 "Any ", 10, - 3,
the position of the insertion point and wraps to the
boldstyle+underline, -3, -3
beginning of the story if necessary. The
ch a n g e t y p e a t t r 1 " He lve t i c a " , 9 , - 3 , b o l d s t y l e , - 3 ,
ChangeNext command then replaces the next
-3
instance of "rumba," using the same search criteria
change "Note", "Tip", allstor ies, 1, matchcase,
and starting the search from the end of the last
wholeword , useatt r ibutes
encountered "rumba."
changenext--changes next instance of a bold
u n d erl in ed editstor y--sw itch to stor y editor
- - " No te " to b o l d , He lve t i c a 9 - p o i n t " Ti p : " change "r umba", "cha-cha", cur rentstor y, w r ap,
find "See also", cur rentstor y, stopatend, anycase, anycase, wholeword , clear
a l l in sta n ces, cl ea r changenext
changenext--searches only from inser t ion point
to end of stor y,
See also:
--changes next instance of "See also" to "Tip",
- - reg a rd l ess o f a tt r ibu tes
The Change, ChangeAll, ChangeParaAttr,
ChangeTypeAttr1, ChangeTypeAttr2,
The first ChangeNext command searches for the
ChangeWindow, Find, FindNext, FindParaAttr,
next instance of a 10-point, bold, underlined, FindTypeAttr1, FindTypeAttr2, and FindWindow
whole-word "Note" and replaces it with a 9-point, commands
Helvetica, bold word "Tip." The search begins at The GetChangeParaAttr, GetChangeTypeAttr1,
the position of the insertion point and wraps to the GetChangeTypeAttr2, GetChangeWindow, Get-
beginning of the next story if necessary. FindParaAttr, GetFindTypeAttr1,
Because of the Find command, the second GetFindTypeAttr2, and GetFindWindow queries
ChangeNext searches for the next instance of "See
also," regardless of its capitalization or attributes.
Using the same Change To criteria, it replaces "See
also" with 9-point, Helvetica bold "Tip." The
search begins from the location of the insertion
point, but is now limited to the current story.
 ADOBE PAGEMAKER 7.0 47
Commands

ChangeParaAttr sParaStyle, Example. The following example changes all left-

cAlignment, cLeadingType aligned text in the current publication to full-
justified text. Notice that it first sets all other Find
Sets paragraph attributes (paragraph style,
and Change attributes to Any.
alignment, and leading method) to be used for the
search text in the Change and ChangeAll fi n d t y p e a t t r 1 " Any" , - 3 , - 3 , - 3 , - 3 , - 3
commands. ch a n g e t y p e a t t r 1 " Any " , - 3 , - 3 , - 3 , - 3 , - 3
fi n d t y p e a t t r 2 - 3 , - 3 , " Any" , - 3
Parameter Values to enter
ch a n g e t y p e a t t r 2 - 3 , - 3 , " Any " , - 3
sParaStyle Name of style (exactly as it appears in findpar aatt r "Any", left, -3
Styles palette), in quotation marks (to a changepar aatt r "Any", justify, -3
maximum of 31 characters)
ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s ,
"Any" (quotation marks required) for useatt r i butes
Any paragraph style (i.e., to not include
paragraph style in search criteria; default
setting)
See also:
"No style" (quotation marks required)
The Change, ChangeAll, ChangeNext,
for No Style
ChangeTypeAttr1, ChangeTypeAttr2,
cAlignment any or -3 for Any alignment (i.e., to not ChangeWindow, Find, FindNext, FindParaAttr,
include alignment in search criteria; FindTypeAttr1, FindTypeAttr2, and FindWindow
default setting)
commands
left or 0 (zero) for Left The GetChangeParaAttr, GetChangeTypeAttr1,
center or 1 for Center GetChangeTypeAttr2, GetChangeWindow, Get-
right or 2 for Right
FindParaAttr, GetFindTypeAttr1,
GetFindTypeAttr2, and GetFindWindow queries
justify or 3 for Justify

force or 4 for Force Justify

cLeadingType any or -3 for Any leading method (i.e., to

ChangeTypeAttr1 sFontName,
not include leading method in search cri- dPointSize, dLeading, cTypeStyle,
teria; default setting) cPosition, cCase
proportional or 0 (zero) for Proportional Sets the text attributes (font, point size, type style,
topofcaps or 1 for Top of Caps position, and case) to be used for the search text in
baseline or 2 for Baseline the Change and ChangeAll commands.

Parameter Values to enter

Story editor only. The ChangeParaAttr command
sFontName Name of font (exactly as it appears on
works only in story editor. Type menu), in quotation marks (to a
All attributes cleared first. The settings you maximum of 63 characters)

include with the ChangeParaAttr command "Any" (quotation marks required) for
replace all existing attribute settings. Any font (i.e., to not include font name in
search criteria; default setting)
Plug-ins and external scripts. If story editor is not
dPointSize Point size of type (from 4.0 to 650.0)
active, PageMaker returns
any or -3 for Any size (i.e., to not include
CQ_LO_INVALID_MODE and disregards the
point size in search criteria; default set-
command. ting)
 ADOBE PAGEMAKER 7.0 48
Commands

Type styles are additive. To set the cTypeStyle

Parameter Values to enter
parameter to multiple type styles, either separate
dLeading Amount of leading, in points (from 0.0 to the desired style option with the plus sign (+) or
1300.0)
add the numeric equivalents for the styles. For
any or -3 to specify Any leading example, for bold (1) and underline (4), you can
auto or -1 for automatic leading either set cTypeStyle to boldstyle+underline or to
5 (the sum of 1 and 4).
cTypeStyle any or -3 for Any (i.e., to not include type
style in search criteria; default setting) All attributes cleared first. The settings you
normalstyle or 0 for Normal include with the ChangeTypeAttr1 command
Or, any combination of the following replace all existing attribute settings.
styles, separated by the plus sign (+), or
the actual sum of their values: Any for cTypeStyle, cPosition, and cCase. Unlike
the Type Styles pop-up menu in the Change
boldstyle or 1 for Bold
Attributes dialog box, the any or -3 setting for
italicstyle or 2 for Italic cTypeStyle pertains only to the type styles Bold,
underlinestyle or 4 for Underline Italic, Underline, Strikethru, Outline, Shadow, and
strikethrustyle or 8 for Strikethru Reverse. The value of cTypeStyle does not affect
the cPosition and cCase parameters, which are
outlinestyle or 16 for Outline (Macin-
tosh only) turned off and on separately.
shadowstyle or 32 for Shadow (Macin- GetTypeStyle values doubled. If you are using the
tosh only) GetTypeStyle query in conjunction with
reversestyle or 64 for Reverse ChangeTypeAttr1, FindTypeAttr1,
GetChangeTypeAttr1, or GetFindTypeAttr1, note
cPosition any or -3 for Any position (i.e., to not
include position attribute in search crite- that the GetTypeStyle query returns different
ria; default setting) values for the type styles. With the exception of
superscript or 1 for Superscript normal, all the GetTypeStyle values are twice the
values used in the find and change commands and
subscript or 2 for Subscript
queries. For example, bold is 2 for GetTypeStyle
cCase any or -3 for Any case (i.e., to not include and 1 for ChangeTypeAttr1, FindTypeAttr1,
case attribute in search criteria; default
GetChangeTypeAttr1, and GetFindTypeAttr1.
setting)
Normal, however, is 1 in GetTypeStyle and 0 in the
allcaps or 1 for All Caps (full-size capitals)
other commands and queries.
smallcaps or 2 for Small Caps (small cap-
itals) Example. The following example changes all 10-
point, bold, underlined text in the current publi-
Story editor only. The ChangeTypeAttr1 cation to 9-point, Helvetica bold. Notice that it
command works only in story editor. first sets all other Find and Change attributes to
Any.
Plug-ins and external scripts. If story editor is not
active, PageMaker returns fi n d t y p e a t t r 2 - 3 , - 3 , " Any" , - 3
CQ_LO_INVALID_MODE and disregards the ch a n g e t y p e a t t r 2 - 3 , - 3 , " Any " , - 3
command. fi n d p a r a a t t r " Any" , - 3 , - 3
changepar aatt r "Any", -3, -3
fi n d t y p e a t t r 1 " Any" , 1 0 , - 3 ,
boldstyle+underline, -3, -3
ch a n g e t y p e a t t r 1 " He lve t i c a " , 9 , - 3 , b o l d s t y l e , - 3 ,
-3
 ADOBE PAGEMAKER 7.0 49
Commands

ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s ,

Parameter Values to enter
useatt r i butes
nTintValue Percentage of color (from 0 to 100), in
whole percentages
See also: any or -3 for Any tint amount
The Change, ChangeAll, ChangeNext,
ChangeParaAttr, ChangeTypeAttr2, ChangeWin- Story editor only. The ChangeTypeAttr2
dow, Find, FindNext, FindParaAttr, command works only in story editor.
FindTypeAttr1, FindTypeAttr2, and FindWindow
All attributes cleared first. The settings you
commands
include with the ChangeTypeAttr2 command
The GetChangeParaAttr, GetChangeTypeAttr1,
replace all existing attribute settings.
GetChangeTypeAttr2, GetChangeWindow, Get-
FindParaAttr, GetFindTypeAttr1, Plug-ins and external scripts. If story editor is not
GetFindTypeAttr2, GetFindWindow, and Get- active, PageMaker returns
TypeStyle queries CQ_LO_INVALID_MODE and disregards the
command.

ChangeTypeAttr2 dSetWidth, cTrack, Example. The following example changes all

sColorName, nTintValue purple text in the current publication to 93% tint

of Purple. Notice that it first sets all other Find and
Sets additional text attributes (set width, tracking,
Change attributes to Any.
color, and tint) to be used for the search text in the
Change and ChangeAll commands. fi n d p a r a a t t r " Any" , - 3 , - 3
changepar aatt r "Any", -3, -3
Parameter Values to enter fi n d t y p e a t t r 1 " Any" , - 3 , - 3 , - 3 , - 3 , - 3
dSetWidth Percentage to scale character width ch a n g e t y p e a t t r 1 " Any " , - 3 , - 3 , - 3 , - 3 , - 3
(from 5.0 to 250.0; normal is 100.0) fi n d t y p e a t t r 2 - 3 , - 3 , " Pu r p le " , - 3
any or -3 for Any set width (i.e., to not ch a n g e t y p e a t t r 2 - 3 , - 3 , " Pu r p l e " , 9 3
include set width settings in search crite- ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s ,
ria)
useatt r i butes
cTrack any or -3 for Any tracking (i.e., to not
include track settings in search criteria)
See also:
notrack or 0 (zero) for No Track
The Change, ChangeAll, ChangeNext,
veryloose or 1 for Very Loose
ChangeParaAttr, ChangeTypeAttr1, ChangeWin-
loose or 2 for Loose dow, Find, FindNext, FindParaAttr,
normaltrack or 3 for Normal Track FindTypeAttr1, FindTypeAttr2, and FindWindow
commands
tight or 4 for Tight
The GetChangeParaAttr, GetChangeTypeAttr1,
verytight or 5 for Very Tight GetChangeTypeAttr2, GetChangeWindow, Get-
sColorName Name of color, in quotation marks and FindParaAttr, GetFindTypeAttr1,
exactly as it appears in Colors palette (to GetFindTypeAttr2, and GetFindWindow queries
maximum of 31 characters)

"Any" (quotation marks required) for

Any color (i.e., to not include color in
search criteria)
 ADOBE PAGEMAKER 7.0 50
Commands

ChangeWindow bOpen Story editor: no clearing from dialog boxes.

Unlike Clear on the Edit menu, the Clear
Opens or closes the Change dialog box.
command does not clear text from the Find,
Parameter Values to enter Change, or Spell dialog boxes. Instead, it clears the
text selected in the current story, regardless of
bOpen close or 0 to close Change dialog box
whether one of the dialog boxes is displayed.
Example. The following example selects all
open or 1 to open Change dialog box
Story editor only. The ChangeWindow command objects on the page (or all the text in a story if a text
works only in story editor. block contains the text insertion point) and clears
them from the publication without copying them
Plug-ins and external scripts only. If story editor to the Clipboard.
is not active, PageMaker returns
CQ_LO_INVALID_MODE and disregards the selectall

command. clear

Change and Spell closed , depending on platform.

PageMaker for the Macintosh closes the Find See also:
dialog box before opening the Change dialog box. The Cut, Delete, Select, and SelectAll commands
PageMaker for Windows closes both the Find and
Spelling dialog boxes.
Example. The following example switches to story
Close [sPubName]
editor and opens the Change dialog box. Closes the specified publication without saving
changes and returns to the PageMaker window. If
editstor y
you do not specify a particular publication or all
changew indow open
the publications, PageMaker closes the currently
active publication.
See also:
Parameter Values to enter
The Change, ChangeAll, ChangeNext,
sPubName Name of publication to close, exactly as it
ChangeParaAttr, ChangeTypeAttr1,
appears on Windows menu and in quota-
ChangeTypeAttr2, Find, FindNext, FindParaAttr, tion marks (to a maximum of 63 charac-
FindTypeAttr1, FindTypeAttr2, and FindWindow ters). If you don't specify a name, Page-
commands Maker closes the currently active
publication.
The GetChangeParaAttr, GetChangeTypeAttr1,
GetChangeTypeAttr2, GetChangeWindow, Get- "all" (quotation marks required) to close
FindParaAttr, GetFindTypeAttr1, all open publications
GetFindTypeAttr2, and GetFindWindow queries
Specifying "all." If you specify the keyword "all"
while a publication titled "All" is open, PageMaker
Clear will close that publication. Otherwise, PageMaker
will close all open publications.
Deletes the currently selected graphic or text
without storing it on the Clipboard.
Objects with text wrap. When you select and clear
a graphic that has a text wrap applied to it, the
space that the graphic occupied is then filled with
the surrounding text.
 ADOBE PAGEMAKER 7.0 51
Commands

Caution: No prompt for unsaved or changed publi- CloseStory can close story editor. If the story
cation. Unlike its menu counterpart, the Close being closed is the only story open in story editor,
command does not warn you if you have not saved PageMaker switches to the previously active page
the latest changes to a publication, nor does it in layout view.
prompt you to name an unnamed publication. Use
Plug-ins and external scripts only. If story editor
the Save or SaveAs commands first if you want to
is not active, PageMaker returns
save changes to the publication or name it.
CQ_LO_INVALID_MODE and disregards the
Path okay. While not part of the name displayed command.
in the Window menu, you can include the path
Example. The following example closes the
with the name of file you want to close.
current story and activates the text icon if the story
Example. The following example saves a publi- has not already been placed.
cation as "mypub" (and copies any linked
closestor y 1
documents), and then closes the publication.
saveas "my floppy :my folder :my pub", publi-
See also:
c a t i o n , l i n ke d
close "my pub" The EditLayout, EditStory, and OpenStory com-
mand

See also:
The MiniSave, Save, and SaveAs commands Color sColorName[, nTintValue]
Applies a color to the selected text or graphics or, if
nothing is selected, to the next object drawn or
CloseStory bPlace placed.
Closes the active story in story editor.
Parameter Values to enter
Parameter Values to enter
sColorName Name of color, in quotation marks and
bPlace discard or 0 to discard story without exactly as it appears on Colors palette (to
placing it (affects unplaced stories only) a maximum of 31 characters)

place or 1 to display loaded text icon in nTintValue Percentage of color to apply to object
layout view (affects unplaced stories (from 0 to 100)
only)
dontcare or -2 to leave setting
unchanged (default)
Story editor only. The CloseStory command
works only in story editor. All palette colors are available. You can apply any
bPlace ignored for placed stories. If the story has color that appears on the Colors palette.
already been placed, PageMaker ignores the value Fill and line of PageMaker objects. Regardless of
of the bPlace parameter and simply closes the story the setting of the Fill and Line menu on the Colors
(as if you clicked the Go Away box). palette, the Color command applies a color to both
Placing story on page. If the story being closed the fill and line of objects drawn in PageMaker. If
has not been placed, PageMaker switches to the an object has a fill style of None, the Color
previously active page in layout view and displays command changes the fill style to Solid.
the loaded text gun. To place the story on the page, Example. The following example applies a 25%
use the place command. red tint to the first object drawn on the page.
select 1
color "Red", 25
 ADOBE PAGEMAKER 7.0 52
Commands

See also: Parameter Values to enter

The ColorPalette, DefineColor, and TintSelection
bAdjustLayout true Adjust page layout to new column
commands guides
The GetColor, GetColorInfo, GetColorNames, false Do not adjust page layout
GetColorPalette and GetTint queries
Measurement units for scripts. If you do not
specify a unit of measure for xGutter (e.g., i for
ColorPalette bState inches), PageMaker uses the default unit of
Displays or removes the Colors palette—a scrol- measure, specified in the Preferences dialog box or
lable window that lists the colors available for the with the MeasureUnits command.
text and graphics in the publication.
cPage defaults. If you do not specify the cPage
Parameter Values to enter parameter, PageMaker places the columns based
on how the publication was set up (with the
bState off or 0 (zero) to close the Colors palette
PageOptions command) and on the page displayed
on or 1 to display the Colors palette when the plug-in or script is run. The defaults
PageMaker uses are:
Example. The following example turns the Colors
palette on. • bothpages if the publication is set up with facing
pages
co l o r p a l ette 1
• leftpage if the publication is set up with double-
sided pages and a left page is on the pasteboard
See also:
• rightpage if the publication is set up with
The Color, PickColor, and TintSelection com- double-sided pages, and a right page is on the
mands pasteboard
The GetColor, GetColorInfo, GetColorNames,
Layout view only. The ColumnGuides command
GetColorPalette, and GetTint queries
works only in layout view.
Example. The following example creates two
ColumnGuides nColumns, xGutter[, evenly sized columns with a 0.2-inch gutter on
cPage, bAdjustLayout] each of the facing pages (specified with the
Creates evenly sized columns with the specified PageOptions command). PageMaker uses default
gutter size on the currently displayed page or values for the cPage parameter.
pages. co lumnguides 2, .2i

Parameter Values to enter

nColumns Number of columns for the pages

See also:
The DefineMasterPage, PageMargins, and
xGutter Space between columns
PageOptions command
cPage bothpages or 0 if these settings are the The GetPageOptions and GetColumnGuides que-
same for facing pages
ries
leftpage or 1 if these settings are for left-
page guides

rightpage or 2 if these settings are for

right-page guides
 ADOBE PAGEMAKER 7.0 53
Commands

ControlPalette bState Pasting outside of PageMaker for Macintosh.

PageMaker for the Macintosh cuts and copies
Displays or removes the Control palette.
selected objects to its internal clipboard, not to the
Parameter Values to enter standard Macintosh Clipboard. To paste
PageMaker objects into another application, you
bState off or 0 (zero) to close the palette
must force PageMaker to render its internal
on or 1 to display the palette
clipboard into the Macintosh Clipboard by using
dontcare or -2 to leave display state of the RenderClip command. For example, follow the
Control palette unchanged
Copy command with the RenderClip command,
specifying out or 1 for the bDirection parameter:
Example. The following example closes the
selectall
Control palette.
copy
con t ro l p a l e t te 0 renderclip out
Story editor: no copying from dialog boxes.
See also: Unlike Copy on the Edit menu, the Copy
command does not copy text from the Find,
The SuppressPalDraw command
Change, or Spell dialog boxes. Instead, it copies the
The GetControlPalette and GetSuppressPalDraw selected text in the current story, regardless of
queries
whether one of the dialog boxes is displayed.
Example. The following example selects all the
ConvertEnhMetafile objects on the page (or all the text in a story if a text
block contains the text insertion point) and copies
(Windows only) Converts the selected enhanced
them to the Clipboard.
metafile into a Windows metafile. The enhanced
metafile must be stored in the publication. selectall
copy
Example. This example selects the first object
drawn and converts it to a Windows metafile.
s e l e c t 1 - - s e l e c t s t h e fi r s t - d r aw n o b j e c t o n t h e
See also:
page The Select, SelectAll, and RenderClip commands
conve r ten h m e t a fi l e - - co nver t s t h e s e l e c te d
m e t a fi l e
CreateIndex sTitle, bReplace, bBook,
bRemove, bHiddenLayers
See also:
Creates an index.
The GetObjectList, GetObjectLoc, GetSelec-
tIDList, GetTransform, and GetLineStyle queries Parameter Values to enter

sTitle Title for index, in quotation marks (to a

maximum of 31 character
Copy "" (empty quotation marks) for no title
Copies the currently selected text or graphics to the
bReplace off or 0 to create a new index
Clipboard, from which it can be pasted elsewhere.
on or 1 to replace existing index
 ADOBE PAGEMAKER 7.0 54
Commands

Parameter Values to enter CreatePolygon nPoints, xLocation1,

yLocation1, xLocation2, yLocation2,
bBook off or 0 to include entries from only cur-
rently open publication xLocation2, yLocation2 [...,xLocationN,
on or 1 to include entries from all publi-
yLocationN]
cations in book list Creates an open, irregular polygon.
bRemove off or 0 to include all topics in index
Parameter Values to Enter
on or 1 to remove unreferenced topics
nPoints Number of points in the polygon
bHiddenLayers true include index items from hidden
For each of the points in the polygon,
layers
specify a pair of coordinates.
false do not include items from hidden
layers. xLocation x coordinate of the point

yLocation y coordinate of the point

Index without a title. To create an index without a
title, enter a pair of quotation marks with nothing
Note. A polygon has a minimum of 3 points and a
between them for sTitle ("").
maximum of 100 points.
Formatting the index. To specify the format of the
Layout view only. The CreatePolygon command
index, the IndexFormat command must precede
works only in layout view.
the CreateIndex command. If you do not specify
the format, PageMaker uses the default settings. Example. The following example draws an open,
irregular, three-sided polygon.
Placing a new index. When you create a new
index (by entering 0 as the bReplace value), createpolygon 3, 1i, 1i, 2i, 1i, 1i, 2i
PageMaker does not place the file on the page, but
displays the loaded text icon. To place the index, See Also:
follow CreateIndex with the Place command.
The PolygonMiterLimit, PolygonType, and
Example. The following example creates an index PolygonVertices commands
with no title and specifies that PageMaker replace The PolygonMiterLimit, GetPolygonType, and
the existing index, include entries from only the GetPolygonVertices queries
open publication, remove unreferenced topics and
include index items from hidden layers.
createindex "", 1, 0, 1, t r ue
CreateTOC sTitle, bReplace, bBook,
cFormat[, sBetString, bHiddenLayers]
Creates a table of contents.
See also:
The IndexFormat and Place commands Parameter Values to enter

sTitle Title of table of contents, in quotation

marks (to a maximum of 31 characters)

"" (empty quotation marks) for no title

bReplace off or 0 (zero) to create a new table of

contents

on or 1 to replace an existing table of

contents
 ADOBE PAGEMAKER 7.0 55
Commands

Parameter Values to enter See also:

The Place command
bBook off or 0 (zero) to include only currently
open publication in table of contents

on or 1 to include all publications in book

list Crop cHandle, xyLocation[, yLocation]
cFormat nonumber or 0 (zero) to omit page num-
Crops the selected imported image.
bers from table of contents
Parameter Values to enter
numberbefore or 1 to have page num-
bers appear before entry cHandle Handle to drag when cropping object:

numberafter or 2 to have page numbers Side handles:

appear after entry
left or 0
sBetString Characters to be inserted between entry
right or 2
and page number, in quotation marks (to
a maximum of seven) top or 3

bHiddenLayers true include table of contents items from bottom or 4

hidden layers
Corner handles:
false do not include table of contents
items from hidden layers. lefttop or 5

leftbottom or 6
Use sBetString only with cFormat. Use the
righttop or 7
sBetString parameter only if you specify page
rightbottom or 8
numbers with the cFormat parameter.
xyLocation x or y coordinate, relative to the current
Table of contents without a title. To create a table
zero point, to which you want the speci-
of contents without a title, enter the value for sTitle fied part dragged. If cHandle is a corner
as a pair of quotation marks with nothing between (that is, lefttop, leftbottom, righttop, or
rightbottom), both the x and y coordi-
them ("").
nates are required.
Placing a new table of contents. When you create
yLocation y coordinate, relative to the current zero
a new table of contents (by entering 0 as the point, to which you want a corner
bReplace value), PageMaker does not place it on dragged
the page, but displays the loaded text icon. To place
the new table of contents, follow CreateTOC with Measurement units for scripts. If you do not
the Place command. specify a unit of measure for xyLocation (e.g., i for
inches), PageMaker uses the default unit of
Example. The following example creates a table of
measure, specified in the Preferences dialog box or
contents, titled "Contents," which replaces an
with the MeasureUnits command.
existing table of contents, does not include book
publications, and specifies that the page number Crop single images only. The Crop command can
comes after the entry. The character between the crop only one image at a time; if more than one
entry and page number is a tab, which results in a image is selected, the plug-in or script stops
right-aligned page number preceded by leader running.
dots. The table of contents includes entries from
Crop imported images only. The Crop command
hidden layers.
can crop only imported images, not graphics
c re a te to c " Co n ten t s " 1 , 0 , 2 , " ^ t " , t r u e drawn with the Box, Line, and Oval commands or
the respective drawing tools.
 ADOBE PAGEMAKER 7.0 56
Commands

cHandle for transformed objects. (See illus- Story editor: no cutting from dialog boxes.
tration below.) If the selected object was skewed, Unlike Cut on the Edit menu, the Cut command
rotated, or reflected, cHandle should correspond does not cut text from the Find, Change, or Spell
to the handle before the object was transformed. dialog boxes. Instead, it cuts the text selected in the
For example, lefttop always refers to the original current story, regardless of whether one of the
left-top handle of an object, not to the handle that dialog boxes is displayed.
is currently the left-most top handle.
Example. The following example selects all
objects on the page (or all text in a story if a text
block contains the text insertion point) and cuts
them to the Clipboard.
selectall
Layout view only. The Crop command works cut
only in layout view.
Example. The following example selects the first
See also:
object drawn and drags the left-bottom handle to
the horizontal and vertical coordinates (four The Select, SelectAll, and RenderClip commands
inches and two inches, respectively).
select 1 DefaultPrintClrSpace
crop leftbottom 4i, 2i

See also: sColorSpace

The Select command Sets the color space for the print job.
The GetCropRect query Parameter Values to Enter

sColorSpace Color space for the print job, one of the

following values: "Gray", "CMYK", "RGB",
Cut or "CMY".
Cuts selected text or graphics to the Clipboard.
Example. The following example sets the default
Pasting outside of PageMaker for Macintosh.
color space to RGB.
PageMaker for the Macintosh cuts and copies
selected objects to its internal clipboard, not to the defaultpr intclrspace "RGB"
standard Macintosh Clipboard. To paste
PageMaker objects into another application, you
See also:
must force PageMaker to render its internal
clipboard into the Macintosh Clipboard by using The GetDefaultPrintClrSpace query
the RenderClip command. For example, follow the
Cut command with the RenderClip command,
specifying out or 1 for the bDirection parameter:
selectall
copy
renderclip out
 ADOBE PAGEMAKER 7.0 57
Commands

DefaultDir sPath DefineColor sColorName, cType,

Sets the specified path as the default folder for cModel, bOverprint, d1, d2, d3[, d4,
subsequent commands that access files. sBaseColor, [nInks (sInkName,
dInkLevel)...]]
Parameter Values to enter
Defines a new color or tint and adds it to the
sPath Path, in quotation marks, to desired disk Colors palette, or redefines an existing color.
and folders (to a maximum of 91 charac-
ters) Parameter Values to enter

sColorName Name of the new color or color being

Default folder reset. PageMaker automatically redefined, in quotation marks (to a maxi-
resets the default folder to the folder last accessed mum of 31 characters). If redefining an
when opening, placing, exporting, or saving with existing color, the name must exactly
match the name in the Colors palette.
either File > Save As or the SaveAs command.
cType spot or 0 for spot color
No trailing backslash; trailing colon optional. In
PageMaker for Windows, do not end your path process or 1 for process color
with a backslash. In PageMaker for the Macintosh, tint or 2 for tint
while you can end the path with a colon, it is not hifi or 3 for high-fidelity color (you must
required. The GetDefaultDir query returns the set cModel to multiink)
Windows path without the backslash (unless it is
cModel rgbpct or 0 for RGB color model,
the root folder, for example, c:\) and the Macintosh expressed in percentages
path with a trailing colon.
cmyk or 1 for process color model
Specified folder doesn't exist. If the default folder hls or 2 for HLS color model
specified in the sPath parameter does not exist,
multiink or 4 for multi-ink model (you
PageMaker returns to the current default folder. must set cType to hifi or 3)
Examples . The following example sets the default rgb255 or 5 for RGB color model,
path to the disk "mydisk" and the "artfiles" folder expressed in units from 0 to 255
on the Macintosh. bOverprint false or 0 to knockout objects of this
color
defaultdir "mydisk:ar tfiles"
The following example sets the default path to the true or 1 to overprint

folder "mydir" and the "mysubdir" subfolder in d1 Percentage of red if cModel equals rgb-
Windows. pct (0)

defaultdir "c:\mydir\mysubdir" Units of red if cModel equals rgb255 (5),

from 0 to 255

Percentage of cyan if cModel equals

See also: either cmyk (1) or multiink (4)

The GetDefaultDir query Degrees hue if cModel equals hls (2)

Percentage of base color for a tint

 ADOBE PAGEMAKER 7.0 58
Commands

Tints. You can base a tint only on an existing color

Parameter Values to enter
in the Colors palette. To use a color in a color
d2 Percentage of green if cModel equals library, you must first add the color to the Colors
rgbpct (0)
palette; then define the tint.
Units of green if cModel equals rgb255
(5), from 0 to 255 You can base a tint on another tint as long as the
Percentage of magenta if cModel equals logic isn't circular (for example, a slate green based
either cmyk (1) or multiink (4) on moss green which is, in turn, based on slate
Percentage of lightness if cModel equals green creates a circular definition and is not
hls (2) allowed).
0 for a tint Color name restrictions. A color name cannot
d3 Percentage of blue if cModel equals rgb- exceed 31 characters and, in English-language
pct (0) versions of PageMaker, cannot be: Process Cyan,
Units of blue if cModel equals rgb255 (5), Process Magenta, Process Yellow, Process Black,
from 0 to 255 Black, black, Registration, or registration. In non-
Percentage of yellow if cModel equals English language versions, PageMaker restricts the
either cmyk (1) or multiink (4) color names equivalent to those just mentioned.
Percentage of saturation if cModel Values truncated. Use whole percentages for d1,
equals hls (2)
d2, d3, and d4; otherwise PageMaker will truncate
0 for a tint the values.
d4 Percentage of black if cModel equals Assigning color to text or graphics. Choose the
cmyk (1) or multiink (4)
Color command when you want to assign a color
0 for a tint or if cModel equals rgbpct (0), to text or graphics. If you use DefineColor and
hls (2), or rgb255 (5)
Color together, put DefineColor first.
sBaseColor Name of base color to use for tint (when
cType is set to tint) Editing EPS colors. You cannot edit process colors
imported with an EPS image. Attempts to edit EPS
"" (empty quotation marks) if not defin-
ing a tint process colors will result in an error. You can,
however, edit spot colors imported with an EPS
nInks Number of high-fidelity ink names and
image.
percentages to follow
Example. The following example creates the color
For each high-fidelity ink:
Rose based on a 35% tint of the color Pink.
sInkName Name of ink
d e fi n e color " Ros e " , t i n t , , , 3 5 , , , , " P i n k "
dInkLevel Percentage of specified ink coverage The following example creates the process color
value between 0.0 and 100.0
Peach using the CMYK color model. Peach is
Adding a color from a color library. To add a color
composed of 15% cyan, 30% magenta, 10% yellow,
from a color library to the Colors palette, use the and no black.
PickColor command. d e fi n e color " Pe a ch " , p roce s s , C M Y K , , 1 5 , 3 0 , 1 0 , 0

Using an installable color picker. To use an

installable color picker with PageMaker, use the See also:
PickColor command. The PickColor command
HiFi colors. When you define a HiFi color, you The GetColor, GetColorInfo, and GetColorNames
must specify its CMYK values as well (which are queries
used for composite printing).
 ADOBE PAGEMAKER 7.0 59
Commands

DefineInk sInkName[, sAngle, sRuling, DefineMasterPage sMasterName,

dDefaultND] bOverwrite, bSpread, xLeftOrInside, yTop,
Defines (or redefines) the screen angle, screen xRghtOrOutsd, yBottom, nColumns,
ruling, and default neutral density value for the xGutter[, nColumnRightPage,
specified HiFi ink. xGutterRghtPg]
Parameter Values to enter
Creates or redefines the named master page,
setting the specified margins and columns. Turns
sInkName Name of HiFi ink (no tints), in quotation to the specified master.
marks (to a maximum of 31 characters). If
redefining an existing ink, the name Parameter Values to enter
must exactly match as it appears in the
Print dialog box. sMasterName Master-page name to define or redefine
(maximum of 31 characters; cannot be
sAngle Screen angle, in quotation marks, from Document Master or None)
"0.0" to "360.0"
bOverwrite false or 0 (zero) to leave existing master
"" (empty quotation marks) to leave
unchanged (if one exists with same
angle unchanged
name)
sRuling Screen ruling (frequency), in quotation true or 1 to overwrite existing master (if
marks for specified ink, from "1.0" to one exists with same name)
"500.0"
bSpread false or 0 (zero) for a one-page master
"" (empty quotation marks) to leave rul-
ing unchanged true or 1 for a two-page master spread

dDefaultND Default neutral density for ink (to 3 deci- dontcare or -2 if redefining an existing
mal places), from 0.000 to 10.000 master page (you cannot change this set-
ting when redefining)
dontcare or -2 to leave value unchanged
default or -1 to use current Document
Master setting
Example. The following example defines
HiFiGreen with a 45-degree screen angle, a screen xLeftOrInside Inside (or left) margin
ruling of 60, and a default neutral density of 0. -2 to leave margin unchanged (use only if
redefining an existing master page)
defineink "HiFiGre en", "45", "60", 0.000
-1 to use current Document Master set-
ting
See also: yTop Top margin
The DefineColor, InkND, and PrintInk com- -2 to leave margin unchanged (use only if
mands redefining an existing master page)
The GetColor, GetColorInfo, GetColorNames, default or -1 to use current Document
GetInkNames, and GetInkND queries Master setting

xRghtOrOutsd Outside (or right) margin

-2 to leave margin unchanged (use only if

redefining an existing master page)

-1 to use current Document Master set-

ting
 ADOBE PAGEMAKER 7.0 60
Commands

Unique names. When you create a new master

Parameter Values to enter
page, make sure you are not overwriting an
yBottom Bottom margin existing master page. Use the GetMasterPageList to
-2 to leave margin unchanged (use only if determine the names of all existing master pages.
redefining an existing master page)
Modifying Document Master. You cannot modify
-1 to use current Document Master set-
ting
the Document Master using the DefineMasterPage
command. To change the margins of the
nColumns Number of columns either on a single Document Master, use the PageMargins
page if the master is a single page, or on
the left page if the master is a two-page command. To change its column guides, display
spread the Document Master (using the Page command)
-2 to leave number of columns and use the ColumnGuides commands.
unchanged (use only if redefining an
existing master page)
Cannot change spread. You cannot change the
spread setting of an existing master page. If you are
-1 to use current Document Master set-
ting
redefining a master page, you must set bSpread to
-2. Otherwise PageMaker returns an error. (If you
xGutter Space between columns on a single page set bSpread to -2 and the named master doesn't
or the left page of a two-page spread
exist, PageMaker also returns an error.)
-2 to leave gutter unchanged (use only if
redefining an existing master page) Example. The following example creates the
-1 to use current Document Master set-
master spread "ad layout master" (unless a master
ting page with the same name already exists). The
settings for the master page are: an inside margin
nColumn- Number of columns on the right page of
RightPage a two-page spread of 1 inch, a top margin of 0.5 inches, an outside
margin of 0.75 inches, and a bottom margin of 0.5
Ignored if master is a single page
inches; both pages have two columns with a 0.2-
-2 to leave number of columns inch gutter between the columns.
unchanged (use only if redefining an
existing master page) definemaster page "ad layo ut master", false, t r ue,
-1 to use current Document Master set- 1i, .5i, .75i, .5i, 2, .2i, 2, .2i
ting

xGutterRghtPg Space between columns on the right See also:

page of a two-page spread
The ColumnGuides, DeleteMasterPage, Master-
Ignored if master is a single page
Page, Page, PageMargins, RenameMasterPage, and
-2 to leave gutter unchanged (use only if SaveAsMasterPage commands
redefining an existing master page)
The GetMasterPage, GetMasterPageInfo, and Get-
-1 to use current Document Master set- MasterPageList queries
ting

Measurement units for scripts. If you do not

specify a unit of measure for the margins and
Delete
gutters (e.g., i for inches), PageMaker uses the Deletes the selected text, text block, or graphics.
default unit of measure, specified in the Prefer- Delete equals Clear. This command is identical to
ences dialog box or with the MeasureUnits the Clear command.
command.
 ADOBE PAGEMAKER 7.0 61
Commands

Example. The following example selects all Measurement units for scripts. If you do not
objects on the page (or all text in a story if a text specify a unit of measure (e.g., i for inches),
block contains the insertion point) and deletes PageMaker uses the default unit of measure,
them. specified in the Preferences dialog box or with the
MeasureUnits command.
selectall
dele te Determining drawing order. Remember that
drawing order is determined by the order in which
the guide was drawn on the page, not its position
See also:
on the page.
The Clear command
Layout view only. The DeleteHoriz command
works only in layout view.
DeleteContent Example. The following example deletes two
Deletes the content, whether text or a graphic, guides: the horizontal guide seven inches from the
from the selected frame. This removes the frame's current location of the rulers' zero point and the
content from the publication. To remove the third horizontal guide drawn.
content from the frame, but keep it in the publi- deletehor iz 7i
cation as an independent item, use the Separate- deletehor iz guide 3
Content command.
Layout view only. The DeleteContent command See also:
works only in layout view.
The DeleteVert command
Example. The following example deletes content
from the selected frame and from the publication.
delete content DeleteLayer sFromLayer, sToLayer
Deletes a layer and moves its objects to another
layer, or removes a layer and its objects altogether.
See Also:
The AttachContent, BreakLinks, FrameContent- Parameter Values to Enter
Pos, FrameInset, LinkFrames, SeparateContent, sFromLayer Name of the layer to be deleted
and ToggleFrame commands
sToLayer Name of layer to move objects to, or "" to
The GetFrameContentPos, GetFrameInset, GetFr- delete the objects
ameContentType, GetIsFrame, and GetNext-
Frame queries
Layout view only. The DeleteLayer command
works only in layout view.
DeleteHoriz yLocation Example . The following example removes the
Deletes the specified horizontal guide, using either layer "Notes" and all of its contents.
its location or drawing-order number. d e l e te l ayer " No te s " , " "

Parameter Values to enter

yLocation y coordinate of the horizontal guide to See Also:

be deleted, relative to rulers' zero point The AssignLayer, DeleteUnusedLayers, LayerOp-
guide #, where # is the drawing-order tions, LockLayers, MoveLayer, NewLayer, PasteR-
number of the guide (e.g., deletehoriz emembers, SelectLayer, ShowLayers, and
guide 2) TargetLayer commands
 ADOBE PAGEMAKER 7.0 62
Commands

The GetLayerFromID, GetLayerList, GetLayerOp- Parameter Values to enter

tions, GetPasteRemembers, and GetTargetLayer
queries cTargetClass classobject for imported graphics and
images, and for PageMaker lines, boxes,
ovals, polygons, and text blocks

classstory for stories

DeleteMasterPage sMasterName
classpub for publication (current publi-
Deletes the specified master page and sets None as
cation only)
the master page of any pages to which the deleted
classpage for page
master had been applied.
classmaster for master page
Document Master and None. You cannot delete
the prenamed master pages, Document Master dontcare or -2 to delete all private data
associated with specified sDeveloperID
and None. and sPlugInID

Example. The following example deletes the nTypeFlag Identifier you defined to distinguish
master page named TOC. between types of private data for same
cTargetClass
deletemaster page "TO C "
dontcare or -2 to delete all private data
for specified cTargetClass and associated
with specified plug-in, or if cTargetClass
See also: is dontcare or -2
The DefineMasterPage, MasterPage, RenameMas-
nCount Number of deletions
terPage, and SaveAsMasterPage commands
1 if nTypeFlag is set to dontcare or -2
The GetMasterPage, GetMasterPageInfo, and Get-
MasterPageList queries nTargetID Internal PageMaker identifier for element
(graphic, image, text block, page, master
page, or story) to which private data is
associated
DeletePrivateData sDeveloperID,
0 (zero) for publication (PageMaker
sPlugInID, cTargetClass, nTypeFlag, deletes private data in current publica-
nCount, (nTargetID)... tion only)
Deletes the private data and private strings dontcare or-2 to delete all private data
associated with the specified input criteria. Using for all elements in specified cTargetClass
and associated with a specified nType-
dontcare or -2 for parameter values, you can delete Flag, or if nTypeFlag is set to dontcare or
all private data and strings associated with any of -2
the following: your plug-in; your plug-in and a
class of objects; your plug-in, a class of objects, and Errors. PageMaker returns an error if:
a private ID; or your plug-in, a class of objects, a
• The specified element has no private data
private ID, and a specific element.
associated with the specified plug-in and
Parameter Values to enter nTypeFlag (CQ_NOPDATA).
sDeveloperID Four-character string representing your • cTargetClass and nTargetID together do not
name or your company name, in quota- specify an existing element (graphic, image, text
tion marks (e.g., ADBE for Adobe)
block, page, master page, story, or publication)
sPlugInID Four-character string representing the (CQ_INVALID_TARGET).
plug-in, in quotation marks (e.g., KYLN
for Keyline plug-in) • nTypeFlag is -1 (CQ_INVALID_CONTEXT).
 ADOBE PAGEMAKER 7.0 63
Commands

Five parameters needed to identify data. Layout view only. The DeleteRulerGuides
PageMaker requires five parameters to identify command works only in layout view.
private data:
Example. The following example deletes all ruler
• sDeveloperID and sPlugInID to identify the guides on the current page.
plug-in. deleter ulerguides
• cTargetClass and nTargetID to identify the
element being assigned the data.
• nTypeFlag to distinguish between data types DeleteUnusedLayers bSkipUI
(you define this parameter). Deletes all the unused layers in a publication.
Dontcare or -2. If you set any parameter to Parameter Values to Enter
dontcare or -2, you must set all subsequent param-
bSkipUI Off or 0 prompts the user for confirma-
eters to dontcare or -2 as well, except nCount, tion before the layers are deleted
which must be set to 1. If you set cTargetClass to -
On or 1 deletes the layers without
2, then set nTypeFlag and nTargetID to -2 and set
prompting the user for confirmation
nCount to 1.
Examples. The following example deletes all Example. The following example deletes all of the
private data of all ClassObject elements that are unused layers without prompting the user for
associated with ADBE and KYLN and have a confirmation.
private ID of 15.
d e l e teu nu s e d l aye r s 1
d el etep r iv a ted a ta "A D B E ", "K Y L N" , c la s s ob je c t ,
15, 1, dontcare
See Also:
The following example deletes all private data of all
ClassObject elements that are associated with The AssignLayer, DeleteLayer, LayerOptions,
ADBE and KYLN. LockLayers, MoveLayer, NewLayer, PasteRemem-
bers, SelectLayer, ShowLayers, and TargetLayer
d el etep r iv a ted a ta "A D B E ", "K Y L N" , c la s s ob je c t , commands
dontcare, 1, dontcare The GetLayerFromID, GetLayerList, GetLayerOp-
The following example deletes all private data in tions, GetPasteRemembers, and GetTargetLayer
the publication that is associated with ADBE and queries
KYLN.
deletepr iv atedata "ADBE", "KYLN", dontcare,
dontcare, 1, dontcare
DeleteVert xLocation
Deletes the specified vertical guide, using either its
location or drawing-order number.
See also:
Parameter Values to enter
The PrivateData and PrivateString commands
The GetPrivateData, GetPrivateList, and GetPri- xLocation x coordinate of the vertical guide to be
deleted, relative to rulers' zero point
vateString queries
guide #, where # is the drawing-order
number of the guide (e.g., deletehoriz
guide 2)
DeleteRulerGuides
Deletes all ruler guides on the current page.
 ADOBE PAGEMAKER 7.0 64
Commands

Measurement units for scripts. If you do not Dictionary sLanguage

specify a unit of measure (e.g., i for inches),
Selects the language dictionary for hyphenation
PageMaker uses the default unit of measure,
and spelling. The extent of the action depends on
specified in the Preferences dialog box or with the
which tool is active, whether any text is selected,
MeasureUnits command.
and whether a publication is open when the
Determining drawing order. Remember that command is executed.
drawing order is determined by the order in which
Parameter Values to enter
the guide was drawn on the page, not its position
on the page. sLanguage Name of language dictionary, in quota-
tion marks and exactly as it appears in
Layout view only. The DeleteVert command Dictionary list box
works only in layout view. "none" (quotation marks required) to
choose no language dictionary
Example. The following example deletes two
guides: the vertical guide 3.2 inches from the
current location of the rulers' zero point and the Dictionary must be installed. The dictionary you
first vertical guide drawn. specify must be installed.

d e l e te ver t 3 . 2 i Example. The following example specifies the

delete ver t guide 1 United Kingdom English dictionary for hyphen-
ation and spell-checking.

See also: dictionary "UK English"

The DeleteHoriz command

See also:
The GetDictionary query
Deselect
Changes the active tool to the pointer tool (if
necessary) and deselects all currently selected text DisplayNonPrinting [bState]
or graphics. Displays or hides all nonprinting objects (text
Deselect emulates clicking. The Deselect blocks and graphics that have the nonprinting
command is identical to clicking a nonselectable attribute applied).
area of the publication window, such as the paste- Parameter Values to enter
board or the margin of the page.
bState off or 0 to hide nonprinting objects
Layout view only. The Deselect command works
on or 1 to display nonprinting objects
only in layout view. (the default)

Example. The following example deselects text or

graphics. bState defaults. If you do not specify the bState
parameter, PageMaker displays the nonprinting
deselect
objects.

See also:
The SelectAll command
The GetSelectList and GetSelectInfo queries
 ADOBE PAGEMAKER 7.0 65
Commands

Example. In the following example, all DisplayStyleNames bDisplay

nonprinting items (text blocks and graphics that
Displays or hides paragraph style names in a
have the nonprinting attribute applied) are
sidebar in the left margin of the story active in
displayed on screen when you turn to the pages
story editor.
containing them.
Parameter Values to enter
displaynonpr inting on
bDisplay off or 0 to hide paragraph style names

See also: on or 1 to display paragraph style names

The NonPrinting command

Story editor only. The DisplayStyleNames
The GetDisplayNonPrinting and GetNonPrinting
command works only in story editor.
queries
Plug-ins and external scripts only. If story editor
is not active, PageMaker returns
DisplaySpecial bDisplay CQ_LO_INVALID_MODE and disregards the
Displays or hides special characters in the story command.
active in story editor. Characters displayed include Example. The following example switches to story
spaces, tab characters, hard returns, and soft editor and displays paragraph style names.
returns (Shift-Return).
editstor y
Parameter Values to enter displayst y lenames on

bDisplay off or 0 to hide special characters

on or 1 to display special characters See also:

The DisplaySpecial command
Story editor only. The DisplaySpecial command The GetDisplayStyleNames query
works only in story editor.
Plug-ins and external scripts only. If story editor
is not active, PageMaker returns DragSelect xLeft, yTop, xRight,
CQ_LO_INVALID_MODE and disregards the yBottom
command. Deselects the current selection and then selects all
Example. The following example switches to story
of the objects enclosed within the rectangle
editor and displays special characters. specified.

editstor y Parameter Values to Enter

displayspecial on xLeft x coordinate, relative to the current zero

point, of the left side of the area to be
selected
See also:
yTop y coordinate, relative to the current zero
The DisplayStyleNames command point, of the top side of the area to be
The GetDisplaySpecial query selected

xRight x coordinate, relative to the current zero

point, of the right side of the area to be
selected
 ADOBE PAGEMAKER 7.0 66
Commands

Parameter Values to Enter See Also:

The DragSelect, Select, SelectAll, SelectExtend,
yBottom y coordinate, relative to the current zero
point, of the bottom side of the area to SelectID, and SelectIDExtend commands
be selected The GetSelectIDList and GetSelectInfo queries

Layout view only. The DragSelect command

works only in layout view. EditLayout
Example. The following example selects all of the Switches to layout view of the current publication.
objects in an 8.5 by 11 inch area, starting at the zero
Story editor only. The EditLayout command
point.
works only in story editor.
dragselect 0i, 0i, 8.5i, 11i
Location displayed depends on active story.
Which page or pages PageMaker displays in layout
See Also: view depends upon the story active at the time the
The DragSelectExtend, Select, SelectAll, SelectEx- command is sent. If the active story:
tend, SelectID, and SelectIDExtend commands
• Has been placed, PageMaker turns to the page
The GetSelectIDList and GetSelectInfo queries (or pages, for facing pages) containing the
insertion point or selected text. The story remains
open in story editor, though inactive.
DragSelectExtend xLeft, yTop,
• Has not been placed, PageMaker returns to the
xRight, yBottom
previously active page (or pages, for facing pages)
Adds the objects that are enclosed within the and displays the loaded text icon.
specified area to the current selection list.
• Is empty, PageMaker closes the empty story
Parameter Values to Enter window and returns to the previously active page
xLeft x coordinate, relative to the current zero (or pages, for facing pages).
point, of the left side of the area to be
Plug-ins and external scripts only. If story editor
selected
is not active, PageMaker returns
yTop y coordinate, relative to the current zero CQ_LO_INVALID_MODE and disregards the
point, of the top side of the area to be
selected
command.

xRight x coordinate, relative to the current zero

Example. The following example switches to
point, of the right side of the area to be layout view of the currently active publication.
selected
editlayo ut
yBottom y coordinate, relative to the current zero
point, of the bottom side of the area to
be selected See also:
The EditStory command
Layout view only. The DragSelectExtend
The GetPMState query
command works only in layout view.
Example. The following example selects all of the
objects in an 8.5 by 11 inch area without
deselecting any objects that were already selected.
d r a g s e l e c tex ten d 0 i , 0 i , 8 . 5 i , 1 1 i
 ADOBE PAGEMAKER 7.0 67
Commands

EditOriginal sAppFilename Example. The following example exits

PageMaker.
Launches the originating application (or the
specified application) of the selected linked ex i t
graphic or story.

Parameter Value to enter See also:

sAppFilename Exact name of application to be The Close, Save, SaveAs, and Quit commands
launched, in quotation marks, including
optional pathname to folder and disk (to
a maximum of 91 characters for each
name and path)
Export fFilename, sFormat[, bTags]
Exports text from the text block that currently
System 7 required on Macintosh. To use this contains the insertion point to the specified
command on the Macintosh, you must run the filename, using the selected format.
plug-in or script under System 7.0 or later. Parameter Values to enter
Example. The following example selects the first fFilename Exact name of file to which selected text
object drawn and launches the application that is to be exported, including optional
created it. pathname to folder and disk, in quota-
tion marks (to a maximum of 91 charac-
select 1 ters for each name and path)
editor ig inal "mydisk:my folder :Word"
sFormat File format, in quotation marks and
exactly as it appears in File Format list
box (to a maximum of 31 characters)

EditStory bTags false or 0 (zero, default)

Invokes the story editor. true or 1 to export tags (style names)

Layout view only. The EditStory command works

only in layout view. Range or entire story. Unlike the options in the
Export dialog box, this command does not provide
Example. The following example switches a parameter to explicitly choose Entire Story or
PageMaker to the story editor. Selected Text Only. If there is a selection range in
editstor y the story, PageMaker exports it; otherwise,
PageMaker exports the entire story.
Exporting style names. The bTags parameter
Exit exports the style names with the exported file.
Exits (quits) PageMaker without saving the They appear in angle brackets at the beginning of
changes to the open publications. each paragraph. Later, if the file is placed in
PageMaker, PageMaker uses the styles to format
Caution: No prompt for unsaved or changed publi-
the text.
cations. Unlike its menu counterpart, the Exit
command does not warn you if you have not saved Caution: No prompt for overwriting files. Unlike
the latest changes to a publication, nor does it its menu counterpart, the Export command does
prompt you to name an unnamed publication. Use not prompt you if a file with the same name
the Save or SaveAs commands if you want to save already exists. Instead, PageMaker overwrites the
changes to the open publications. file directly.
 ADOBE PAGEMAKER 7.0 68
Commands

Example. The following example exports selected

Parameter Values to enter
text to "myfile," in text-only format and with style
names attached. sFillColor Name of color, in quotation
marks, exactly as it appears
expor t "mydisk:my folder :my file", "Text-only", on Colors palette (to a maxi-
mum of 31 characters)
true
"dontcare" to leave the
color unchanged (quotation
See also: marks required)

The GetExportFilters query bFillOverprint off or 0 to knockout any por-

tion of an element posi-
tioned beneath object

FillAndLine cFillStyle, sFillColor, on or 1 to print all overlap-

ping elements
bFillOverprint, cLineStyle, bReverse,
dWeight, bOpaque, sLineColor, cLineStyle dontcare or -2 to leave the
line style unchanged
bLineOverprint[, nFillTint, nLineTint]
Sets the fill and line attributes of the selected none or 0 (zero)

objects: style, color, overprint attribute, weight hairline or 1

(lines only), and tint percentage. Acts on
PageMaker-drawn objects only. halfpoint or 2

Parameter Values to enter onepoint or 3

cFillStyle dontcare or -2 to leave style twopoint or 4

unchanged
fourpoint or 5
none or 0 (zero)
sixpoint or 6
paper or 1
eightpoint or 7
solid or 2
twelvepoint or 8
vertfew or 9
thinthin or 9
vertlots or 10
thickthin or 10
horizfew or 11
thinthick or 11
horizlots or 12
thinthickthin or 12
diagfew or 13
thindash or 13
diaglots or 14
mediumdash or 14
hashfew or 15
thickdash or 15
hashlots or 16
squares or 16

dots or 17
 ADOBE PAGEMAKER 7.0 69
Commands

PageMaker objects only. The FillAndLine

Parameter Values to enter
command applies only to objects drawn in
customsolid or 31 for a PageMaker, not imported objects.
solid line of weight specified
by specified by dWeight dWeight overrides cStyle. Set the dWeight
bReverse off or 0 for normal parameter to dontcare or -2 unless you are defining
a custom line. The value of dWeight overrides the
on or 1 for reverse line
line weight specified in cStyle.
dontcare or -2 to leave set-
ting unchanged dWeight truncated. If dWeight includes more
than one decimal place, PageMaker truncates the
dWeight Weight of custom line, in
points (precise to one deci- value to tenths of a point. For example, 12.19
mal place) becomes 12.1 points.
dontcare or -2 to leave Text tool, story editor, or no object. If the text
existing line weight
unchanged or for pre-
tool is active, the command results in an error. If
defined line weight (e.g., either the story editor is active or no PageMaker
hairline) objects are selected, the specified fill and line
bOpaque false or 0 to make the back- become the default settings for the publication.
ground of compound,
dashed, or dotted lines
Tinting and shading objects. In PageMaker 6.0 or
transparent; default later, you tint an object's fill using the nFillTint
true or 1 to make the back-
parameter. Earlier versions of PageMaker set solid
ground of compound, fills from 10 percent to 80 percent of an object's
dashed, or dotted lines color (tenpct or 3 to eightypct or 8). To duplicate
opaque
these fill styles, set cFillStyle to solid (or 2) and set
sLineColor Name of color, in quotation nFillTint to the desired percentage, from 0 to 100.
marks, exactly as it appears
on Colors palette (to a maxi- Example. The following example selects the first
mum of 31 characters) object drawn on the page and sets its fill to a 30%
"dontcare" to leave color Red tint. The 20-point line is a 20% Green tint.
unchanged (quotation When printing, PageMaker will knockout any
marks required)
portion of an element beneath the fill, but will
bLineOverprint off or 0 to knockout any por- overprint the line.
tion of an element posi-
tioned beneath the line select 1
fi l l a n d l i n e 2 , " Re d " , 0 , 3 1 , 0 , 2 0 , 0 , " Gre e n " , 1 ,
on or 1 to overprint any por-
tion of an element that the 30, 20
line overlaps

nFillTint Percentage of color to apply See also:

to the object fill (from 0 to
100) The FillStyle and LineStyle commands
dontcare or -2 to leave set- The GetFillAndLine, GetFillStyle, and GetLine-
ting unchanged (default) Style queries
nLineTint Percentage of color to apply
to the object line (from 0 to
100)

dontcare or -2 to leave set-

ting unchanged (default)
 ADOBE PAGEMAKER 7.0 70
Commands

FillStyle cStyle Find sFindWhat, [cSearchRange],

Applies a fill to the selected object or objects. [bWrapAround], [bMatchCase],
[bWholeWord], [bClearAttr]
Parameter Values to enter
Searches for the first instance of the specified text
cStyle none or 0 (zero) in the selected range, the active story, or all stories
none or 0 (zero) of the current publication. Selects the first match it
finds.
paper or 1
Parameter Values to enter
solid or 2
sFindWhat Text to search for, in quotation marks.
vertfew or 9 cSearchRange selectedtext or 0 to search selected text

vertlots or 10 currentstory or 1 to search current story

only, starting from position of insertion
point (default setting)
horizfew or 11
allstories or 2 to search all stories in cur-
horizlots or 12 rent publication, starting from beginning
of currently active story
diagfew or 13
default or -1 to use default or previously
defined range
diaglots or 14
dontcare or -2 to let system choose
hashfew or 15 range based on current text selection. If
text is selected, the Find command
hashlots or 16 searches only selected text; if no text is
selected, the Find command searches
current story only, starting from position
of insertion point.
Text tool, story editor, or no object. If the text
tool is active, the command results in an error. If bWrapAround stopatend or 0 to stop searching when
either the story editor is active or no PageMaker PageMaker reaches end of story
objects are selected, the specified fill becomes the wrap or 1 to continue searching from
default fill for the publication. beginning of story when PageMaker
reaches end of story (default setting)
Tinting and shading objects. In PageMaker 7.0,
bMatchCase anycase or 0 (zero) to turn off case-sensi-
you tint an object's fill using the FillAndLine tive searching (default setting)
command.
matchcase or 1 to turn on case-sensitive
Example. The following example selects the searching (match capitalization of search
text exactly)
second-drawn object and applies a pattern of a few
horizontal lines (as shown in the Fill submenu). bWholeWord allinstances or 0 (zero) to search for any
occurrence of specified text (default set-
select 2 ting), even if text is found within another
fi l l s t y l e 1 1 word (for example, searching for "story"
could yield "history," as well as "story")

wholeword or 1 to search for specified

See also: text as a whole word only, disregarding
cases where text is embedded within
The GetFillAndLine and GetFillStyle queries
another word.
 ADOBE PAGEMAKER 7.0 71
Commands

Searching for text attributes only. To search for

Parameter Values to enter
text attributes only (e.g., all 10 point, bold text),
bClearAttr useattributes or 0 to use existing Find first use the FindTypeAttr1 and FindTypeAttr2
text and paragraph attributes (default
setting) commands to set the desired attributes. (Be sure to
clear the paragraph attributes with the FindPar-
clear or 1 to clear all Find attribute set-
tings aAttr command.) Then, follow with the Find
command: Specify an empty string for sFindWhat
Story editor only. The Find command works only and set bClearAttr to useattributes or 0. For
in story editor. example, to search for all 10-point, bold text in a
publication, the commands are:
Current publication only. Unlike the Find dialog
box, the Find command cannot search multiple findt y p eatt r2 -3, -3, "Any", -3 --to clear the
publications. It can search only the stories in the other t y pe att r i butes
currently active publication. findpar aatt r "Any", -3, -3 --to clear the
par ag r a ph att r i butes
Find next. The Find command locates the first
fi n d t y p e a t t r 1 " Any " , 1 0 , - 3 , b o l d s t y l e , - 3 , - 3
occurrence of the search text. You must repeat the
find "", "", allstor ies, stopatend, anycase, allin-
command or use the FindNext command to find
stances, useatt r i butes
the next occurrence of the search text. Use the
Searching for special characters. You enter a
ChangeAll command to change all occurrences of
special character as part of your search text using
the search text.
the same key combinations that you use to enter
bWrapAround. PageMaker disregards the bWrap- the character directly into the Find dialog box.
Around parameter when cSearchRange is set to
Scripts palette. Do not use the Find command in
either:
scripts you plan to run using the Scripts palette.
• selectedtext (or 0), which confines the search to When PageMaker finds no match or completes the
the selected text. search, the Scripts palette interprets this as an error
and stops at that point in the script.
• allstories (or 2), which starts the search at the
beginning of the active story and automatically Plug-ins and external scripts only. PageMaker
wraps to the beginning of the next story. returns the following codes to indicate the success
Optional parameters. PageMaker requires only of the search:
the sFindWhat parameter. If you do not include Example. The following example searches the
values for the other parameters, PageMaker uses current story for any instance of the letters "tango,"
the settings of the last Find, Change, or ChangeAll regardless of the capitalization or attribute settings
command. (If none of these commands has been (paragraph style, font, size, type style, position, or
executed this session, PageMaker uses the default case). The search begins at the position of the
settings—noted in the parameter list above.) insertion point and wraps to the beginning of the
Setting text and paragraph attributes. To search story if necessary.
for text and paragraph attributes (e.g., font, type find "tango", stor y, w r ap, anycase, allinstances,
size, paragraph style), use the FindTypeAttr1, clear
FindTypeAttr2, and FindParaAttr commands,
followed by the Find command with bClearAttr set
to useattributes or 0.
See also:
The Change, ChangeAll, ChangeNext,
ChangeParaAttr, ChangeTypeAttr1,
ChangeTypeAttr2, ChangeWindow, FindNext,
 ADOBE PAGEMAKER 7.0 72
Commands

FindParaAttr, FindTypeAttr1, FindTypeAttr2, and --searches only from inser t ion point to end of
FindWindow commands stor y,
The GetChangeParaAttr, GetChangeTypeAttr1, change "Note", "Tip", allstor ies, 1, anycase,
GetChangeTypeAttr2, GetChangeWindow, Get- a lli n s t a n ce s , c le a r
FindParaAttr, GetFindTypeAttr1, findnext--finds next instance of "Note",
GetFindTypeAttr2, and GetFindWindow queries - - re ga rd le s s of a t t r i b u te s , s e a rch i n g a ll s tor ies

The first FindNext command searches for the next

FindNext instance of a 10-point, bold and underlined "Tip,"
Searches for the next instance of the text specified matching the whole word and its capitalization.
in the last Find, Change, or ChangeAll command, The search begins at the location of the insertion
using all the same settings. Selects the first match point and stops at the end of the story.
of the search text it encounters. Because of the Change command, the second
Story editor only. The FindNext command works FindNext searches for the next instance of "Note,"
only in story editor. regardless of its capitalization or attributes. The
search begins from the location of the insertion
Current publication only. Unlike the Find Next
point, but wraps to the next story if necessary.
button in the Find dialog box, the FindNext
command cannot search multiple publications. It Scripts palette. Do not use the FindNext
can search only the stories in the currently active command in scripts you plan to run using the
publication. Scripts palette. When PageMaker finds no match
or completes the search, the Scripts palette inter-
Repeat as often as needed. You can send this
prets this as an error and stops at that point in the
command repeatedly until PageMaker finishes
script.
searching the range specified by the previous Find,
Change, or ChangeAll command. Plug-ins and external scripts only. PageMaker
returns the following codes to indicate the success
Last executed Change, ChangeAll, or Find wins.
of the search:
As in the Find and Change dialog box, the Find,
Change, and ChangeAll commands share the Find Example. The following example searches the
What and Change To text, as well as the settings for current story for the first instance of the letters
the search options, range, and attributes. "tango," regardless of the capitalization or attribute
Therefore, you must be careful to know all the settings (paragraph style, font, size, type style,
current settings before you use the ChangeNext position, or case). The search begins at the position
and FindNext commands. (If you insert a Change of the insertion point and wraps to the beginning
command between the Find and FindNext of the story if necessary. The FindNext command
commands, the Change search text, options, range, then searches for the next instance of "tango,"
and attributes become the search text and settings using the same search criteria and starting the
used by FindNext.) For example: search from the end of the last encountered
"tango."
fi n d t y p ea tt r1 "Any ", 10, - 3,
boldstyle+underline, -3, -3 find "tango", stor y, w r ap, anycase, allinstances,
ch a n g e t y p e a t t r 1 " He lve t i c a " , 9 , - 3 , b o l d s t y l e , - 3 , clear
-3 fi n d n ex t
find "Tip", cur rentstor y, stopatend, matchcase,
wholeword , useatt r ibutes
See also:
findnext--finds next instance of a bold under-
l i n e d " Ti p " The Change, ChangeAll, ChangeNext,
 ADOBE PAGEMAKER 7.0 73
Commands

ChangeParaAttr, ChangeTypeAttr1, All attributes cleared first. The settings you

ChangeTypeAttr2, ChangeWindow, Find, Find- include with the FindParaAttr command replace
ParaAttr, FindTypeAttr1, FindTypeAttr2, and all existing attribute settings.
FindWindow commands
Plug-ins and external scripts. If story editor is not
The GetChangeParaAttr, GetChangeTypeAttr1,
active, PageMaker returns
GetChangeTypeAttr2, GetChangeWindow, Get-
CQ_LO_INVALID_MODE and disregards the
FindParaAttr, GetFindTypeAttr1,
GetFindTypeAttr2, and GetFindWindow queries command.
Example. The following example changes all left-
aligned text in the current publication to full-
FindParaAttr sParaStyle, cAlignment, justified text. Notice that it first sets all other Find
cLeadingType and Change attributes to Any.
Sets the paragraph attributes (paragraph style, fi n d t y p e a t t r 1 " Any" , - 3 , - 3 , - 3 , - 3 , - 3
alignment, and leading method) to be used as the ch a n g e t y p e a t t r 1 " Any " , - 3 , - 3 , - 3 , - 3 , - 3
search text in the Find, Change, and ChangeAll fi n d t y p e a t t r 2 - 3 , - 3 , " Any" , - 3
commands. ch a n g e t y p e a t t r 2 - 3 , - 3 , " Any " , - 3

Parameter Values to enter findpar aatt r "Any", left, -3

changepar aatt r "Any", justify, -3
sParaStyle Name of style (exactly as it appears in
ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s ,
Styles palette), in quotation marks (to a
maximum of 31 characters) useatt r i butes

"Any" (quotation marks required) for

Any paragraph style (i.e., to not include See also:
paragraph style in search criteria; default
setting) The Change, ChangeAll, ChangeNext,
"No style" (quotation marks required) ChangeParaAttr, ChangeTypeAttr1,
for No Style ChangeTypeAttr2, ChangeWindow, Find, FindN-
ext, FindTypeAttr1, FindTypeAttr2, and FindWin-
cAlignment any or -3 for Any alignment (i.e., to not dow commands
include alignment in search criteria;
default setting) The GetChangeParaAttr, GetChangeTypeAttr1,
GetChangeTypeAttr2, GetChangeWindow, Get-
left or 0 (zero) for Left
FindParaAttr, GetFindTypeAttr1,
center or 1 for Center GetFindTypeAttr2, and GetFindWindow queries
right or 2 for Right

justify or 3 for Justify

force or 4 for Force Justify

cLeadingType any or -3 for Any leading method (i.e., to

not include leading method in search cri-
teria; default setting)

proportional or 0 (zero) for Proportional

topofcaps or 1 for Top of Caps

baseline or 2 for Baseline

Story editor only. The FindParaAttr command

works only in story editor.
 ADOBE PAGEMAKER 7.0 74
Commands

FindTypeAttr1 sFontName, Parameter Values to enter

dPointSize, dLeading, cTypeStyle,
cCase any or -3 for Any case (i.e., to not include
cPosition, cCase case attribute in search criteria; default
setting)
Sets the text attributes (font, point size, type style,
position, and case) to be used for the search text in allcaps or 1 for All Caps (full-size capitals)
the Find, Change, and ChangeAll commands. smallcaps or 2 for Small Caps (small cap-
itals)
Parameter Values to enter

sFontName Name of font (exactly as it appears on Story editor only. The FindTypeAttr1 command
Type menu), in quotation marks (to a works only in story editor.
maximum of 63 characters)
Plug-ins and external scripts. If story editor is not
"Any" (quotation marks required) for
Any font (i.e., to not include font name in active, PageMaker returns
search criteria; default setting) CQ_LO_INVALID_MODE and disregards the
command.
dPointSize Point size of type (from 4.0 to 650.0)

any or -3 for Any size (i.e., to not include Type styles are additive. To set the cTypeStyle
point size in search criteria; default set- parameter to multiple type styles, either separate
ting) the desired style option with the plus sign (+) or
dLeading Amount of leading, in points (from 0.0 to add the numeric equivalents for the styles. For
1300.0) example, for bold (1) and underline (4), you can
any or -3 to specify Any leading either set cTypeStyle to boldstyle+underline or to
5 (the sum of 1 and 4).
auto or -1 for automatic leading
All attributes cleared first. The settings you
cTypeStyle any or -3 for Any (i.e., to not include type
style in search criteria; default setting) include with the FindTypeAttr1 command replace
all existing attribute settings.
normalstyle or 0 for Normal

Or, any combination of the following Any for cTypeStyle, cPosition, and cCase. Unlike
styles, separated by the plus sign (+), or the Type Styles pop-up menu in the Find
the actual sum of their values: Attributes dialog box, the any or -3 setting for
boldstyle or 1 for Bold cTypeStyle pertains only to the type styles Bold,
italicstyle or 2 for Italic Italic, Underline, Strikethru, Outline, Shadow, and
Reverse. The value of cTypeStyle does not affect
underlinestyle or 4 for Underline
the cPosition and cCase parameters, which are
strikethrustyle or 8 for Strikethru
turned off and on separately.
outlinestyle or 16 for Outline (Macin-
tosh only)

shadowstyle or 32 for Shadow (Macin-

tosh only)

reversestyle or 64 for Reverse

cPosition any or -3 for Any position (i.e., to not

include position attribute in search crite-
ria; default setting)

superscript or 1 for Superscript

subscript or 2 for Subscript

 ADOBE PAGEMAKER 7.0 75
Commands

GetTypeStyle values doubled. If you are using the FindTypeAttr2 dSetWidth, cTrack,
GetTypeStyle query in conjunction with sColorName, nTintValue
ChangeTypeAttr1, FindTypeAttr1,
Sets additional text attributes (horizontal scale,
GetChangeTypeAttr1, or GetFindTypeAttr1, note
tracking, color, and tint) to be used for the search
that the GetTypeStyle query returns different
text in the Find, Change, and ChangeAll
values for the type styles. With the exception of
commands.
normal, all the GetTypeStyle values are twice the
values used in the find and change commands and Parameter Values to enter
queries. For example, bold is 2 for GetTypeStyle
dSetWidth Percentage to scale the character width
and 1 for ChangeTypeAttr1, FindTypeAttr1, (from 5.0 to 250.0; normal is 100.0)
GetChangeTypeAttr1, and GetFindTypeAttr1.
any or -3 for Any set width (i.e., to not
Normal, however, is 1 in GetTypeStyle and 0 in the include set width settings in search crite-
other commands and queries. ria)

Example. The following example changes all 10- cTrack dontcare or -3 for Any tracking (i.e., to
point, bold, underlined text in the current publi- not include track settings in search crite-
ria)
cation to 9-point, Helvetica bold. Notice that it
first sets all other Find and Change attributes to notrack or 0 (zero) for No Track

Any. veryloose or 1 for Very Loose

fi n d t y p ea tt r2 - 3, - 3, "Any ", - 3 loose or 2 for Loose

ch a n g e t y p e a t t r 2 - 3 , - 3 , " Any " , - 3 normaltrack or 3 for Normal Track
fi n d p a r a a tt r "Any ", - 3, - 3 tight or 4 for Tight
changepar aatt r "Any", -3, -3
verytight or 5 for Very Tight
fi n d t y p ea tt r1 "Any ", 10, - 3,
boldstyle+underline, -3, -3 sColorName Name of color, in quotation marks and
ch a n g e t y p e a t t r 1 " He lve t i c a " , 9 , - 3 , b o l d s t y l e , - 3 , exactly as it appears in Colors palette (to
maximum of 31 characters)
-3
ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s , "Any" (quotation marks required) for
Any color (i.e., to not include color in
useatt r i butes search criteria)

See also: nTintValue Percentage of color (from 0 to 100), in

The Change, ChangeAll, ChangeNext, whole percentages
ChangeParaAttr, ChangeTypeAttr1, any or -3 for Any tint amount
ChangeTypeAttr2, ChangeWindow, Find, FindN-
ext, FindParaAttr, FindTypeAttr2, and FindWin-
Story editor only. The FindTypeAttr2 command
dow commands
works only in story editor.
The GetChangeParaAttr, GetChangeTypeAttr1,
GetChangeTypeAttr2, GetChangeWindow, Get- All attributes cleared first. The settings you
FindParaAttr, GetFindTypeAttr1, include with the FindTypeAttr2 command replace
GetFindTypeAttr2, GetFindWindow, and Get- all existing attribute settings.
TypeStyle queries
Plug-ins and external scripts. If story editor is not
active, PageMaker returns
CQ_LO_INVALID_MODE and disregards the
command.
 ADOBE PAGEMAKER 7.0 76
Commands

Example. The following example changes all Example. The following example opens the Find
purple text in the current publication to 93% tint dialog box.
of purple. Notice that it first sets all other Find and
findw indow open
Change attributes to Any.
fi n d t y p ea tt r1 "Any ", - 3, - 3, - 3, - 3 , - 3
See also:
ch a n g e t y p e a t t r 1 " Any " , - 3 , - 3 , - 3 , - 3 , - 3
fi n d p a r a a tt r "Any ", - 3, - 3 The Change, ChangeAll, ChangeNext,
changepar aatt r "Any", -3, -3
ChangeParaAttr, ChangeTypeAttr1,
ChangeTypeAttr2, ChangeWindow, Find, FindN-
fi n d t y p ea tt r2 - 3, - 3, "Pu r p l e", - 3
ext, FindParaAttr, FindTypeAttr1, and
ch a n g e t y p e a t t r 2 - 3 , - 3 , " Pu r p l e " , 9 3
FindTypeAttr2 commands
ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s ,
The GetChangeParaAttr, GetChangeTypeAttr1,
useatt r i butes
GetChangeTypeAttr2, GetChangeWindow, Get-
FindParaAttr, GetFindTypeAttr1,
See also: GetFindTypeAttr2, and GetFindWindow queries
The Change, ChangeAll, ChangeNext,
ChangeParaAttr, ChangeTypeAttr1,
ChangeTypeAttr2, ChangeWindow, Find, FindN- Font sFontName
ext, FindParaAttr, FindTypeAttr1, and FindWin- Specifies the font for text. Action depends on
dow commands which tool is active, whether any text is selected,
The GetChangeParaAttr, GetChangeTypeAttr1, and whether a publication is open when the
GetChangeTypeAttr2, GetChangeWindow, Get- command is executed.
FindParaAttr, GetFindTypeAttr1,
GetFindTypeAttr2, and GetFindWindow queries Parameter Values to enter

sFontName Name of font, in quotation marks and

exactly as it appears on Type menu (to a
FindWindow bOpen maximum of 63 characters)

Opens or closes the Find dialog box.

Font must be installed on same system. The font
Parameter Values to enter you specify must be installed on the system on
which you're running the plug-in or script.
bOpen close or 0 to close Find dialog box

open or 1 to open Find dialog box Specifying the font name correctly. Type the font
name exactly as it appears when you choose Font
Story editor only. The FindWindow command from the Type menu. If the system on which the
works only in story editor. plug-in or script is running includes Adobe Type
Reunion (ATR), Font Harmony, or another utility
Plug-ins and external scripts only. If story editor that alters the font list, the name must appear as it
is not active, PageMaker returns would in the menu without the utility running. To
CQ_LO_INVALID_MODE and disregards the see the appropriate name, open the Type Specifica-
command. tions dialog box and select the wanted font.
Change and Spell closed , depending on platform. Example. The following example selects the
PageMaker for the Macintosh closes the Change second text block placed on the page and specifies
dialog box before opening the Find dialog box. that the font be changed to Times Bold Italic.
PageMaker for Windows closes both the Change
select 2
and Spell dialog boxes.
font "BI Times BoldItalic"
 ADOBE PAGEMAKER 7.0 77
Commands

See also: FrameContentPos nVertAlign,

The TypeStyle command nHorzAlign, nScaleType,
The GetFont and GetTypeStyle queries nKeepAspectRatio
Sets the content position for the currently selected
frame. Graphic items will be positioned within the
FontDrawing bIgnore, cPresrvShape frame according to the values set.
Specifies whether to preserve line spacing and
Parameter Values to Enter
character shape in TrueType.
nVertAlign Vertical alignment of the content within
Parameter Values to enter the frame

bIgnore 0 (zero; value is ignored) 0 for top of frame

cPresrvShape preserveline or 0 to preserve the line 1 for center of frame

spacing (leading) of TrueType fonts and 2 for bottom of frame
to adjust character height as necessary
-2 to leave unchanged
preservechar or 1 to preserve character
height of TrueType fonts, regardless of nHorzAlign Horizontal alignment of the content
line spacing within the frame

0 for left edge of frame

bIgnore replaces bUseATM. The bIgnore
1 for center of frame
parameter replaces the bUseATM parameter found
in earlier versions of the PageMaker command 2 for right edge of frame

language. Because this version of PageMaker uses -2 to leave unchanged

ATM whenever it is present, the bUseATM nScaleType Scaling option for content
parameter is invalid. The bIgnore parameter acts
0 to clip to fit frame
as a placeholder to maintain compatibility with
plug-ins or scripts created using earlier versions of 1 to resize to fit frame
the command language. 2 to scale frame to fit content

Default setting. The specification applies only to -2 to leave unchanged

the active publication. If no publication is open, nKeepAspec- Aspect Ratio for scaled object
the specifications apply to any new publication tRatio
1 to keep the aspect ratio
subsequently created.
2 to resize horizontal and vertical inde-
Example. The following example specifies that pendently
line spacing be preserved in TrueType. The -2 to leave this option unchanged
bIgnore value, 0, is ignored.
fontd r aw ing 0, preser veline Layout view only. The FrameContentPos
command works only in layout view.
See also: Example. The following example aligns the
The Font and Preferences commands content with the center of the frame both horizon-
tally and vertically; the content size and aspect
The GetFontDrawing and GetPreferences queries
ratio are left unchanged.
Fr ameContentPos 1, 1, -2, -2
 ADOBE PAGEMAKER 7.0 78
Commands

See Also: GoBack

The AttachContent, BreakLinks, DeleteContent, Returns to the previously displayed page.
FrameInset, LinkFrames, SeparateContent, and
ToggleFrame commands Layout view only. The GoBack command works
The GetFrameContentPos, GetFrameInset, GetFr- only in layout view.
ameContentType, GetIsFrame, and GetNext- Example. The following example returns to the
Frame queries source of a hyperlink, assuming that there is a valid
hyperlink at the location 5i, 5i.

FrameInset nTop, nLeft, nBottom, hy perjump 5i, 5I

goba ck
nRight
Sets the inset, or margins, around the inside of a
frame. Text within the frame will be positioned See Also:
according to the insets. The GoForward and HyperJump commands
Parameter Values to Enter

nTop Size of the inset on the top edge of the GoForward

frame
Moves forward through a hyperlink or page jump
nLeft Size of the inset on the left edge of the that is in the page history.
frame
This command is only valid if the GoBack
nBottom Size of the inset on the bottom edge of
the frame command or Go Back menu item has been used.

nRight Size of the inset on the right edge of the Layout view only. The GoForward command
frame works only in layout view.
Example. The following example returns to the
Note. The selected frames must have text content or source of a hyperlink and then moves forward
no content. An inset does not work with a graphic again, assuming that there is a valid hyperlink at
frame. the location 5i, 5i.
Layout view only. The FrameInset command hy perjump 5i, 5I
works only in layout view. goba ck
Example. The following example adds a 0.25 inch gofor ward
inset to all four sides of a selected frame.
frameinset 0.25i, 0.25i, 0.25i, 0.25i See Also:
The GoBack and HyperJump commands
See Also:
The AttachContent, BreakLinks, FrameContent-
Pos, LinkFrames, SeparateContent, and Toggle-
Group
Frame commands Groups the currently selected objects.
The GetFrameContentPos, GetFrameInset, GetFr- Locked and unlocked objects. You cannot group
ameContentType, GetIsFrame, and GetNext- locked and unlocked objects together. All objects
Frame queries in a group must have the same lock status;
otherwise PageMaker returns an error
(CQ_MIXED_LOCK).
 ADOBE PAGEMAKER 7.0 79
Commands

How grouping affects the drawing order. A group Measurement units for scripts. If you do not
is considered an object and has a drawing-order specify a unit of measure (e.g., i for inches),
number like any other object. When you group, the PageMaker uses the default unit of measure,
objects within the group retain their stacking order specified in the Preferences dialog box or with the
in relation to each other, but their drawing-order MeasureUnits command.
numbers always follow the group number.
Layout view only. The GuideHoriz command
works only in layout view.
Example. The following example creates a
horizontal ruler guide 5.5 inches from the current
location of the rulers' zero point.
guidehor iz 5.5i

See also:
The DeleteHoriz, DeleteRulerGuides, Guides, and
For example, on a page with four objects, suppose
GuideVert commands
you group the first and fourth objects. The objects
The GetHorizGuides query
numbered 2 and 3 each move down in the drawing
order (becoming 1 and 2); the group becomes the
new object number 3; and the two objects in the
group become numbers 4 and 5.
Guides bState
Displays margin guides, column guides, and ruler
Example. The following example selects the first-
guides (including any guides created on master
and fourth-drawn objects and creates a group of pages).
the two objects.
Parameter Values to enter
select 1
s e l e c texten d 4 bState off or 0 (zero) to hide guides
g ro u p on or 1 to display guides

See also: Example. The following example displays the

guides.
The Ungroup command
The GetGroupList, GetObjectIDListTop, and Get- guides 1
SelectIDListTop queries
See also:
The GuideHoriz, GuideVert, LockGuides, Rulers,
GuideHoriz yPosition SnapToGuides, SnapToRulers, and ZeroLock com-
Creates a horizontal ruler guide at the specified mands
location on the page. The GetHorizGuides, GetVertGuides, GetLock-
Parameter Values to enter Guides, GetRulers, GetSnapToGuides, GetSnap-
ToRulers, and GetZeroLock queries
yPosition y coordinate for horizontal ruler guide
 ADOBE PAGEMAKER 7.0 80
Commands

GuideVert xPosition goba ck

gofor ward
Creates a vertical ruler guide at the specified
location on the page.
See Also:
Parameter Values to enter
The GoBack and GoForward commands
xPosition x coordinate for the vertical ruler guide

Measurement units for scripts. If you do not HyperLinkPalette bState

specify a unit of measure (e.g., i for inches),
Displays or hides the palette that contains the
PageMaker uses the default unit of measure,
hyperlinks panel.
specified in the Preferences dialog box or with the
MeasureUnits command. Parameter Values to Enter

Layout view only. The GuideVert command bState True displays the palette
works only in layout view. False hides the palette

Example. The following example creates a vertical

ruler guide 4.25 inches from the current location Example. The following example displays the
of the rulers' zero point. palette that contains the hyperlinks panel.

guide ver t 4.25i hy p e r l i n k p a l e t te 1

See also: See Also:

The DeleteRulerGuides, DeleteHoriz, DeleteVert, The ColorPalette, ControlPalette, LayerPalette,
Guides, and GuideHoriz commands MasterPagePalette, and StylePalette commands
The GetVertGuides query The GetColorPalette, GetControlPalette, GetMas-
terPagePalette, and GetStylePalette queries

HyperJump xLocation, yLocation

Hyphenation cState, nHyphenLimit,
Follows a hyperlink, as if the user had switched to
xZone
the hand tool and clicked at the location indicated
in the command. If the coordinates xLocation, Sets the hyphenation characteristics. The extent of
yLocation are not within the area of a hyperlink the action depends on which tool is active, whether
source, then no hyperlink is followed. any text is selected, and whether a publication is
open when the command is executed.
Parameter Values to Enter
Parameter Values to enter
xLocation x coordinate of hyperlink to follow
cState off or 0 (zero) to turn hyphenation off
yLocation y coordinate of hyperlink to follow
manualonly or 1 for Manual Only

Layout view only. The HyperJump command plusdictionary or 2 for Manual Plus Dic-
tionary
works only in layout view.
plusalgorithm or 3 for Manual Plus
Example . The following example follows a Algorithm
hyperlink, assuming that there is a valid hyperlink
at the location 5i, 5i.
hy perjump 5i, 5I
 ADOBE PAGEMAKER 7.0 81
Commands

Parameter Values to enter TIFF

• ImageSaveAs sFilename, bLink, bProfile,
nHyphenLimit Maximum number of consecutive lines in
a paragraph that can be ended by bCropped, nFormat, nCompression, nFormat-
hyphens (from 1 to 255) Style, b60SpecCompliance, bSaveForSep,
none or 0 (zero) to specify no limit nTIFFOption

xZone Amount of space at end of line in which Parameter Values to Enter

hyphenation should occur (to a maxi-
mum of two inches) sFilename File to save image as

bLink True changes the link to the new file

Measurement units for scripts. If you do not
False keeps the link
specify a unit of measure (e.g., i for inches) for the
hyphenation zone (xZone), PageMaker uses the bProfile True includes color management profile
with image
default unit of measure, specified in the Prefer-
ences dialog box or with the MeasureUnits False does not include color manage-
ment profile with image
command.
bCropped True saves cropped image
Adjusting the margin rag. In general, the larger
the xZone, the fewer words PageMaker will False saves entire image
hyphenate and the more ragged the right margin nFormat 0 to save as TIFF
will be. Conversely, the smaller the xZone, the
(1 to save as JPEG)
more hyphenation will occur.
(2 to save as GIF)
Example. The following example tells PageMaker
(3 to save as DCS)
to hyphenate words containing discretionary
hyphens, as well as words in the user dictionary. It nCompression 0 for none
also specifies a limit of two hyphens per paragraph 1 for minimum
and a hyphenation zone (0.75 inches).
2 for maximum
hy phenation 2, 2, .75i 3 for maximum lossy (0-2 are lossless
compression; 3 is loss compression)

See also: nFormatStyle 0 for Base TIFF

The GetHyphenation query 1 Optimize for separation

2 Optimize for large images

b60SpecCompli True for strict compliance to the TIFF 6.0

ImageSaveAs ance specifications
Exports the selected image to the filename and False for an image that uses extensions
format specified. to the TIFF 6.0 specifications

Note. The ImageSaveAs command has four formats: bSaveForSep True saves for separation
TIFF, JPEG, GIF, and DCS. The version of Image- False saves composite
SaveAs that is used is determined by the nFormat
parameter.
 ADOBE PAGEMAKER 7.0 82
Commands

Parameter Values to Enter Parameter Values to Enter

nTIFFOption If bSaveForSep is TRUE, then nTIFFOp- nResolution 0 to keep the image at its current resolu-
tion indicates the Preview mode tion

0 for none 1 to save the image at 72 dots per inch

(dpi)
1 for best
bColorspace True to convert image to RGB from CMYK
2 for draft
False to keep colorspace unchanged
If bSaveForSep is FALSE, then nTIFFOp-
tion indicates the color depth

0 for two colors GIF

1 for 16 colors • ImageSaveAs sFilename, bLink, bProfile,
2 for 256 colors bCropped, nFormat, nTransparency, bInterlaced,
3 for millions of colors nColorPalette, nColorDepth, nResolution,
sCaption
Parameter Values to Enter
JPEG
• ImageSaveAs sFilename, bLink, bProfile, sFilename File to save image as

bCropped, nFormat, nQuality, nResolution, bLink True changes the link to the new file
bColorspace
False keeps the link
Parameter Values to Enter
bProfile True includes color management profile
sFilename File to save image as with image

False does not include color manage-

bLink True changes the link to the new file
ment profile with image
False keeps the link
bCropped True saves cropped image
bProfile True includes color management profile
False saves entire image
with image

False does not include color manage- nFormat (0 to save as TIFF)

ment profile with image (1 to save as JPEG)
bCropped True saves cropped image 2 to save as GIF
False saves entire image (3 to save as DCS)

nFormat (0 to save as TIFF) nTransparency 0 for none

1 to save as JPEG 1 for white
(2 to save as GIF) 2 for black
(3 to save as DCS) bInterlaced True for interlaced
nQuality 0 for low False for not interlaced
1 for medium nColorPalette 0 for exact
2 for high 1 for adaptive (dithered)
3 for maximum 2 for adaptive (no dither)

3 for Netscape

4 for System
 ADOBE PAGEMAKER 7.0 83
Commands

Parameter Values to Enter Parameter Values to Enter

nColorDepth 0 for 256 colors cDCSOption 0 mulitple files (default)

1 for 16 colors 1 single file

nResolution 0 to keep the image at its current resolu-

tion
Example. The following example saves the
currently selected image as a TIFF.
1 to save the image at 72 dots per inch
(dpi) i m a ge s ave a s " my i m a ge . t i f " , T RU E , FAL S E ,

sCaption Caption for GIF image

T RU E , 0 , 0 , 0 , T RU E , 1

DCS See Also:

• ImageSaveAs sFilename, bLink, bProfile, The ImageSaveForSep command
bCropped, nFormat [, cPreview, nCompos-
itePSSize, cPSEncoding, cDCSOption]
ImageSaveForSep fImage,
Parameter Values to Enter bUpdateLink, cPreview, nFileFormat,
sFilename File to save image as bCropped, bProfile, nCompression,
nDataFormat, b60SpecCompliance
bLink True changes the link to the new file
Saves the selected bitmap color image as either a
False keeps the link
CMYK or high-fidelity color image, based on
bProfile True includes color management profile settings in the Color Management System Prefer-
with image
ences dialog box, and the CMS Source Profile
False does not include color manage- dialog box.
ment profile with image
Parameter Values to enter
bCropped True saves cropped image

False saves entire image fImage Full path and name for the new color
image, in quotation marks (you must
nFormat (0 to save as TIFF) specify a new name; you cannot over-
write the existing image)
(1 to save as JPEG)
bUpdateLink 0 to leave image that is placed on page
(2 to save as GIF) linked to original file
3 to save as DCS 1 to link image that is placed on page to
the new, preseparated image
cPreview 0 for no preview

1 for 8-bit preview (default) cPreview 0 for None (no preview)

2 for 24-bit preview 1 for Draft

2 for Best
nCompositePS- 0 for no composite
Size nFileFormat 0 for save as a TIFF
1 for 72-dpi composite (default)

2 for full composite 3 for save as a DCS

cPSEncoding 0 uses ASCII on PC / Binary on Mac bCropped true for save as a cropped image
(default) false for save as a full image
1 uses ASCII on Mac / Binary on PC
 ADOBE PAGEMAKER 7.0 84
Commands

Parameter Values to enter Import fFilename, cAsWhat[, bRetain[,

bConvert[, bTags, bRetainCrop[, nFilters,
bProfile true include color management profile
with the image (sFltName, sFltOptions)...]]]]
false do not include profile Imports the specified graphic or text file and sets
how the object is to be placed.
nCompression 0 for none

1 for minimum Parameter Values to enter

2 for maximum lossless fFilename Exact name of file you want to import, in
quotation marks, including optional
3 for maximum lossy pathname to folder and disk (to a maxi-
mum of 91 characters for each name and
nDataFormat 0 for Base TIFF
path)
1 Optimize for separation
cAsWhat independent or newstory or 0 (zero)
2 Optimize for large images
replaceentire or inlinegraphic or 1
b60SpecCompli true for strict compliance with the 6.0
inserttext or replacetext or 2
ance TIFF specification

false for a TIFF that allows extensions to bRetain false or 0 (zero)

the 6.0 TIFF specification true or 1 to import text formatting with
document (default)
Restrictions. The ImageSaveForSep command
any or -3 or -1 to leave setting
separates only when: unchanged

• The selected image is a color bitmap image (not bConvert false or 0 (zero)
a monochrome or grayscale image, nor an image in true or 1 to convert quotation marks to
the PICT, EPS, or Windows metafile format). typographer's quotation marks (default)

• The selected image has a color management any or -3 or -1 to leave setting

unchanged
system and source profile assigned to it (in the
CMS Source Profile dialog box, the This Item Uses bTags false or 0 (zero) to disregard style-name
option is not set to None). tags, if any, and import the tags as nor-
mal text instead
• Color Management is turned on in the Color
true or 1 to format paragraphs using
Management System Preferences dialog box. style-name tags in document

any or -3 or -1 to leave setting

See also: unchanged

The GetObjectIDList, GetObjectList, GetSelec- bRetainCrop false or 0 (zero) to place entire image
tIDList, and GetSelectList queries (default)

true or 1 to place image using cropping

rectangle of image being replaced
(cAsWhat must be replaceentire)

nFilters Number of sFltName/sFltOptions pairs

that follow

For each filter:

sFltName Name of the filter to use, in quotation

marks, if the file is a correct type
 ADOBE PAGEMAKER 7.0 85
Commands

Parameter Values to enter To locate the correct name for sFltName, see the
list of installed filters displayed in the About
sFltOptions String composed of options specific to
PageMaker dialog box (select About PageMaker
the filter, in quotation marks. (Separate
each option within quotation marks by a while holding down the Control or Command
space.) key). The filter name must match the name in the
list, minus the version number.
Place new or independent stories. Using the
Word 6.0 import filter. To import an MS Word 6.0
Independent or NewStory keywords to import
file, use the table below to determine the correct
does not actually place the file on the page, but
filter name (sFltName):
displays the appropriate loaded icon. To specify the
placement of the file, use the Place command. To specify import preferences, include any of the
Immediate file placement. The ReplaceEntire,
following preference strings for sFltOptions.
InlineGraphic, InsertText, and ReplaceText Optional words are in brackets and represent the
keywords do not display a loaded icon; instead, the default setting. Enclose multiple preference strings
file is placed immediately. within the same set of quotation marks and
separate each with a space. (Refer to the Filters
cAsWhat: graphics or text. For the cAsWhat ReadMe.)
parameter, specify Independent, ReplaceEntire, or
InlineGraphic when importing graphic files. Preference string Action

Specify NewStory, ReplaceEntire, ReplaceText, or TOC [TRUE] Import TOC Entries from
InsertText when importing text files. Outline selected

nFilters, sFltName, and sFltOptions parameters. TOC FALSE Import TOC Entries from
Outline turned off
PageMaker automatically suppresses the filter-
option dialog boxes of certain filters when INDEX [TRUE] Import Index Entry Fields
importing through a plug-in. For some filters, you selected
can specify import options using the sFltName and INDEX FALSE Import Index Entry Fields
sFltOptions parameters. The options are specific to turned off
the named filter and replace those listed in that SPACING SET_WIDTH Horizontal Scale selected for
filter's dialog box. (At this writing, only two filters Import Con-
accept import options from the Import command: densed/Expanded Spacing
As
the Text-only import filter and the Kodak Photo
CD import filter.) SPACING [MAN_KERN] Kerning selected for Import
Condensed/Expanded Spac-
Note that the sFltName parameter does not dictate ing As
which filter PageMaker must use to import the file.
SPACING TRACK_KERN Tracking selected for Import
(In fact, you can list more than one set of filter and Condensed/Expanded Spac-
options.) sFltOptions indicates the options ing As
PageMaker should use only if the specified file is
PG_BRK_BEFORE [PG_BRK] As Page Break Before
the correct type for the named filter. Regardless of selected for Import Page
the filters or options you specify, PageMaker always Break Before Paragraph
imports a file using the most appropriate filter for PG_BRK_BEFORE COL_BRK As Column Break Before
that file (based on the file extension of Windows selected for Import Page
files and the file type of Macintosh files). Break Before Paragraph

PG_BRK_BEFORE FALSE Import Page Break Before

Paragraph turned off
 ADOBE PAGEMAKER 7.0 86
Commands

Preference string Action The following table lists the measurement abbrevi-
ations you use to specify the units in the strings
TABLES [TRUE] Import Tables selected
OUTPUT_WIDTH and OUTPUT_HEIGHT:
TABLES FALSE Import Tables turned off
System Abbreviation Example

The following example illustrates importing the Inches i after 5.625i

file "wd6file.doc" using these Word 6 filter options: Millimeters m after 25m
• Import TOC Entries from Outline not selected Picas p after 18p
• Import Index Entry Fields not selected Points p before p6
• Tracking selected for Import Picas and points p between 18p6
Condensed/Expanded Spacing As
Ciceros c after 5c
• Import Page Break Before Paragraph not selected
Ciceros and didot c between 28c6
• Import Tables selected points
impor t "hard dr ive: files: wd6file.doc", newstor y,
t r ue, t r ue, false, false, 1, "MS Word 6 for Note: Do not insert a space between the
Ma cin to sh", "TO C FA L S E I N D E X FAL S E measurement and the abbreviation.
SPACING TRACK_KERN PG_BRK_BEFORE
Example. The following example imports a text
FA L S E TA B L E S TRU E "
file, places it at the insertion point, retains the
word-processing style sheet used when the text file
Text-only filter. To specify import options for a
was created, converts straight quotation marks to
text-only file, use "Text-only" for sFltName, and for
typographer's quotation marks, and does not read
sFltOptions, use the following strings. Enclose
style-name tags.
multiple options within the same set of quotation
marks and separate each with a space. impor t "mydisk:my folder :my file", independent,
t r u e , t r u e , f a ls e
Kodak Photo CD import filter. To specify import
The following example imports the "World
options for the Kodak Photo CD filter, specify
View.pcd" graphics file. If the Kodak Photo CD
"Kodak Photo CD" for sFltName, and for sFltOp-
import filter is used, the image is imported in RGB
tions, specify a combination of the following
format with a 2048 by 3072 pixel resolution.
strings (case is not important). Enclose the options
within the same set of quotation marks and Im por t "HD200:World Vi ew.pcd", independent,
separate each with a space. t r u e , t r u e , f a l s e , f a l s e , 1 , " Ko d a k P h o to C D " ,
" r gb 2 0 4 8 x 3 0 7 2 "

See also:
The Place command
The GetImportFilters query
 ADOBE PAGEMAKER 7.0 87
Commands

Indents xLeftIndent, xFirstIndent, IndexAuto

xRightIndent Indexes the selected text by inserting an index
Specifies the left, first-line, and right indents for marker before the text and adding the selection to
paragraphs. The extent of the action depends on the index.
which tool is active, whether any text is selected,
Select the text first. Select the text you want to
and whether a publication is open when the
appear in the index before you execute this
command is executed.
command.
Parameter Values to enter
Example. The following example selects the word
xLeftIndent Indent from left edge of text block (from following the insertion point, inserts an index
0 to a maximum of 21 inches) marker, and adds the selected word to the index.
xFirstIndent Indent of first line of a paragraph relative tex t s e l e c t + wo rd
to xLeftIndent value (from -21 inches to a
indexauto
maximum of 21 inches)

xRightIndent Indent from right edge of text block

(from 0 to a maximum of 21 inches) See also:
The CreateIndex, IndexAutoName, and IndexFor-
Measurement units for scripts. If you do not mat commands
specify a unit of measure (e.g., i for inches),
PageMaker uses the default unit of measure,
specified in the Preferences dialog box or with the IndexAutoName
MeasureUnits command. Indexes the selected text as a proper name. Inserts
Hanging indents. For hanging indents, specify a an index marker before the text and adds the
negative number for the xFirstIndent value. selection as an entry to the index, placing the first
word after the remaining words and separating the
xFirstIndent and xLeftIndent values. The value of
last two words with a comma (for example, the
xFirstIndent may be less than the value of xLeft-
index entry for "Frida Kahlo" would become
Indent. Together they must be greater than or
"Kahlo, Frida").
equal to 0 (zero).
Select the text first. Select the text you want to
xLeftIndent and xRightIndent values. The value
appear in the index before you execute this
of xLeftIndent plus xRightIndent should not
command.
exceed the width of the column.
Indexing names. To index a name composed of
Example. The following example indents text
more than two words, insert a nonbreaking space
one-half inch from the left edge of the text block in
(option + spacebar) between the words you want
a publication. It also indents the first line of the
to keep together. For example, to have Vincent van
text an additional quarter of an inch. It does not
Gogh appear as "van Gogh, Vincent" in the index,
indent text from the right edge of the text block.
replace the space between "van" and "Gogh" with a
indents 0.5i, 0.25i, 0i nonbreaking space.
Example. The following example selects two
See also: words, inserts an index marker before the first
The MeasureUnits command word, and adds both words to the index, reversing
their order and separating them with a comma.
The GetIndents query
tex t s e l e c t + wo rd
 ADOBE PAGEMAKER 7.0 88
Commands

tex t s e l e c t + wo rd Creating a new index. To start a new index, the

indexautoname CreateIndex command must precede the Index-
Format command.
See also: Format application. If an index story is open,
The CreateIndex, IndexAuto, and IndexFormat these format settings will apply to only that story.
commands If no publication is open, the settings will become
the default for all indexes until they are changed
again.
IndexFormat bHeadings, bEmpties, Example. The following example results in the
cFormat, sFollow, sBetPgeNmbrs, index-format example shown in the Index Format
sBetEntries, sPageRange, sBeforeXRef, dialog box above.
sEnd
index for mat 1, 0, nested, "^>^>", ",^>", ";^>",
Specifies all the format settings for an index. "^=", ".^>"

Parameter Values to enter

bHeadings off or 0 (zero) See also:

on or 1 to include index section headings The CreateIndex command

bEmpties off or 0 (zero)

on or 1 to include empty index sections InkND sName, cAction[, dNDValue]

cFormat nested or 0 (zero) Sets or resets the neutral-density value for an ink,
runin or 1 whether a process ink or a spot color. Setting
overrides the calculated neutral-density value
sFollow Characters that separate index entry
PageMaker would normally use for that ink (a spot
from first page number (to a maximum of
seven characters; a typical value is two en color's ND value is derived from its CMYK equiv-
spaces) alent).
sBetPgeNmbrs Characters that separate page number Parameter Values to enter
references, in quotation marks (to a max-
imum of seven characters; a typical value sName Name of ink or spot color (no tints), in
is a comma and an en space) quotation marks

sBetEntries Characters that separate secondary cAction 0 or inknddefault to reset to the calcu-
entries in a run-in format (to a maximum lated default value
of seven characters: a typical value is a
semicolon and an en space) 1 or inkndset to customize the neutral-
density value for the color
sPageRange Characters that separate start and end of
a page range, in quotation marks (to a dNDValue Neutral density for the ink (to 3 decimal
maximum of seven characters; a typical places, if necessary), from 0.000 to 10.000
value is an en dash)

sBeforeXRef Characters before a cross-reference Tints. You cannot set the neutral-density value of
entry, in quotation marks (to a maximum a tint, only of its root color. To calculate the
of seven characters; a typical value is a neutral-density value for a tint, PageMaker
period and an en space)
multiples the neutral density of the root color by
sEnd Characters at end of entry, in quotation the tint's percentage of the root color.
marks (to a maximum of seven charac-
ters; a typical value is no character)
 ADOBE PAGEMAKER 7.0 89
Commands

Example. The following example sets the neutral- Master pages optional. If you do not specify a
density value of spot color "Red" to 2.15. right master page, the command applies the left
master to any right pages you insert. If you do not
i n k n d " Re d " i n k n d s e t 2 . 1 5
specify either a left or right master page, the
InsertPages command applies the Document
See also: Master to the pages.
The TrapSettings command Example. The following example inserts four
The GetTrapSettings, and GetInkND queries pages after the current page, applies Ad Layout to
left pages, and applies Editorial master to right
pages.
InsertPages nHowMany, cWhere[,
inser t pages 4, after, "Ad Layo ut", "Editor ial"
sLMOrSnglMaster[, sRMasterName]]
Specifies the number of pages to insert and where
they are to be inserted in the open publication. InvalidateRect xLeft, yTop, xRight,
Parameter Values to enter yBottom
nHowMany Number of pages to insert Instructs PageMaker to redraw the specified area of
the screen the next time PageMaker updates the
cWhere before or 0 (zero) for before current
screen.
page

after or 1 for after current pages Parameter Values to enter

between or 2 for between current xLeft x coordinate (in device coordinates) of

pages top-left corner

sLMOrSnglMaster Name of master page, in quotation yTop y coordinate (in device coordinates) of
marks, to apply to left pages (or to sin- top-left corner
gle pages for single-sided publications)
xRight x coordinate (in device coordinates) of
"" (empty quotation marks) if inserting bottom-right corner
only a right page
yBottom y coordinate (in device coordinates) of
sRMasterName Name of master page, in quotation bottom-right corner
marks, to apply to right pages

"" (empty quotation marks) for single-

sided publications or if you are insert-
ing only a left page

Maximum page count is 999. You can have as

many as 999 pages in a single PageMaker publi-
cation, depending on available disk space.
Zero pages defaults to one or two. If you set
nHowMany to zero, PageMaker inserts either one
or two pages, depending upon the Facing Pages
setting in the Document Setup dialog box.
Layout view only. The InsertPages command
works only in layout view.
 ADOBE PAGEMAKER 7.0 90
Commands

Specifying coordinates. Specify x and y coordi-

nates relative to the top-left corner of the screen.
Layout view only. The InvalidateRect command
works only in layout view.
Example. The following example instructs
PageMaker to redraw the rectangle defined by the
top-left corner coordinates (200, 300) and the
bottom-right corner coordinates (600, 500) the
next time PageMaker updates the screen.
i nv a l i d a te re c t 2 0 0 3 0 0 6 0 0 5 0 0

See also:
The Cut, Delete, Select, and SelectAll commands
 ADOBE PAGEMAKER 7.0 91
Commands

Kern obsolete command; see KernText Parameter Values to Enter

command
bShow True to show the layer
The KernText command replaces the Kern
False to hide the layer
command.
-2 to leave unchanged

bLock True to lock the layer

KernText nAmount False to unlock
Kerns the selected text by the specified amount. -2 to leave unchanged

Parameter Values to enter nColorIndex Colors for object handles, indicating

that the object is on this layer
nAmount Amount to kern, in ems (up to three dec-
imal places; from -1.000 to 1.000). A neg- Predefined Color nColorIndex
ative value kerns the letters closer
together. Black 0

Red 1
Select text with TextSelect command or text tool.
To use this command, you must select the text Green 2

(two or more characters) with the TextSelect Blue 3

command (or the text tool). If no text is selected,
Yellow 4
PageMaker kerns the two letters on either side of
the insertion point. Magenta 5

KernText replaces Kern. The KernText command Cyan 6

replaces the Kern command. Gray 7
Example. The following example kerns the Light Blue 8
selected text five hundredths (0.05) of an em
Orange 9
closer together.
Dark Green 10
ker n text - . 05
Teal 11

See also: Tan 12

The ManualKerning, TextSelect and Track com- Brown 13

mands
Violet 14
The GetKernText and GetTrack queries
Gold 15

Dark Blue 16
LayerOptions sLayerName,
Pink 17
sNewName, bShow, bLock, nColorIndex,
nRed, nGreen, nBlue Lavender 18

Changes the attributes for a layer. Brick Red 19

Parameter Values to Enter Olive Green 20

sLayerName The name of the layer to change Peach 21

sNewName The new name for the layer, "" leaves Burgundy 22
the name unchanged
 ADOBE PAGEMAKER 7.0 92
Commands

Parameter Values to Enter LockLayers bLock

Grace Green 23 Performs either a Lock Others function, which
locks all but the target layer, or an Unlock All
Ochre 24
function.
Purple 25
Parameter Values to Enter
Light Gray 26
bLock Off or 0 for all the layers to be unlocked
Other... customcolorindex, "customcolorin-
dex" On or 1 for all the layers, except the target
layer, to be locked
nRed Red values for custom handle color

nGreen Green values for custom handle color Example. The following example unlocks all of
the layers.
nBlue Blue values for custom handle color
locklayers 0
Note. On the Macintosh, the red, green, and blue
values range from 0 to 65535. On Windows, the red, See Also:
green, and blue values range from 0 to 255. For
The AssignLayer, DeleteLayer, DeleteUnusedLay-
custom colors, nColorIndex has the value custom-
ers, LayAdjOpts, LayerOptions, MoveLayer, New-
handlecolor; otherwise values range from 0 to
Layer, PasteRemembers, SelectLayer, ShowLayers,
customhandlecolor. and TargetLayer commands
Example. The following example renames a The GetLayerFromID, GetLayerList, GetLayerOp-
layer and sets options so that its objects are tions, GetPasteRemembers, and GetTargetLayer
visible, locked, and have orange handles. queries
Because one of the default colors is being used,
the values for red, green, and blue are unused
and left at 0. LayAdjOpts nSnapToZone, bResizeOK,
bIgnoreLocks, bIgnoreGuides,
layeroptions "MyLayer", "Altered", TRUE,
TRU E , 9, 0, 0, 0
bMoveGuides, bKeepGuidesAligned
Changes the preferences for layout adjustment.

See Also: Parameter Values to Enter

The AssignLayer, DeleteLayer, DeleteUnusedLay- nSnapToZone The maximum distance over which an
ers, LockLayers, MoveLayer, NewLayer, PasteRe- object will snap to a guide
members, SelectLayer, ShowLayers, and
bResizeOK True resizes groups and imported graph-
TargetLayer commands ics to fit
The GetLayerFromID, GetLayerList, GetLayerOp- False retains current size of groups and
tions, GetPasteRemembers, and GetTargetLayer imported graphics
queries
bIgnoreLocks True moves locked objects with layout

False does not move locked objects with

layout

bIgnoreGuides True ignores ruler guides

False keeps objects aligned with ruler

 ADOBE PAGEMAKER 7.0 93
Commands

Parameter Values to Enter Layer, PasteRemembers, SelectLayer, ShowLayers,

and TargetLayer commands
bMoveGuides True moves ruler guides with layout
The GetLayerFromID, GetLayerList, GetLayerOp-
False does not move ruler guides with tions, GetPasteRemembers, and GetTargetLayer
layout queries
bKeepGuide- True keeps ruler guides aligned to the
sAligned columns

False does not keep ruler guides aligned Leading dPoints

to the columns Specifies the leading for text. The extent of the
action depends on which tool is active, whether
Example. The following example sets the snap-to
any text is selected, and whether a publication is
zone to 0.016 inches and turns on the options for
open when the command is executed.
resizing graphics. It ignores object and layer locks,
ignores moving ruler guides, and keeps the ruler Parameter Values to enter
guides aligned. It turns off the option to ignore dPoints Point size, from 0 to 1300 points, includ-
ruler guides. ing tenths of a point

laya djopts 0.016i, TRUE, TRUE, FALSE, TRUE, auto or -1 for automatic leading
TRU E
Automatic leading specifications. If you specify
automatic leading, PageMaker creates leading 20%
See also:
larger than the type size. For example, 10-point
The AssignLayer, DeleteLayer, DeleteUnusedLay- type is automatically assigned 12 points of leading.
ers, LockLayers, MoveLayer, NewLayer, PasteRe-
To change this percentage, choose the Paragraph
members, SelectLayer, ShowLayers, and
command from the Type menu, click the Spacing
TargetLayer commands
button, and then type a new value in the
The GetLayerFromID, GetLayerList, GetLayerOp-
Autoleading edit box. You can also use the
tions, GetPasteRemembers, and GetTargetLayer
SpaceOptions command.
queries
Leading measurements. The way leading is
measured depends on the type of leading that is
LayerPalette bState currently specified (e.g., Proportional, Top of caps,
Displays or hides the palette that contains the or Baseline). To set the leading type, use the
layers panel. SpaceOptions command.
dPoints truncated. If dPoints includes more than
Parameter Values to Enter
one decimal place, PageMaker truncates the value
bState True displays the palette to tenths of a point. For example, 12.44 becomes
False hides the palette 12.4 points.
Example. The following example specifies 16.5
Example. The following example displays the
points of leading.
palette that contains the layers panel.
leading 16.5
l ayer p a l e t te 1

See also:
See also:
The SpaceOptions command
The AssignLayer, DeleteLayer, DeleteUnusedLay-
The GetLeading query
ers, LayAdjOpts, LockLayers, MoveLayer, New-
 ADOBE PAGEMAKER 7.0 94
Commands

LetterSpace dLetterMin, Example. The following example specifies letter

dLetterDesired, dLetterMax spacing that causes PageMaker to narrow the
distance between characters by subtracting as
Sets the space from the left edge of one letter to the
much as 5% of the space band or to widen the
left edge of the next letter. The extent of the action
distance by adding up to 25% of the space band.
depends on which tool is active, whether any text is
selected, and whether a publication is open when le t te r s p a ce - 5 , 0 , 2 5
the command is executed.

Parameter Values to enter See also:

dLetterMin Minimum space between letters,
The GetLetterSpace query
expressed as a percentage (from -200 to
200)

dLetterDesired Desired space between letters,

Line x1, y1, x2, y2
expressed as a percentage (from -200 to Draws a line from the point specified by the x1 and
200)
y1 coordinates to the point specified by x2 and y2
dLetterMax Maximum space between letters, coordinates.
expressed as a percentage (from -200 to
200) Parameter Values to enter

x1 x-axis coordinate of the first end point

dLetterDesired measurements. The amount of
space from the left edge of one letter to the left edge y1 y-axis coordinate of the first end point

of the next letter is called the "pen advance" x2 x-axis coordinate of the second end
distance. The dLetterDesired is measured by the point
percentage of the space band that is added to or y2 y-axis coordinate of the second end
subtracted from the pen advance. point

Specifying related values. Make sure that

dLetterMin is less than or equal to the Measurement units for scripts. If you do not
percentage set for dLetterDesired, and that specify a unit of measure (e.g., i for inches),
dLetterMax is greater than or equal to the PageMaker uses the default unit of measure,
percentage set for dLetterDesired. specified in the Preferences dialog box or with the
MeasureUnits command.
The values for dLetterMin and dLetterMax create
the range within which PageMaker can space Line locations. Horizontal lines hang down from
letters in a line of justified text. the points specified, vertical lines hang right from
the points specified, and others are centered
All three parameters required. Values for all between the points specified.
three parameters must be specified.
Decimal values rounded up. Unlike the equiv-
alent options in the Spacing Attributes dialog
box, the LetterSpace command accepts decimal
values. However, PageMaker rounds decimal Layout view only. Use the Line command only in
values for these parameters up to the nearest layout view.
whole number. For example, 50.1 becomes 51%.
 ADOBE PAGEMAKER 7.0 95
Commands

Example. Assuming the rulers' zero point is at

Parameter Values to enter
the upper-left corner of the page, the following
example draws a horizontal line starting one inch mediumdash or 14

from the left edge of the page, two inches down thickdash or 15
from the top, and stopping eight inches from the
left edge of the page. squares or 16

l i n e (1i, 2i ), (8i, 2i ) dots or 17

customsolid or 31 for a solid

See also: line of weight specified by
dWeight
The LineStyle, ZeroPoint, and the ZeroPointReset
commands bReverse off or 0 (zero, default setting)
for normal
The GetLineStyle and GetZeroPoint queries
on or 1 to reverse line

dontcare or -2 to leave
LineStyle cStyle[, bReverse[, dWeight[, reverse setting unchanged

bOpaque]]] dWeight Weight of custom line in

points (precise to one deci-
Applies a line style to the selected line, box, or oval;
mal point, from 0.1 to 800
or, sets the line style of the next object drawn. points)

Parameter Values to enter -2 to leave line weight

unchanged or for pre-
cLineStyle dontcare or -2 to leave the defined line weights (e.g.,
line style unchanged hairline)

none or 0 (zero) bOpaque off or 0 to make transparent

backgrounds for compound,
hairline or 1 dashed, or dotted lines
(default setting)
halfpoint or 2
on or 1 to make opaque
backgrounds for compound,
onepoint or 3
dashed, or dotted lines

twopoint or 4 dontcare or -2 to leave back-

ground unchanged
fourpoint or 5
Line weight. The exact weight of printed lines
sixpoint or 6
depends upon the resolution of your printer.
eightpoint or 7 Dontcare or -2 for single object only. Use
twelvepoint or 8 dontcare or -2 only if a single object is selected. If
multiple objects are selected, you must set all the
thinthin or 9 LineStyle attributes for the objects; you cannot
leave certain attributes unchanged. For example,
thickthin or 10
you cannot change just the color.
thinthick or 11
Reversing lines. If multiple lines with different
thinthickthin or 12 weights are selected, then linestyle -2, 1 sets them
all to reverse without affecting weights.
thindash or 13
 ADOBE PAGEMAKER 7.0 96
Commands

Conversely, if multiple lines with mixed reverse Layout view only. The LinkFrames command
and nonreversed styles are selected, then linestyle works only in layout view.
3, -2 will set their weights without affecting the
reverse style. See Also:
dWeight parameter overrides cStyle. Set the The AttachContent, BreakLinks, DeleteContent,
dWeight parameter to -2 unless you are defining a FrameContentPos, FrameInset, SeparateContent,
custom line. The value of dWeight overrides the and ToggleFrame commands
line weight specified in cStyle. The GetFrameContentPos, GetFrameInset, GetFr-
dWeight truncated. If dWeight includes more ameContentType, GetIsFrame, and GetNext-
Frame queries
than one decimal place, PageMaker truncates the
value to tenths of a point. For example, 12.199
becomes 12.1 points.
LinkOptions bUpdAutoText,
Text tool, story editor, or no object. If the text bAlert1stText, bStoreInPub,
tool is active, the Line Style command results in an bUpdAutoGrph, bAlert1stGrph[,
error. If either the story editor is active or no bDefault]
PageMaker objects are selected, the specified line
Sets the link options of the currently selected
style becomes the default line for the publication.
graphic or text block; if nothing is selected, deter-
Example. The following example selects the first mines how subsequently placed graphics and text
object drawn and applies a line style that is four are stored and updated.
points wide and reversed. It then selects the
Parameter Values to enter
second object drawn and applies a custom
weight of 2.5 points. The line background is bUpdAutoText false or 0 (zero)
transparent. true or 1 to automatically update publi-
cation upon opening if linked text has
select 1
been modified; if graphics are selected,
l i n est y l e fo u r p o in t, t r u e this parameter is ignored
select 2
bAlert1stText false or 0 (zero)
l i n est y l e cu sto mso l id , fa l se, 2. 5, f a ls e
true or 1 to alert user before PageMaker
automatically updates modified text (if
See also: bUpdAutoText is set to 1); if graphics are
selected, this parameter is ignored
The FillAndLine and Line commands
bStoreInPub false or 0 (zero)
The GetFillAndLine and GetLineStyle query
true or 1 to store linked graphic in publi-
cation (not necessary for text or EPS files,
which are already stored in publication);
LinkFrames nNumFrames, nObjectID1, if text is selected, this parameter is
nObjectID2, [nObjectID3 ... nObjectIDN] ignored

Links the specified frames. bUpdAutoGrph false or 0 (zero)

Parameter Values to Enter true or 1 to automatically update publi-

cation upon opening if linked graphic
nNumFrames Number of frames in the list has been modified; if text is selected, this
parameter is ignored
nObjectID Unique ID for a frame to be linked
 ADOBE PAGEMAKER 7.0 97
Commands

Text tool, story editor, or no selection. The Lock

Parameter Values to enter
command has no affect when the text tool is
bAlert1stGrph false or 0 (zero) selected, while in story editor, or when no objects
true or 1 to alert user before PageMaker are selected.
automatically updates a modified
graphic (if bUpdAutoGrph is set to 1); if Locking freezes position and size, not attributes.
text is selected, this parameter is ignored Locking freezes the object position and size so that
bDefault false or 0 (zero) to set link options for it cannot be deleted, moved, or transformed. The
selected object or, if in story editor, for command does not lock other attributes of an
current story (default) object, such as the color, line style, and fill for
true or 1 to set default link options for PageMaker-drawn graphics, or point size and
publication paragraph style for text within a text block. The
following commands have no affect on locked
Link status checked upon open and print.
objects: Cut, Clear, Crop, Delete, Move, Nudge,
PageMaker checks the status of linked files each
Reflect, Resize, ResizePct, Rotate, and Skew.
time a publication is opened or printed.
Inline graphics. Locking an inline graphic freezes
Setting default options. If bDefault is 1, or no
the graphic's size and baseline, not its position on
objects are selected, the LinkOptions commands
the page.
sets the default options for the publication. If no
publication is open, the command sets the Example. The following example unlocks all the
PageMaker default link options, which apply to objects on the page.
any publications created subsequently. selectall
Example. The following example sets the publi- lock 0
cation default link-options so that PageMaker
alerts the user first, then automatically updates all See also:
subsequently placed text and graphics and stores
The GetLock query
graphics outside the publication.
linkoptions 1, 1, 0, 1, 1, 1
LockGuides bState
See also: Locks or unlocks column and ruler guides in
place.
The GetLinkInfo, GetLinkOptions, and GetLinks
queries Parameter Values to enter

bState off or 0 to unlock guides

Lock bLockStatus on or 1 to lock guides

Changes the lock status of the selected objects.

Layout view only. Use the LockGuides command
Parameter Values to enter only in layout view.
bLockStatus off or 0 (zero) to unlock the position of Example . The following example unlocks the
selected objects
column and ruler guides, allowing them to be
on or 1 to lock the position of selected moved.
objects
lockguides 0
 ADOBE PAGEMAKER 7.0 98
Commands

See also: Mask [nMaskObjectID]

The Guides, PageSize, and Rulers commands Masks the selected objects, using either the
The GetLockGuides query specified object as the mask, or, if no object is
specified, the top-most selected box, oval, or
polygon (drawn in PageMaker).
ManualKerning cHowMuch
Parameter Values to enter
Changes the kerning for the selected text or the
pair of characters separated by the insertion nMaskObjectID Object ID of PageMaker-drawn box, oval,
or polygon to use as mask
point.

Parameter Values to enter nMaskObjectID. While you can mask any object

cHowMuch none or 0 to clear range kerning

on the page, you can use only PageMaker-drawn
boxes, ovals, or polygons as the masking object. If
closerfine or 1 for 1/100 em closer
nMaskObjectID is not the ID of a PageMaker-
apartfine or 2 for 1/100 em apart drawn box, oval, or polygon, the Mask command
closercoarse or 3 for 1/25 em closer does nothing.
apartcoarse or 4 for 1/25 em apart Example. The following example selects two
objects and masks them with the specified object
Track compared to ManualKerning. To adjust (object number eight).
spacing across a line of text, such as a heading, use
select (column 1 left, co lumn top)
the Track command. Then use ManualKerning, if
s e l e c texten d ( co l u m n 1 r i g h t , col u m n top )
necessary, to adjust the spacing between specific
mask 8
pairs of letters.
Use the text tool to select. To use the ManualK-
See also:
erning command, you must select the text (two or
more characters) using the text tool. If no text is The Unmask command
selected, PageMaker kerns the characters on either The GetGroupList, GetObjectIDList, GetObjec-
side of the insertion point. tIDListTop, GetSelectIDList, and GetSelectIDList-
Top queries
Layout view only. Use the ManualKerning
command only in layout view.
Example. The following example kerns the MasterGuides
selected text characters 0.01 of an em closer. Resets the column and ruler guides on the current
manualker ning closerfine page to match those on the master page or pages.
Changes to display. The MasterGuides command
See also: resets the guides on the screen only if they have
been changed from their preset (or master)
The KernText and Track commands
positions.
The GetKern and GetTrack queries
Layout view only. Use the MasterGuides
command only in layout view.
Example. The following example copies the
guides from the master pages to the current page.
masterguides
 ADOBE PAGEMAKER 7.0 99
Commands

See also: MasterPage sLeftMaster,

The MasterItems command sRightMaster[, sRange][, bKeepGuides]
The GetMasterItems query [, bKeepColumns][, bAdjustLayout]
Applies the named master pages to the range of
pages specified (or to the current pages if you do
MasterItems bState not include a range).
Displays or hides all text and graphics from the
Parameter Values to enter
master page or pages on the current page.
sLeftMaster Name of master page, in quotation
Parameter Values to enter marks, to apply to left pages (or to single
pages for single-sided publications)
bState off or 0 to hide master itemson or 1 to
display master items "" (empty quotation marks) to leave left
page unchanged or if applying master to
right page only
No effect on nonprinting guides or rulers.
Nonprinting ruler and column guides are not sRightMaster Name of master page, in quotation
marks, to apply to right pages
affected by setting MasterItems on or off. Use
MasterGuides to reset the column and ruler guides "" (empty quotation marks) to leave right
page unchanged or for single-sided pub-
to match those on the master page or pages. lications
Layout view only. Use the MasterItems command sRange Range of pages to apply masters to, in
only in layout view. quotation marks (e.g., "1-5, 17-21, 44-49")

Example. The following example displays all "all" (quotation marks required) to apply
specified masters to all pages
text and graphics from the master pages on the
current page. "" (empty quotation marks) to apply
specified masters to the current page or
master items on pages (default action)

bKeepGuides true Pages to which no master page is

applied ("None" is applied) keep ruler
See also: guides
The MasterGuides command false Ruler guides are removed
The GetMasterItems query
bKeepColumns true Pages to which no master page is
applied ("None" is applied) keep their
column guide settings

false Column guide settings are

removed

bAdjustLayout true automatically adjust the page lay-

out to the new master page

false do not adjust the page layout to the

new master page
 ADOBE PAGEMAKER 7.0 100
Commands

Specifying ranges. The value of sRange can be a See also:

single range (e.g., "1-10") or several ranges (e.g., The GetMasterPagePalette query
"1-5, 8-10, 13-14"). Use commas to separate the
ranges. A maximum of 64 characters is allowed.
The range must be valid or PageMaker returns an MeasureUnits cMeasurement,
error (e.g., you can't specify "1-14" for a 10-page cVertical, dCustomPoints
publication).
Specifies the default measurement system used for
None and Document master. To apply None or the open publication settings or, if no publication
Document master to a page, do not include the is open, for future publications.
brackets that enclose the names in the menu. For
example: Parameter Values to enter

master page "None", "Document master", "5-10" cMeasurement Measurement system for the horizontal
ruler and for all coordinates (x- and y-
axis), as specified with these values:
Example. The following example applies "Ad
inches or 0 (zero)
layout" to left pages and "Editorial" master to right
pages, for the pages from 1 to 100. Ruler guides are inchesdecimal or 1

retained for pages to which no master is applied, millimeters or 2

column settings are removed, and the page layout picas or 3
is adjusted to match the new master pages.
ciceros or 4
master page "Ad layo ut", "Editor ial", "1-100",
cVertical Measurement system for the vertical
t r u e, fa l se, t r u e ruler, but not for vertical (y) axis coordi-
nates, as specified with these values:

See also: inches or 0 (zero)

inchesdecimal or 1
The DefineMasterPage, DeleteMasterPage,
RenameMasterPage, and SaveAsMasterPage com- millimeters or 2
mands picas or 3
The GetMasterPage, GetMasterPageInfo, and Get-
ciceros or 4
MasterPageList queries
custom or 5

dCustomPoints Space, in points, between major tick

MasterPagePalette bState marks on the vertical ruler if cVertical is
custom or 5
Displays or removes the Master Pages palette.
default or -1 if not defining a custom
Parameter Values to enter vertical ruler (cVertical is not custom or 5)

bState off or 0 to close the Master Pages palette

Matching ruler and text leading. If you specify
on or 1 to open the Master Pages palette.
custom for the cVertical parameter, you can set the
vertical ruler to match your leading by specifying
Layout view only. Use the MasterPagePalette the leading value for dCustomPoints. Then, if
command only in layout view. SnapToRulers is set to on and the paragraph is set
Example. The following example turns the Master to proportional leading, the baseline of the text will
Page palette on. align with tick marks on the ruler.

master pagepalette 1
 ADOBE PAGEMAKER 7.0 101
Commands

dCustomPoints truncated. If dCustomPoints See also:

includes more than one decimal place, PageMaker The Revert, Save, and SaveAs commands
truncates the value. For example, 12.44 becomes
12.4 points.
Example. The following example specifies milli- Move cHandle, xyLocation
meters for the publication measurement system Moves the selected object to the specified
and a custom vertical ruler with major tick marks location, aligning the designated handle to the
at 12-point intervals. new location.
measureunits 2, custom, 12 Parameter Values to enter

cHandle Handle to drag when moving object:

See also:
Side handles:
The Leading and SnapToRulers commands
left or 0
The GetMeasureUnits query
right or 2

top or 3
MiniSave bottom or 4
Saves a copy of changes made to the open publi- Center of object:
cation and appends those changes to the original
center or 1
file.
Corner handles:
Automatic minisave. PageMaker automatically
appends any changes to the open publication lefttop or topleft or 5

whenever the plug-in, script, or user moves to leftbottom or bottomleft or 6

another page, clicks the current page icon, prints, righttop or topright or 7
copies, inserts or deletes a page, or changes the
rightbottom or bottomright or 8
page setup.
xyLocation x or y coordinate to which the object is to
File size control. The MiniSave command can be aligned; if cHandle is a corner (that is,
save changes to the publication, while still allowing lefttop, leftbottom, righttop, or rightbot-
tom), both the x and y coordinates are
PageMaker to undo those changes entirely with the
required
Revert command. However, each time PageMaker
executes the MiniSave command, the publication
Measurement units for scripts. If you do not
file grows. The file also grows with each use of the
specify a unit of measure (e.g., i for inches),
Save command. To compress the publication to its
PageMaker uses the default unit of measure,
smallest size, use SaveAs.
specified in the Preferences dialog box or with the
Selected objects deselected. The MiniSave MeasureUnits command.
command deselects any selected objects. It does
Layout view only. Use the Move command only in
not, however, deselect highlighted text (text
layout view.
selected with the text tool or TextSelect
command). Moving lines. When moving a line, the only valid
values for cHandle are:
Example.
center or 1 for the midpoint of the line
min isave
lefttop or 5 for the starting point of the line
 ADOBE PAGEMAKER 7.0 102
Commands

rightbottom or 8 for the end point of the line MoveColumn nColumnNum, cSide,
xLocation[, cPage]
Moves a left or right column guide to the
specified location.

Parameter Values to enter

Baseline moved to new location. When speci-
nColumnNum Specifies the column number (columns
fying the xyLocation, be aware that PageMaker are numbered sequentially from left to
moves the baseline of the first line of text to the right)
specified coordinates; it does not position the text cSide left or 0 for the left guide of the column
using the top of the text block.
right or 2 for the right guide of the col-
cHandle for transformed objects. If the selected umn
object has already been skewed, rotated, or xLocation x-axis coordinate where the column
reflected, cHandle should correspond to the guide is to be located
handle before the object was transformed. For
cPage leftpage or 1 to move the column on the
example, lefttop always refers to the original left- left page only (this is the default)
top handle of an object, not the handle that is
rightpage or 2 to move the column on
currently the left-most top handle. the right page only (or for single pages)

0 for both pages

Measurement units for scripts. If you do not

specify a unit of measure (e.g., i for inches),
Examples. The following example selects an PageMaker uses the default unit of measure,
object and moves it so its left edge aligns to the specified in the Preferences dialog box or with the
third vertical guide. MeasureUnits command.
select 1 Column relationship is constant. The space
move left, guide 3 between columns remains constant when you
The following example selects an object and moves move a column guide. Therefore, if you move the
it to a location where its top-right corner aligns to right guide of a column, you move the left guide of
the x-axis coordinate (7.5 inches) and to the y-axis the adjacent column. Only the left guide of the left-
coordinate (the top of the column). most column and the right guide of the right-most
column do not affect the other columns.
select 1
move r i g httop, 7.5i, co lumn top Layout view only. Use the MoveColumn
command only in layout view.
See also: Example. The following example moves the left
The BringToFront and SendToBack commands column guide of the second column to the
specified location (four inches along the
horizontal, or x-axis, relative to the rulers' zero
point).
move column 2, left, 4i
 ADOBE PAGEMAKER 7.0 103
Commands

See also: Parameter Values to enter

The ColumnGuides command
yOffset Vertical offset of each copied object,
The GetColumnGuides query starting from the original object or
objects

Measurement units for scripts. If you do not

MoveLayer sFromLayer, sToLayer
specify a unit of measure (e.g., i for inches),
Moves the layer forward or backward in the
PageMaker uses the default unit of measure,
drawing order, so that the layer named by sFrom-
specified in the Preferences dialog box or with the
Layer appears directly in front of the layer named
MeasureUnits command.
by sToLayer.
Copy objects first. Use the Copy command to
Parameter Values to Enter copy the selected objects to the Clipboard before
sFromLayer Layer to move using the MultiplePaste command.
sToLayer The layer that will be behind the layer Pasting text. Text is pasted as separate text blocks.
being moved It is not pasted multiple times within a single text
block.
Note. To move a layer to the bottom, use an empty
Layout view only. Use the MultiplePaste
string for sToLayer.
command only in layout view.
Example. The following example will move Layer
Example. The following example selects the first
2 in front of Layer 1.
object drawn, copies it to the Clipboard, and
move l ayer "L ayer 2", "L ayer 1" pastes two copies of the selected object, each one
successively 0.75 inches to the right on the
horizontal (x) axis and 0.75 inches up the
See Also:
vertical (y) axis, starting from the selected
The AssignLayer, DeleteLayer, DeleteUnusedLay- object.
ers, LayAdjOpts, LayerOptions, LockLayers, New-
Layer, PasteRemembers, SelectLayer, ShowLayers, select 1
and TargetLayer commands copy
The GetLayerFromID, GetLayerList, GetLayerOp- mu l t i p l e p a s te 2 , . 7 5 i , - . 7 5 i
tions, GetPasteRemembers, and GetTargetLayer
queries
See also:
The Copy and Paste commands
MultiplePaste nPaste, xOffset, yOffset
Pastes the currently copied object or objects a
MultPasteOffset xOffset, yOffset
specified number of times, offsetting each copy by
a specified amount. Sets the default offsets that appear in the Multiple
Paste dialog box.
Parameter Values to enter
Parameter Values to enter
nPaste Number of copies to paste
xOffset Horizontal difference between each
xOffset Horizontal offset of each copied object, pasted copy (maximum 45 inches)
starting from the original object or
objects yOffset Vertical difference between each pasted
copy (maximum 45 inches)
 ADOBE PAGEMAKER 7.0 104
Commands

Measurement units for scripts. If you do not Example. The following example:
specify a unit of measure (e.g., i for inches),
• Creates a new, five-page publication.
PageMaker uses the default unit of measure,
specified in the Preferences dialog box or with the • Specifies a standard U.S. letter page (8.5 inches
MeasureUnits command. by 11 inches).

MultiplePaste changes defaults. Each time you • Changes the publication to double-sided, facing
use the MultiplePaste command, it sets the default pages.
offsets in the Multiple Paste dialog box. Use the • Sets the margins of the Document Master to: an
MultPasteOffset command to reset the default inside margin of 1 inch; a top margin of .5 inches;
offsets either to a different value or back to their an outside margin of .75 inches; and a bottom
original value. margin of .5 inches.
Example. The following example selects and • Starts the page numbers with page 1, leaves the
copies the third object drawn. It queries for the existing number of pages unchanged, restarts page
current default offset, pastes five copies, and then numbering, specifies Arabic style, and includes a
resets the default offsets back to their previous prefix of I- before each page number.
values. new 5
select 3 pagesize 8.5i, 11i
copy pageoptions 1, 1
g e t mu l t p a s te o f f s e t - - re p l y 3 , 3 pagemarg ins 1i, .5i, .75i, .5i
mu l t i p l e p a s te 5 , 0 p 4 , 0 p 9 - - s e t s o f f s e t s to n e w pagenumbers 1, -2, t r ue, ar abic, "I-"
values
mu l t p a s te o f f s e t 3 , 3 - - re s e t s o f f s e t s b a c k to
See also:
pre v ious values
The DefineMasterPage, PageMargins, PageNum-
bers, PageOptions, and PageSize commands
See also:
The Copy, MultiplePaste, and Paste commands
The GetMultPasteOffset query NewLayer sLayerName, bShow, bLock,
nColorIndex, nRed, nGreen, nBlue
Creates a new layer at the top of the layers list.
New [nPages]
Parameter Values to Enter
Creates a new publication with the specified
number of pages. sLayerName Name for the new layer

bShow True for show layer

Parameter Values to enter
False for hide layer
nPages Number of pages of the new publication;
the default is one. bLock True to lock the layer

False to unlock the layer

Maximum number of pages. The maximum
nColorIndex Colors for object handles, indicating that
number of pages for a publication is 999. an object is on this layer.
Document Setup commands should follow. Predefined nColorIndex
Follow the New command with the Document Color
Setup commands: PageMargins, PageNumbers,
Black 0
PageOptions, and PageSize.
 ADOBE PAGEMAKER 7.0 105
Commands

Example. The following example creates a new

Parameter Values to Enter
layer called More stuff. The layer is visible and
Red 1 unlocked. The object handles will be dark green.
Green 2 newlayer "More stuff ", TRUE, FALSE, 10, 0, 0, 0
Blue 3

Yellow 4 See Also:

Magenta 5 The AssignLayer, DeleteLayer, DeleteUnusedLay-
ers, LayAdjOpts, LayerOptions, LockLayers,
Cyan 6 MoveLayer, PasteRemembers, SelectLayer, Show-
Gray 7 Layers, and TargetLayer commands
The GetLayerFromID, GetLayerList, GetLayerOp-
Light Blue 8
tions, GetPasteRemembers, and GetTargetLayer
Orange 9 queries
Dark Green 10

Teal 11 NewStory x1, y1

Tan 12 Creates a new, empty story (same as clicking the
text tool except that y1 designates the top of the
Brown 13
text block).
Violet 14
Parameter Values to enter
Gold 15
x1 Horizontal ruler location
Dark Blue 16
0 if in story editor
Pink 17
y1 Vertical ruler location for top of text block
Lavender 18
0 if in story editor
Brick Red 19

Olive Green 20
Measurement units for scripts. If you do not
specify a unit of measure (e.g., i for inches),
Peach 21 PageMaker uses the default unit of measure,
Burgundy 22 specified in the Preferences dialog box or with the
MeasureUnits command.
Grace Green 23
Automatic text block sizing. If you click the text
Ochre 24
tool within a column, PageMaker sizes the text
Purple 25 block to fit the column, moving the left and right
Light Gray 26
handles to the column edges. The NewStory
command works in the same way. PageMaker uses
Other... customcolorindex, "customcolorindex" the x1 and y1 location as a starting point for the
nRed Red values for custom handle color text, but moves x1 to the left edge of the column if
that coordinate falls within a column.
nGreen Green values for custom handle color
Top of text block. Unlike clicking the text tool, the
nBlue Blue values for custom handle color
y1 coordinate specifies the location of the top of
the text block.
 ADOBE PAGEMAKER 7.0 106
Commands

Story editor. If you use the NewStory command Insertion point. Following this command, the
while in story editor, PageMaker disregards the x insertion point is active and positioned at the top
and y coordinates. To place the story on the page of the text block.
later, use the CloseStory command followed by the
yRightBottom a placeholder. When sizing the
Place command.
new text block, PageMaker ignores the value of
Move and resize commands. You can change the yRightBottom (a text block does not have a vertical
placement of the text block using the Move and dimension until it contains text). When you enter
Resize commands. or paste text, PageMaker expands the text block
down as far as necessary to accommodate the text,
Example. The following example switches to
stopping when it reaches the bottom of the page,
layout view and goes to page 1. It then creates a
the bottom of the pasteboard (if the text block is
new story at the location six inches right on the
contained entirely on the pasteboard), or a graphic
horizontal (x) axis and four inches down the
with column-break text wrap applied.
vertical (y) axis, relative to the rulers' zero point. If
the location is within a column, the text block will Column guides and Snap To options ignored.
move to the left edge of the column. Unlike the NewStory command, NewStorySized
ignores column guides and sizes the text block to
editlayout
the specified coordinates. Also, the command is
page 1
not sensitive to the setting of the Snap to Guides
newstor y 6i, 4i
and Snap to Ruler options. PageMaker sizes the
text block to the locations you specify, regardless of
See also: any guides or rulers.
The Move and Resize commands Order of coordinates. You must enter the coordi-
nates in order, from the top-left corner to the
bottom-right corner.
NewStorySized xLeftTop, yLeftTop,
xRightBottom, yRightBottom Off pasteboard. If the coordinates are off the
pasteboard, PageMaker sizes the text block to the
Creates new empty text block and sizes it to the
pasteboard edge.
specified coordinates (same as drag-clicking the
text tool). Errors. PageMaker returns CQ_INVALID_ARGS
for any of the following conditions:
Parameter Reply values
• You did not enter coordinates in order, from the
xLeftTop x-coordinate of left edge of text block
top left to bottom right. Left coordinates must be
yLeftTop y-coordinate of top edge of text block greater than right coordinates, and top coordinates
must be greater than bottom coordinates.
xRightBottom x-coordinate of right edge of text block
(Remember: In the PageMaker coordinate system,
yRightBottom y-coordinate of bottom edge of text values increase as you move down from the zero
block (value ignored, but must be a valid
value; see notes)
point.)
• The width of the text block exceeds the
Measurement units for scripts. If you do not maximum PageMaker column width (21 inches,
specify a unit of measure (e.g., i for inches), 533.4 millimeters, or 126 picas).
PageMaker uses the default unit of measure, • The height of the text block exceeds the
specified in the Preferences dialog box or with the maximum PageMaker column depth (22.6 inches,
MeasureUnits command. 574 millimeters, or 135p7.2 picas).
 ADOBE PAGEMAKER 7.0 107
Commands

Example. The following example creates a new See also:

(empty) text block and pastes the contents of the The StyleBegin and StyleEnd commands
Clipboard into the text block.
The GetNextStyle query
NewStor ySized 1i, 1i, 5i, 5i
p a ste
NoBreak bState
See also: Sets the Break/No Break setting of the highlighted
text, which determines whether the selected text
The NewStory, Move, and Resize commands
can be broken between lines or kept together on
same line.
NextStyle sNextStyle Parameter Values to enter
Specifies the style that follows the style being bState off or 0 to allow highlighted text to break
edited or defined. normally at end of line

Parameter Values to enter on or 1 to keep highlighted text together

on same line
sNextStyle Exact name of the next style, in quotation
marks (to a maximum of 31 characters)
See also:
Use StyleBegin command first. You must precede The GetNoBreak query
this command with the StyleBegin command,
which marks the beginning of a style definition
and specifies the name of the style being defined or NonPrinting bState
edited. The StyleEnd command is required to
Sets the print state (nonprinting or printing) of the
complete the definition.
selected objects (graphics and text blocks).
Style applied to next new paragraph. The sNext-
Parameter Values to enter
Style value is the style applied to the new
paragraph created when the Return key is pressed. bState off or 0 to print selected objects

Specifying style names. When typing the style on or 1 to suppress printing of selected
objects
name, follow the spelling, capitalization, and
punctuation of the style exactly as it appears in the
Styles palette list. Graphics and text blocks only. The NonPrinting
command can suppress the printing of graphics
Example. The following example defines the new (including inline graphics selected with the pointer
style "Heading 2" (or edits an existing style by that tool or Select command) and text blocks, but not a
name) and specifies "Heading 1" as the style on range of text selected (highlighted) with the text
which it is based. It then identifies the style used in tool or TextSelect command.
paragraphs that follow "Heading 2."
Element must be selected. If no elements are
s t y l e b e g i n " He a d i n g 2 " selected (or if text is highlighted), PageMaker
basedon "Heading 1" returns an error.
n ex t s t y l e " Pa r a "
styleend Suppressing the display of nonprinting objects.
To suppress the display of nonprinting objects, use
the DisplayNonPrinting command.
 ADOBE PAGEMAKER 7.0 108
Commands

Layout view only. The NonPrinting command Example. The following example moves the
works only in layout view. selected object one inch to the right along the
horizontal (x) axis, and three inches up along the
NonPrinting replaces SuppressPrint. To match
vertical (y) axis, relative to the rulers' zero point.
the name on the PageMaker Element menu, the
NonPrinting command replaces the nudge 1i, -3i
SuppressPrint command.
Example. The following example selects the third See also:
object drawn, marks it to be dropped when The Move command
printed, and turns off the display of all objects with
nonprinting applied.
select 3 Open fPubname[, cHowToOpen]
nonpr inting on Opens the specified publication or template as
displaynonpr inting off--hides ALL nonpr inting either an original or a copy.
o b j e c ts
Parameter Values to enter

fPubname Exact name of the publication (path-

See also: name is optional), in quotation marks (to
The DisplayNonPrinting, Print, PrintColors, a maximum of 91 characters)
PrintDoc, PrintOptions, PrintOptionsPS, PrintPa- cHowToOpen original or 0 (the default)
perPS, and PrintTo commands
copy or 1
The GetDisplayNonPrinting and GetNonPrinting
queries
Automatic links searches. When opening a publi-
cation or template, PageMaker automatically
Nudge xAmount, yAmount searches for linked text and graphics files.

Moves the selected object the amount specified. Open publications become active. If the specified
publication is already open, it becomes the active
Parameter Values to enter
publication.
xAmount Amount to move the object horizontally
Example. The following example opens a copy
yAmount Amount to move the object vertically of the "mypub" publication.
Open "mydisk:my folder :my pub", copy
Measurement units for scripts. If you do not
specify a unit of measure (e.g., i for inches),
PageMaker uses the default unit of measure, OpenStory nStoryID
specified in the Preferences dialog box or with the
Opens story editor to the specified story or, if story
MeasureUnits command.
editor is already open, switches to that story.
Moving multiple objects. The Nudge command
can move more than one object at a time if Parameter Values to enter

multiple objects are selected. nStoryID Internal PageMaker ID for story

Layout view only. Use the Nudge command only

in layout view. Getting the story ID. To get the story ID for a
story, use the GetTextRun, GetTextCursor, or
GetStoryIDList query.
 ADOBE PAGEMAKER 7.0 109
Commands

Example. The following example opens story See also:

editor to the story with the ID 1. If the story is The Line and Box commands
already open, PageMaker switches to that story
instead.
openstor y 1 Page nPage[, sMasterName]
Displays the specified page of the open publi-
See also: cation.

The CloseStory, EditLayout, and EditStory com- Parameter Values to enter

mands
nPage Number of the page
The GetTextRun, GetTextCursor, and GetStory-
lm or -3 for left master page of specified
IDList queries master

rm or -4 for right master page of speci-

fied master
Oval xLeft, yTop, xRight, yBottom
next or -5 for next page (except when
Draws an oval from the top-left coordinates to the the current page is the last page in the
bottom-right coordinates. publication)

prev or -6 for previous page (except

Parameter Values to enter
when the current page is the first page in
xLeft x-axis coordinate of the left side of the the publication)
bounding box
sMasterName Name of master to switch to if nPage is -3
yTop y-axis coordinate of the top side of the or -4
bounding box

xRight x-axis coordinate of right side of the

Specified page must exist. The page specified
bounding box must exist in the current publication.
yBottom y-axis coordinate of bottom side of the Switching to master pages. If you set nPage to the
bottom box left or right master page (lm or -3, rm or -4), but
do not specify a master page, the Page command
Measurement units for scripts. If you do not switches to the left or right page of Document
specify a unit of measure (e.g., i for inches), master.
PageMaker uses the default unit of measure,
If the master page is a single-page master, you can
specified in the Preferences dialog box or with the
set nPage to either the left or right master (lm or -
MeasureUnits command.
3, rm or -4).
Layout view only. Use the Oval command only in
Layout view only. Use the Page command only in
layout view.
layout view.
Example. The following example draws a circle
Examples. The following example displays the
with a radius of one inch. The circle is centered at
previous page of the open publication.
the six-inch, x-axis coordinate (the half-way point
between five and seven inches) and the five-inch, page pre v
y-axis coordinate (the half-way point between four The following example displays the right page of
and six inches). the master page named Document Master.
ov a l (5i , 4i), (7i , 6i) page -3, "Document Master"
 ADOBE PAGEMAKER 7.0 110
Commands

See also: PageNumbers nStartPage,

The ShowPages command nNumPages, bRestart, cStyle, sPrefix
Specifies the starting page number, the restart
numbering option, the numbering style, and the
PageMargins xInside, yTop, xOutside, table of contents and index prefix. Deselects all
yBottom, bAdjustLayout selected objects.
Sets the page margins of the Document Master
Parameter Values to enter
master page.
nStartPage Page number of the first page of the pub-
Parameter Values to enter lication

xInside Inside margin (or left margin for single- dontcare or -2 to leave the existing start-
sided publications) ing page number unchanged

yTop Top margin nNumPages Number of pages in the publication

xOutside Outside margin (or right margin for sin- dontcare or -2 to leave the existing num-
gle-sided publications) ber of pages unchanged

yBottom Bottom margin bRestart false or 0

true or 1 to restart page numbering

bAdjustLayout true automatically adjust the page lay-
out to the new margins dontcare or -2 to leave the existing page
numbering unchanged
false do not adjust the page layout to the
new margins cStyle arabic or 0

upperroman or 1
Layout view only. Use this command only in
lowerroman or 2
layout view.
upperalpha or 3
Measurement units for scripts. If you do not
specify a unit of measure (e.g., i for inches), loweralpha or 4

PageMaker uses the default unit of measure, dontcare or -2 to leave the existing num-
specified in the Preferences dialog box or with the ber style unchanged

MeasureUnits command. sPrefix Text to appear before the page numbers

in the table of contents and index, in
Example. The following example changes the quotation marks (to a maximum of 15
margins of the Document Master to: an inside characters)
margin of 1 inch; a top margin of .5 inches; an "" (empty quotation marks) for no prefix
outside margin of .75 inches; and a bottom margin
of .5 inches. Page layout is automatically adjusted bRestart compared to nStartPage. When
to the new margins. printing publications in the booklist, the bRestart
pagemarg ins 1i, .5i, .75i, .5I, t r ue parameter overrides nStartPage.
Blank pages added automatically. If you specify a
See also: larger number of pages with the nNumPages
parameter than the publication currently contains,
The ColumnGuides, DefineMasterPage, New,
PageOptions, and PageSize commands blank pages will be added to the end of the publi-
cation.
The GetPageMargins query
 ADOBE PAGEMAKER 7.0 111
Commands

Caution: Pages removed automatically. If you Layout view only. Use the PageOptions command
specify fewer pages than the publication currently only in layout view.
contains, pages will be removed from the end of
Selected objects deselected. The PageOptions
the publication.
command deselects any selected objects. It does
Layout view only. Use the PageNumbers not, however, deselect highlighted text (text
command only in layout view. selected with the text tool or TextSelect
command).
Selected objects deselected. The PageNumbers
command deselects any selected objects. It does Example. The following example sets up the
not, however, deselect highlighted text (text publication with double-sided, facing pages.
selected with the text tool or TextSelect
pageoptions 1, 1
command).
Example. The following example starts the page
See also:
numbers with page 1, leaves the existing number
of pages unchanged, restarts page numbering, The DefineMasterPage, New, PageMargins, and
specifies arabic style, and includes a prefix of I-- PageSize commands
before each page number. The GetPageOptions query

pagenumbers 1, -2, t r ue, ar abic, "I-"

PageSize xWidth, yHeight,

See also: bAdjustLayout
The GetPageNumbers query Sets the page size of the current publication.
Deselects all selected objects and resets the zero
point.
PageOptions bDoubleSided, Parameter Values to enter
bFacingPages
xWidth Width of the page of the publication in
Sets the double-sided and facing-pages options on the specified unit of measure
or off in the current publication. Deselects all
selected objects and resets the zero point. yHeight Height of the page of the publication in
the specified unit of measure
Parameter Values to enter
bAdjustLayout true automatically adjust the page lay-
bDoubleSided off or 0 for single-sided pages out to the new page size

on or 1 for double-sided pages false do not adjust the page layout to

the new page size
bFacingPages off or 0 for non-facing pages

on or 1 for facing pages (turn facing Measurement units for scripts. If you do not
pages on only if the double-sided option specify a unit of measure (e.g., i for inches),
is also on)
PageMaker uses the default unit of measure,
specified in the Preferences dialog box or with the
Zero point reset. When you switch to or from MeasureUnits command.
facing pages, PageMaker automatically resets the
rulers' zero point to either the upper left corner of ZeroPoint reset. When you change the size of the
the page (facing pages off) or to the center top, page, PageMaker automatically resets the rulers'
where facing pages meet. zero point to either the top left corner of the page
(facing pages off) or to the center top, where facing
pages meet.
 ADOBE PAGEMAKER 7.0 112
Commands

Page size depends on facing pages specification.

Parameter Values to enter
If the publication is not specified with facing pages
(with the PageOptions command or in the bColumnBreak off or 0 (zero)

Document Setup dialog box), the largest page size on or 1 to specify that a paragraph
is 42 inches by 42 inches. If the publication is set begins a new column

with facing pages, the largest page size is 17 by 22 dontcare or -2 to leave existing setting
inches. unchanged

Layout view only. Use the PageSize command bPageBreak off or 0 (zero)

only in layout view. on or 1 to specify that a paragraph

begins a new page
Selected objects deselected. The PageSize
dontcare or -2 to leave existing setting
command deselects any selected objects. It does unchanged
not, however, deselect highlighted text (text
bIncludeTOC off or 0 (zero)
selected with the text tool or TextSelect
command). on or 1 to specify that the paragraph text
is included in the table of contents
Example. The following example specifies a
dontcare or -2 to leave existing setting
standard U.S. letter page width and height (8.5 unchanged
inches by 11 inches). The page layout is automati-
nKeepWith none or 0 (zero)
cally adjusted to the new page size.
1 or 2 or 3 to specify the number of lines
pagesize 8.5i, 11I, t r ue to remain with the next paragraph (use-
ful to keep headings and text together)

See also: dontcare or -2 to leave existing number

unchanged
The DefineMasterPage, PageMargins, PageOp-
tions, and Preferences commands nWidow none or 0 (zero)

The GetPageSize query 1 or 2 or 3 to specify the maximum lines

for widow control

dontcare or -2 to leave existing number

unchanged
ParaOptions bKeepTog,
bColumnBreak, bPageBreak, nOrphan none or 0 (zero)
bIncludeTOC, nKeepWith, nWidow, 1 or 2 or 3 to specify the maximum lines
nOrphan for orphan control

Sets paragraph options. The extent of the action dontcare or -2 to leave existing number
unchanged
depends on which tool is active, whether any text is
selected, and whether a publication is open when
Example . Assuming a paragraph is selected and it
the command is executed.
is a heading, the example specifies the following:
Parameter Values to enter
• Heading will not split over different columns,
bKeepTog off or 0 (zero) from page to page, or over graphics that have text-
on or 1 to keep lines of a paragraph wrap attributes (useful if you have a two-line
together, rather than split between dif- heading).
ferent columns, pages, or graphics
• Heading begins a new column.
dontcare or -2 to leave existing setting
unchanged • Heading need not begin a new page.
• Heading is included in the table of contents.
 ADOBE PAGEMAKER 7.0 113
Commands

• Current widow and orphan control is acceptable. Pasting with the pointer tool active. When you
par aoptions 1, 1, 0, 1 , 0, -2, -2
paste using the pointer tool, the position of the
pasted text block or graphic depends on whether
or not the place on the page from which it was cut
See also: or copied is still visible on the screen. If it is
The GetParaOptions query displayed, PageMaker pastes the text block or
graphic at a slight offset from its original position.
If the position is no longer displayed, PageMaker
ParaSpace ySpaceBefore, ySpaceAfter centers the text block or graphic on the screen.
Adds extra space between paragraphs. The extent Pasting with the text tool active. If you paste a
of the action depends on which tool is active, graphic when the text tool is active and an
whether any text is selected, and whether a publi- insertion point exists, the graphic becomes an
cation is open when the command is executed. inline graphic at the insertion point.
Parameter Values to enter You can paste text in two ways using the text tool:
ySpaceBefore Amount of space to be added before • When the insertion point is within a text block,
each paragraph (from 0 to 22 inches)
the pasted text is threaded into the text block,
ySpaceAfter Amount of space to be added after each retaining the formatting it had when it was cut or
paragraph (from 0 to 22 inches) copied, but adjusting to the line length of the
current text block
Measurement units for scripts. If you do not
• When the insertion point is outside a text block,
specify a unit of measure (e.g., i for inches),
pasting creates a new text block. The line length of
PageMaker uses the default unit of measure,
the new text block depends upon where you
specified in the Preferences dialog box or with the
position the insertion point. If the insertion point
MeasureUnits command.
is between column guides, the line length will be
ySpaceBefore value ignored for columns. The the width of the column; if the insertion point is
ySpaceBefore value is not added if the paragraph outside the column guides, the line length will be
begins a column. the width of the image area.
Example . The following example specifies an Pasting items copied outside of PageMaker (Mac-
insertion of 0.2 inches after each paragraph. intosh only). PageMaker for the Macintosh uses
an internal clipboard, not the standard Macintosh
p a r a s p a ce 0 , . 2 i
Clipboard. To paste externally copied or cut data
into PageMaker for the Macintosh, you must first
See also: render those items to the PageMaker internal
The GetParaSpace query clipboard using the RenderClip command. Specify
in or 0 for the bDirection parameter.
Story editor: graphics. When you paste a graphic
Paste or image from the Clipboard into story editor, it is
Pastes the contents of the Clipboard into the open pasted as an inline graphic at the location of the
publication. insertion point.

Clipboard limit. The maximum amount of text

that can be stored in (or pasted from) the
Clipboard is 64K.
 ADOBE PAGEMAKER 7.0 114
Commands

Story editor: no pasting in dialog boxes. Unlike Example. The following example turns PasteRe-
Paste on the Edit menu, the Paste command does members on.
not paste text into the Find, Change, or Spelling
pasteremembers TRUE
dialog boxes. Instead, it pastes text at the location
of the insertion point in the current story,
regardless of whether one of the dialog boxes is See Also:
displayed. The AssignLayer, DeleteLayer, DeleteUnusedLay-
Example. The following example pastes the
ers, LayerOptions, LockLayers, MoveLayer, New-
Layer, SelectLayer, ShowLayers, and TargetLayer
contents of the Clipboard.
commands
p a ste The GetLayerFromID, GetLayerList, GetLayerOp-
tions, GetPasteRemembers, and GetTargetLayer
queries
See also:
The MultiplePaste, PasteLink, and PasteSpecial
commands PasteSpecial cFormat
Pastes the object from the Clipboard using the
PasteLink format specified.

Pastes the OLE-linked object from the Clipboard. Parameter Values to enter

No OLE-linked objects returns error. If the cFormat text or 0 for plain text
Clipboard does not contain an OLE-linked object, rtf or 1 for Rich Text Format (RTF)
PageMaker returns an error. eps or 2 for Encapsulated PostScript
Layout view only. Use the PasteLink command external or 3 for external PageMaker for-
only in layout view. mat

Example. The following example pastes the colortroncolors or 4 to add Colortron

colors to the Colors palette
OLE-linked object from the Clipboard.
objectembed or 5 for embedded OLE
p a s te l i n k object

objectlink or 6 for linked OLE object

See also: pict or 7 for Macintosh PICT format (Mac-
intosh only)
The MultiplePaste, Paste, and PasteSpecial com-
mands metafile or 8 for Windows metafile for-
mat (Windows only)

bitmap or 10 for Windows bitmap (Win-

PasteRemembers bRemember dows only)

enhmetafile or 11 for Windows

Turns the paste remembers layering on or off.
enhanced metafile format (Windows
only)
Parameter Values to Enter
dibbitmap or 12 for device independent
bRemember True pastes objects onto the same layer bitmaps (Windows only)
from which they were copied

False pastes objects onto the target layer

 ADOBE PAGEMAKER 7.0 115
Commands

Only available formats allowed. You can paste

Parameter Values to enter
only using a format that is available for the object
in the Clipboard. If the specified format is not sLibrary Name of the color library (without the
.acf extension)
available, PageMaker returns an error message
("Operation was not performed."). "" (empty quotation marks) if there is
only one library for the specified color
Pasting items copied outside of PageMaker (Mac- picker
intosh only). PageMaker for the Macintosh uses sColor Name of color (exactly as it appears in the
an internal clipboard, not the standard Macintosh color library) to be used to define (or
Clipboard. To paste externally copied or cut data redefine) the color specified with sColor-
Name
into PageMaker for the Macintosh, you must first
render those items to the PageMaker internal
Path names not required. It is not necessary to
clipboard using the RenderClip command. Specify
specify paths for the sPicker and sLibrary param-
in or 0 for the bDirection parameter.
eters.
Layout view only. Use the PasteSpecial command
Colors are editable. Any color specified using this
only in layout view.
command may be subsequently edited using the
Example . The following example pastes the object DefineColor command.
from the Clipboard using the Macintosh PICT
Specifying a name. When specifying a color in a
format.
library, such as PANTONE or TOYO, specify the
p a s te s p e c i a l p i c t name of the color exactly as it appears in the color
library. For instance, to install the PANTONE color
2665 CV, specify, "PANTONE 2665 CV."
See also:
The MultiplePaste, Paste, and PasteLink com- Examples. The following example defines color
mands "MyRed" to be the TRUMATCH color "6-a1." It
is a spot color that knocks out any underlying
inks.
PickColor sColorName, bOverPrint, pickcolor "MyRed", false, "AldColor.add",
sPicker, sLibrary, sColor " Tr u m a tch " , " T RU M ATC H 6 - a 1 "
Defines a new color, or redefines an existing color,
using a definition from a color library. The following example redefines the spot color
"Red" to be the PANTONE library.
Parameter Values to enter
pickcolor "Red",0,"AldColor. add","Pantone®
sColorName Name of the new color, or the color being
redefined, in quotation marks (to a maxi- Co a te d " , " PA N TO N E Re d 0 3 2 C V "
mum of 31 characters). If redefining an
existing color, the name must match
exactly as it appears on the Colors pal- See also:
ette.
The ColorPalette command
bOverPrint false or 0 (zero) for knockout The GetColorInfo, GetColorNames, and GetPick-
true or 1 for overprint ers queries

sPicker Name of the installed color picker

(including the .add file extension)
 ADOBE PAGEMAKER 7.0 116
Commands

Place x1, y1 impor t "ar tfolder :building:tif "

place (column 1 left, guide 1)
Places the contents of the loaded place icon on the
page, at the specified location. (The commands
that load the place icon are Import, CreateIndex, See also:
CreateTOC, and PlaceNext.) The CreateIndex, CreateTOC, Import, PlaceNext,
PlaceSized, and Resize commands
Parameter Values to enter

x1 x-axis location where the text icon is

clicked
PlaceNext cTopOrBottom
y1 y-axis location where the text icon is Clicks the top or bottom windowshade of the
clicked
selected text block and loads the text icon so that
you can place the adjoining portion of the story.
Measurement units for scripts. If you do not
specify a unit of measure (e.g., i for inches), Parameter Values to enter
PageMaker uses the default unit of measure, cTopOrBottom top or 3 to click the top windowshade
specified in the Preferences dialog box or with the handle
MeasureUnits command. bottom or 4 to click the bottom window-
shade handle
For external files, use Import command first. To
place an external file, precede the Place command
with the Import command. Specifying the page. To position the text block on
a page, follow the PlaceNext command with either
For existing stories, use PlaceNext command. To the Place command or both the Page (to change
place a portion of an existing story, select the text pages) and the Place commands.
object, load the place icon using the PlaceNext
command, and then use the Place command to Layout view only. Use the PlaceNext command
place the text on the page. only in layout view.

Drag-placing. The Place command works like the Example . The following example selects a text
click-place technique. The coordinates indicate block by clicking the top-left corner of the first
where the loaded text icon should be clicked. If the column; clicks the top windowshade handle of the
coordinates are within a column, the text object text block; switches to page 7; and places the text
spans the column. To imitate drag-placing, use the 3.5 inches down and to the right of the zero point.
PlaceSized command (or resize the text object after select (column 1 left, co lumn top)
placing it, using the Resize command). p l a cen ex t top
Layout view only. Use the Place command only in page 7
layout view. p l a ce 3 . 5 i , 3 . 5 i

Examples . Assuming the rulers' zero point is at

the top-left corner of the page, the following See also:
example places the file "building.tif " 2 inches from The Place and PlaceSized commands
the left of the page and 4 inches from the top side.
impor t "ar tfolder :building .tif "
p l a ce 2 i , 4 i

The following example places the file in the left-

most column, starting at the first horizontal guide.
 ADOBE PAGEMAKER 7.0 117
Commands

DownLoadWebContent sURL Measurement units for scripts. If you do not

specify a unit of measure (e.g., i for inches),
Copies a file off of the internet onto the local hard
PageMaker uses the default unit of measure,
drive.
specified in the Preferences dialog box or with the
Parameter Values to Enter MeasureUnits command.
sURL Location of the information to be copied Off pasteboard. If the coordinates are off the
pasteboard, PageMaker sizes the text object or
Online preferences. This command relies on image to the pasteboard edge.
settings in the Online Preferences dialog box, Images: Text wrap turned off. The PlaceSized
including the URL information (if required for command places images with text wrap turned off,
Internet access). The file is downloaded to the local regardless of the default text wrap settings.
hard drive. You can then use the Import command
to place the file into the PageMaker publication. Images: Sizing not proportional. The PlaceSized
command sizes images within the given coordi-
Example. The following example downloads a nates, which may or may not be proportional.
GIF image from a file transfer protocol site.
Text: Column guides and Snap To options ignored.
DownLoadWebContent
Unlike the Place command, PlaceSized ignores
"ftp://ftp.fictional.com/pub/images/netimage.gif "
column guides and sizes the text block to the
specified coordinates. Also the command is not
See Also: sensitive to the settings of the Snap to Guides and
Snap to Rulers options. PageMaker sizes the text
The Import and Place commands
block to the location you specify, regardless of any
guides or rulers.
PlaceSized xLeftTop, yLeftTop, Text: yRightBottom a placeholder. When placing
xRightBottom, yRightBottom text, PageMaker disregards the value of yRight-
Places the contents of the loaded place icon at the Bottom. Instead, PageMaker adjusts the bottom of
specified location, resizing it to fit the specified the text block to accommodate the text. If
coordinates. necessary, PageMaker expands the text block until
it reaches the bottom of the page, the bottom of the
Parameter Reply values pasteboard (if the text block is contained entirely
xLeftTop x-coordinate of left edge of text block or on the pasteboard), or a graphic with column-
image break text wrap applied.
yLeftTop y-coordinate of top edge of text block or Errors. PageMaker returns CQ_INVALID_ARGS
image
for any of the following conditions:
xRightBottom x-coordinate of right edge of text block
• Coordinates not entered in order, from the top
or image
left to bottom right. Left coordinates must be
yRightBottom y-coordinate of bottom edge of text greater than right coordinates, and top coordinates
block or image
must be greater than bottom coordinates.
(Remember: In the PageMaker coordinate system,
Order of coordinates. You must enter the coordi-
values increase as you move down from the zero
nates in order, from the top-left corner to the
point.)
bottom-right corner.
• The width exceeds the maximum PageMaker
column width (21 inches, 533.4 millimeters, or 126
picas).
 ADOBE PAGEMAKER 7.0 118
Commands

• The height exceeds the maximum PageMaker See also:

column depth (22.6 inches, 574 millimeters, or The FillAndLine, FillStyle, Line, LineStyle, Box,
135p7.2 picas). Oval, and PolygonAttribs commands
Example. The following example imports an The GetPolygonAttribs query
image and places it within the columns, resizing it
to fit.
impor t "ar tfolder :building .tif ", 0, 0, 0, 0, 0
PolygonAttribs nSides, nStarInset
placesized co lumn left, co lumn top, co lumn Sets the polygon attributes for the currently
r ig ht, column bottom selected polygons, or, if none are selected, sets the
default polygon attributes.

See also: Parameter Values to enter

The Import, Place, Move, and Resize commands nSides Number of sides, from 3 to 255

nStarInset Percent star inset (from 0 to 100), where

0% represents no star and 100% repre-
Polygon xLeft, yTop, xRight, yBottom, sents a star with the inner vertices all
bRegular occupying the same point in the middle
of the polygon
Draws a polygon that lies either within or on the
rectangle defined by the specified coordinates. Example. The following command lines produce
Parameter Values to enter the polygons shown below:

xLeft x coordinate of top-left corner a) polygonatt r ibs 5, 100

b) polygonatt r ibs 5, 75
yTop y coordinate of top-left corner
c) polygonatt r ibs 5, 0
xRight x coordinate of bottom-right corner

yBottom y coordinate of bottom-right corner

bRegular false or 0 to place all outer vertices of the

polygon on the rectangle, varying segment
length and angles as needed

true or 1 to constrain the polygon to fit See also:

within the rectangle, with all segments The Polygon command
equal and all angles equal (outer vertices lie
on largest circle that fits within rectangle) The GetPolygonAttribs query

Measurement units for scripts. If you do not

specify a unit of measure (e.g., i for inches), PolygonJoin
PageMaker uses the default unit of measure, Joins the currently selected polygons into a single
specified in the Preferences dialog box or with the irregular polygon. The new polygon takes on the
MeasureUnits command. attributes of the last polygon in the selection list.
Example. The following example draws a polygon
with the default attributes (number of sides and
percent star inset). Since bRegular is specified as
true, each segment of the polygon will be of equal
length.
polygon (5i, 4i) (7i, 6i) t r ue
 ADOBE PAGEMAKER 7.0 119
Commands

Example. The following example assumes that the PolygonType nType

current publication has three polygons selected. It
Sets the type of a polygon.
connects the last vertex of the first polygon to the
first vertex of the second polygon, and the last Parameter Values to Enter
vertex of the second polygon to the first vertex of
nType 0 causes the polygon to become a regular
the third polygon. If the third polygon is closed, polygon. The current number of sides and
then the resulting polygon will be closed. inset values are applied to the polygon.

polygonjoin 1 causes the polygon to become an open,

irregular polygon. If the polygon was a regu-
lar polygon, it becomes irregular. It looks the
same, except that it is missing one side.
See also:
2 causes the polygon to become a closed
The CreatePolygon, PolygonType, and Polygon- irregular polygon. If the polygon was a regu-
Vertices commands lar polygon, it becomes irregular. It looks the
The PolygonMiterLimit, GetPolygonType, and same as it did as a regular polygon.
GetPolygonVertices queries
Layout view only. The PolygonType command
works only in layout view.
PolygonMiterLimit nLimit Example. This example turns all selected
Sets the miter limit for the selected polygon. polygons into open, irregular polygons.
Parameter Values to Enter polygont y p e 1

nLimit Miter limit for irregular polygons

See Also:
Layout view only. The PolygonMiterLimit The CreatePolygon, PolygonMiterLimit, and
command works only in layout view. PolygonVertices commands
Note. Miter limit has a minimum value of one. The PolygonMiterLimit, GetPolygonType, and
GetPolygonVertices queries
Example. The following example sets the miter
limit to 1, which will cause most irregular polygons
to miter. PolygonVertices nPoints, (xLocation,
polygonmiterlimit 1 yLocation)
Replaces the currently selected polygon with the
See Also: polygon defined by the specified points.
The CreatePolygon, PolygonType, and Polygon- Parameter Values to Enter
Vertices commands
nPoints Number of points in the polygon
The PolygonMiterLimit, GetPolygonType, and
GetPolygonVertices queries For each of the points in the polygon, specify a pair of coor-
dinates.

xLocation x coordinate of the point

yLocation y coordinate of the point

Note. A polygon has a minimum of three points.

 ADOBE PAGEMAKER 7.0 120
Commands

Layout view only. The PolygonVertices command See also:

works only in layout view. The TypeOptions command
Example. The following example replaces the The GetTypePosition query
currently selected polygon with one that has four
points.
polygonver tices 4, 1i, 1i, 1i, 2i, 2i, 2.5i, 2i, 1.5i
Preferences nGreekBelow, cGuides,
cGraphics, bLoose, bKeeps, cSaveOption,
bQuotes, bNumSnapTo, bAutoflow,
See Also: bDisplayName, nKBitmap, nKLimit,
The CreatePolygon, PolygonMiterLimit, and xHorizNudge, yVertNudge, cPSMemory
PolygonType, commands
Sets a variety of preferences for customizing the
The PolygonMiterLimit, GetPolygonType, and publication window.
GetPolygonVertices queries
Parameter Values to enter

nGreekBelow Pixel number below which text displays

Position cPosition as gray bars in layout view
Sets the position (normal, superscript, or dontcare or -2 to leave preference
subscript) of text. The extent of the action depends unchanged
on which tool is active, whether any text is selected, cGuides front or 0 to display all margin, column,
and whether a publication is open when the and ruler guides in front of text and
command is executed. graphics

back or 1 to display all margin, column,

Parameter Values to enter and ruler guides behind text and graph-
ics
cPosition normal or 0
dontcare or -2 to leave preferences
superscript or 1
unchanged
subscript or 2
cGraphics grayout or 0 for fastest screen display of
non-PageMaker graphics
Specifying text size and placement. The size of
normalres or 1 to display non-Page-
text that is positioned as superscript or subscript Maker graphics as low-resolution screen
can be specified using parameters with the images
TypeOptions command. The text position relative highres or 2 to display images at full res-
to the baseline can also be specified with TypeOp- olution
tions. dontcare or -2 to leave preference
unchanged
Example. The following example selects a text
block that starts at the top of the first column. It bLoose false or 0
then selects the first character and changes its true or 1 to highlight lines of text that
position to superscript. have too much or too little letter or word
spacing, based upon the spacing limits
select (column 1 left, co lumn top) set with the LetterSpace and WordSpace
tex te d i t commands or in the Spacing Attributes
dialog box
tex t s e l e c t + ch a r
position superscript dontcare or -2 to leave preference
unchanged
 ADOBE PAGEMAKER 7.0 121
Commands

Parameter Values to enter Parameter Values to enter

bKeeps false or 0 nKBitmap Amount of RAM (in kilobytes) to reserve

for drawing graphic elements (from 8 to
true or 1 to highlight lines of text that 64 kilobytes)
violate the widow, orphan, or other con-
trols specified with the ParaOptions com- dontcare or -2 to leave preference
mand or in the Paragraph Specifications unchanged
dialog box
nKLimit Maximum size (in kilobytes) of images to
dontcare or -2 to leave preference include in PageMaker publication file.
unchanged Images larger than this value are linked
to publication.
cSaveOption faster or 0 to append changes to the end
of the publication file when you choose xHorizNudge Distance each press of the horizontal
Save or when you use the Save command nudge button or of the key combination
moves selected objects
smaller or 1 to fully incorporate all
changes into the publication file, essen-
yVertNudge Distance each press of the vertical nudge
tially creating a new version when you
button or of the key combination moves
save the publication
selected objects
dontcare or -2 to leave preference
unchanged cPSMemory normal or 0 to free up 250K virtual mem-
ory (VM) of a PostScript printer prior to
bQuotes false or 0 to specify straight quotation downloading a graphic
marks
maximum or 1 to perform a total restore
true or 1 to substitute curved typogra- of VM on a PostScript printer prior to
pher's quotation marks whenever the downloading a graphic
standard quotation mark is typed
dontcare or -2 to leave preference
dontcare or -2 to leave preference unchanged
unchanged
Setting the default. If a publication is open, the
bNumSnapTo false or 0
new preference specifications apply only to that
true or 1 to constrain values in the Con- publication. If no publication is open, the speci-
trol palette to ruler increments or guide
positions if the Rulers and Guides fications apply to any new publication that is
options are currently on created.
dontcare or -2 to leave preference Nudge shortcut. The key combination for nudge
unchanged
is the Command key plus a directional (arrow)
bAutoflow false or 0 to display only the first and last key.
pages of a multipage autoflow opera-
tion, which makes autoflowing faster Measurement units for scripts. If you do not
true or 1 to display each page of a multi- specify a unit of measure (e.g., i for inches),
page autoflow operation PageMaker uses the default unit of measure,
dontcare or -2 to leave preference specified in the Preferences dialog box or with
unchanged the MeasureUnits command.
bDisplayName false or 0 to display the printer nickname
in the Print dialog box (e.g., Apple Laser-
Writer II NTX)

true or 1 to display the PPD name. (Page-

Maker for the Macintosh always displays
the PPD filename.)
 ADOBE PAGEMAKER 7.0 122
Commands

Display PPD names. On the Macintosh, the • Control palette displays ruler increments and
Preferences dialog box does not include the guide positions.
Display PPD Names option. Instead, PageMaker
• Fast autoflow is turned on.
for the Macintosh always displays the PPD
filename, regardless of the value you send for • Printer nickname is displayed in the Print
bDisplayName in the Preferences command. dialog box.
Although the bDisplayName parameter does • The amount of RAM reserved for drawing
nothing, the GetPreferences query still returns graphic elements remains unchanged.
the setting sent in the Preferences command.
• Images larger than 1000K are linked to the
Example. The following example specifies: publication rather than included in the publi-
cation.
• Text under nine pixels displays as grayed boxes
(greeked text). • A 1-pica horizontal nudge and 1-pica vertical
nudge.
• All guides appear behind text and graphics.
• Free up 250K of printer virtual memory prior
• Non-PageMaker graphics display as low-
to downloading a graphic.
resolution screen images (to speed redrawing of
the screen). preferences 9, back, nor malres, t r ue, t r ue,
smaller, false, t r ue, false, false, dontcare, 1000,
• Lines of text that have too much or too little
1p, 1p, nor mal
letter or word spacing are highlighted.
• Orphans and widows are highlighted.
See also:
• Saving results in smaller files, rather than files
The FontDrawing, Guides, LetterSpace, Measure-
with appended mini-versions of changes.
Units, ParaOptions, Rulers, StoryEditPref, and
• Straight quotation marks, rather than typog- WordSpace commands
rapher's quotation marks, are used. The GetPreferences query
 ADOBE PAGEMAKER 7.0 123
Commands

Print [nCopies, nFirstPage[, nLastPage[, Printing to disk. If you include a filename for
fPrintToDisk[, sPCPrinter]]]] fPrintToDisk, PageMaker creates a PostScript print
file, even if you did not turn on Write PostScript to
Prints the current publication using the print
File with the PrintOptionsPS command. To specify
options set by the various print dialogs and
the type of PostScript file (PostScript, .EPS, or
commands. Optionally, specifies the number of
.SEP), precede the print command with the Print-
copies, page range, and, for printing to disk, the
OptionsPS command. For example, to print
name of the print file and the name of the PC
"mypub" to disk as a PostScript file in Windows,
printer.
you specify:
Parameter Values to enter
--Windows
nCopies Number of copies to print pr intoptionsps 3 0 0 0 0 0 0 nor malpostscr ipt off
pr int -2, -2, -2, "my pub", "HPLaserJet III on
dontcare or -2 to print the number of
copies specified with the PrintDoc com- LPT1:"
mand

nFirstPage First page to print or on the Macintosh:

0 to print all pages in the publication - - Ma c i n to s h
dontcare or -2 to print the range speci- pr intoptionsps 3 0 0 0 0 0 0 nor malpostscr ipt off
fied with the PrintDoc command pr int -2, -2, -2, "my pub"

nLastPage Last page of the range to print

The filename can also contain a path. For example:
dontcare or -2 to print the range speci-
fied with the PrintDoc command --Windows
pr int -2, -2, -2, "c:\PM\MyFolder\MyPub",
fPrintToDisk Filename for print file, in quotation marks
(to a maximum of 91 characters), to print "HPLaserJet III on LPT1:"
publication to disk (either as a PostScript,
.EPS, or .SEP file)
Example. The following example prints the
"" (empty quotation marks) to not print current publication.
to disk
pr int
sPCPrinter Name of the printer when printing to
disk from in Windows

" " (empty quotation marks) to not print See also:

to disk
The PrintColors, PrintDoc, PrintInk, PrintOp-
tions, PrintOptionsPS, PrintPaperPS, and PrintTo
Number of copies. The nCopies parameter of the commands
Print command overrides the number of copies The GetPrintCaps, GetPrintColor, GetPrintDoc,
specified with the nCopies parameter of the GetPrinterList, GetPrintInk, GetPrintOptions,
PrintDoc command. GetPrintOptionsPS, GetPrintPaperPS, GetPrintP-
Page range. The nFirstPage and nLastPage
PDs, GetPrintPS, GetPrintScreens, and Get-
PrintTo queries
parameters override the page range specified with
the sRange parameter of the PrintDoc command.
To specify more than one range of pages, use the
PrintDoc command.
Layout view only. The Print command works
only in layout view.
 ADOBE PAGEMAKER 7.0 124
Commands

PrintColors bMode, bColors, bConvert, Parameter Values to enter

bOption, bNegative, bPreserveEPS,
nInRipSeps 0 separations are created by PageMaker
sName, nInRipSeps
1 printer creates separations (only valid
Specifies the color options executed with the for PostScript printers capable of creat-
Print command. ing color separations.)

Parameter Values to enter Non-PostScript printers. When printing to a non-

bMode off or 0 (zero) for Composite PostScript printer, the Mirror, Negative, and
Preserve EPS Colors checkboxes are absent from
on or 1 for Separations (to print an over-
lay for each ink selected) the Color dialog box. Non-PostScript printers
cannot perform these functions.
bColors off or 0 (zero) for Print Colors in Black
(print any non-white color as solid black) Screen names. The specified screen name must be
on or 1 for Grayscale (print a color com- one of the optimal screens available in the
posite on a color printer or a grayscale currently selected PPD. To get a list of the currently
composite on a black-and-white printer,
available screens, use the GetPrintScreens query.
using shades of gray for the specified col-
ors) Layout view only. The PrintColor command
bConvert off or 0 (zero) to leave spot color as spot works only in layout view.
colors
Example. The following example prints the publi-
on or 1 to convert spot colors to process cation as separations, negative, emulsion-down.
bOption off or 0 for Mirror (equivalent to printing Colors are printed using the PageMaker color
Emulsion Down) and Allow PCL Halfton- library. Spot colors are printed as spot colors (not
ing off (for PCL printers)
converted to process), and separations are created
on or 1 for Mirror for PostScript printers by PageMaker.
and Allow PCL Halftoning on
pr intcolor 1, 0, 0, 1, 1, 0, "60 lpi / 300 dpi", 0
bNegative off or 0 (zero) for Negative off

on or 1 for Negative on (which inverts

either the gray values within grayscale See also:
images or the color characteristics within
The Print, PrintDoc, PrintInk, PrintOptions,
color images)
PrintOptionsPS, PrintPaperPS, and PrintTo com-
bPreserveEPS off or 0 (zero) for Preserve EPS Colors off mands
(to print the colors in an EPS image using
the PageMaker version of the color
The GetPrintColor query
library)

on or 1 for Preserve EPS Colors on (to

print colors in an EPS image using the PrintDeviceIndpntColor bState
definitions saved in the file if they have
Enables printing device independent color.
the same names, but different defini-
tions, as colors in a PageMaker color
Parameter Values to Enter
library)
bState True sends colors to be printed in a
sName Name of optimal screen for PS printers
device independent color space
"" (empty quotation marks) for non-PS
False sends colors to be printed in a
printers or to leave the screen
device dependent color space
unchanged

Note. Device Independent Color is only available

when the Color Management System is turned on.
 ADOBE PAGEMAKER 7.0 125
Commands

See also: Parameter Values to enter

The Print, PrintColors, PrintInk, PrintTo, Print-
bBookSpec 0 (zero) for Use Settings of Each Publica-
ScreenRGBs, and PrintEPSPreviews commands tion off (to use print settings of the cur-
The GetPrintColor, GetPrintInk, PrintScreen- rent publication for all publications in the
book)
RGBs. PrintEPSPreviews, and GetPrintTo queries
1 for Use Settings of Each Publication on

bOrientation 0 (zero) for tall orientation (the left icon in

PrintDoc nCopies, bCollate, bReverse, the Print dialog box)
bProof, sRange, bBlank, cPages, 1 for wide orientation (the right icon in
bIndependence, bBook, bBookSpec, the Print dialog box)
bOrientation, bSpreads, bIgnNonPrint dontcare or -2 to let PageMaker match
the orientation with the current setting
Specifies miscellaneous options executed with the
in the Page setup dialog box
Print command.
bSpreads 0 (zero) for no reader spreads
Parameter Values to enter
1 for printing reader spreads
nCopies Number of copies to print
bIgnNonPrint 0 (zero) for "nonprinting" setting off
bCollate 0 (zero) for Collate off
1 for Ignore "nonprinting" setting on
1 for Collate on
Specifying ranges. The value of sRange can be a
bReverse 0 (zero) for Reverse Order off (to print
pages in normal order) single range (e.g., "1-10") or several ranges (e.g.,
"1-5, 8-10, 13-14"). Use commas to separate the
1 for Reverse Order on (to print pages in
reverse order) ranges. A maximum of 64 characters is allowed.
The range must be valid or PageMaker returns an
bProof 0 (zero) for Proof off
error (e.g., you can't specify the range "1-14" for a
1 for Proof on (to print imported images 10 page publication).
as boxes with Xs in them)
To print from the beginning of, for example, a 50-
sRange Range of pages to print, in quotation
marks (e.g., "1-3" to print pages 1 page publication to the end, enter "-50."
through 3)
Layout view only. The PrintDoc command works
"" (empty quotation marks) for all pages only in layout view.
bBlank 0 (zero) for Print Blank Pages off Example. The following example prints the two
1 for Print Blank Pages on copies of pages 1-9, in normal order. The output is
collated, includes both text and images, does not
cPages both or 0 for Both pages
include blank pages, and does not do reader's
even or 1 for even-numbered pages only
spreads or print dropouts.
odd or 2 for odd-numbered pages only
pr intdoc 2, 1, 0, 0, "1-9", 0, 0, 0, 0, 0, 0, 0, 0
bIndependence 0 for Page Independence off

1 for Page Independence on

See also:
bBook 0 (zero) for Print All Publications in Book The Print, PrintColors, PrintInk, PrintOptions,
off
PrintOptionsPS, PrintPaperPS, and PrintTo com-
1 for "Print All Publications in Book on mands
The GetPrintDoc query
 ADOBE PAGEMAKER 7.0 126
Commands

PrinterResol nDPI PrintScreenRGBs bState

Sets the target printer resolution to be used when Sets the output to print display RGB values when
resizing bitmap images using magic stretch. printing to an RGB device. This is useful when
(Magic stretch resizes a bitmap for optimal printing publications for online viewing.
resolution, based on the target printer resolution
Parameter Values to Enter
and the resolution of the bitmap. To magic-stretch
an image, hold down the Macintosh Command bState True for RGB device to receive screen
RGB colors
key or the Windows Ctrl key while resizing.)
False for RGB device to receive printer
Parameter Value RGB colors

nDPI Resolution of target printer (from 72 to

32,767 dpi)
See also:
The Print, PrintColors, PrintInk, and PrintTo
See also: commands
The GetPrinterResol query The GetPrintColor, GetPrintInk, PrintEPSPre-
views, PrintDeviceIndpntColor, and GetPrintTo
queries
PrintEPSPreviews bState
Sets the output to print EPS preview information
(instead of the EPS content itself) when printing to PrinterStyle sPrinterStyle
an RGB device. This is useful when printing publi- Applies the printer style to the currently open
cations for online viewing. publication. (To print the publication using these
settings, follow with the Print command.)
Parameter Values to Enter
Parameter Value
bState True prints EPS preview
sPrinterStyle Name of printer style to apply (maximum
False prints EPS content
of 31 characters)

See also:
See also:
The Print, PrintDeviceIndpntColor, PrintColors,
The AddPrinterStyle and RemovePrinterStyle
PrintInk, PrintTo, and PrintEPSPreviews com-
commands
mands
The GetPrinterStyles query
The GetPrintColor, GetPrintInk, and GetPrintTo
queries

PrintFeature sFeatureTitle, sOption

Selects the specified option from the indicated
pop-up menu in the Features print dialog box.

Parameter Value

sFeatureTitle Title of the print feature pop-up menu, in

quotation marks and exactly as it
appears in Features print dialog box
(maximum of 40 characters)
 ADOBE PAGEMAKER 7.0 127
Commands

Example. The following example sets the ink

Parameter Value
"Red" to be printed with a screen angle of 45
sOption Name of option to select, in quotation degrees and a screen ruling of 60 lines per inch.
marks and exactly as it appears in menu
(maximum of 64 characters) p r i n t i n k " Re d " , t r u e , " 4 5 " , " 6 0 "
"" empty quotation marks for the printer
default setting
See also:
Features vary. The print features vary from The Print, PrintColors, PrintDoc, PrintOptions,
printer to printer and even PPD to PPD. Use the PrintOptionsPS, PrintPaperPS, and PrintTo com-
GetPrintFeatureTitles and GetPrintFeatureItems mands
queries to determine the pop-up menus and The GetPrintInk query
options available for the currently selected PPD.

See also:
PrintOptions cScaleType, nVal,
cDuplex, bMarks, bPageInfo, cTiling[,
The GetPrintFeature, GetPrintFeatureItems, Get-
xOverlap]
PrintFeatureTitles, and GetPrintTo queries
Specifies non-PostScript print options executed
with the Print command.
PrintInk sName, bPrintInk, sAngle, Parameter Values to enter
sRuling
cScaleType numeric or 0 (zero) to scale the publica-
Sets the attributes of an ink to be used when tion
printing.
fitonpaper or 1 to scale the publication
to fit on the selected paper size
Parameter Values to enter
thumbnails or 2 to print thumbnails
sName Name of color, in quotation marks and
exactly as it appears in the Ink list nVal Percentage for numeric scaling in tenths
of a percent, from 5% (50) to 1600%
bPrintInk off or 0 (zero) (16000), if cScaleType is numeric or 0
on or 1 to print the specified ink Number of thumbnails per page, from 1
to 100, if cScaleType is thumbnails or 2
sAngle Screen angle, in quotation marks, at
which to print the ink, from "0.0" to -2 if cScaleType is fitonpaper or 1
"360.0"
cDuplex none or 0 (zero) None (no duplexing)
"" (empty quotation marks) to leave
angle unchanged shortedge or 1 for Short Edge (duplex
printing where the paper is to be bound
sRuling Screen ruling (frequency), in quotation on its short edge)
marks, for specified ink, from "1.0" to
"500.0" longedge or 2 for Long Edge (duplex
printing where the paper is to be bound
"" (empty quotation marks) to leave rul- on its long edge)
ing unchanged
bMarks off or 0 (zero) for Printer's Marks off

Layout view only. The PrintInk command works on or 1 for Printer's Marks on (to print
crop marks, registration marks, and cali-
only in layout view.
bration bars if the page size is 0.5 or more
inches smaller than the paper size)
 ADOBE PAGEMAKER 7.0 128
Commands

Parameter Values to enter PrintOptionsPS cGraphics, bMarks,

bPageInfo, bSendData, cDownload,
bPageInfo off or 0 (zero) for Page Information off
bSymbol, bErrHandler, cToDisk,
on or 1 for Page Information on (to print
filename and date)
bExtraBleed, bComm
Specifies PostScript-specific print options
cTiling none or 0 for no tiling
executed with the Print command.
manualtiling or 1 for Manual tiling
Parameter Values to enter
autooverlap or 2 for Auto tiling (to over-
lap tiles by amount specified in xOverlap) cGraphics normalimage or 3 for Normal (to print
images at their true resolution)
xOverlap Minimal amount of overlap between tiles
if autooverlap is specified for cTiling (to a optimized or 2 for Optimized
maximum of five inches)
lowTIFF or 1 for Low TIFF Resolution
(72dpi)
Measurement units for scripts. If you do not
omitTIFF or 0 (zero) for Omit TIFF Files
specify a unit of measure for xOverlap (e.g., i for
inches), PageMaker uses the default unit of bMarks off or 0 (zero) for Printer's Marks off
measure, specified in the Preferences dialog box or on or 1 for Printer's Marks on (print crop
with the MeasureUnits command. marks, registration marks, and calibra-
tion bars if the page size is 0.5 or more
nVal scale values. PageMaker scales the nVal scale inches smaller than the paper size)
value by a factor of 10. To get 100% scaling, enter a
bPageInfo off or 0 (zero) for Page Information off
value of "1000."
on or 1 for Page Information on (print file
Layout view only. The PrintOptions command name and date)
works only in layout view.
bSendData normal or 0 (zero) for Normal (Hex)
Example. The following example prints the publi-
fast or 1 for Faster (Binary)
cation at 100% scale. The printed pages include the
file name and date, but do not include printer's cDownload none or 0 (zero) for None

marks. The pages are tiled, and each tile has a 0.5 psandtt or 1 for PostScript and TrueType
inch overlap. ttonly or 2 for TrueType only
pr intoptions 0, 1000, 0, 0, 1, 1, .5i bSymbol off or 0 (zero) Use Symbol Font for Spe-
cial Characters off

See also: on or 1 Use Symbol Font for Special Char-

acters on (Macintosh only)
The Print, PrintColors, PrintDoc, PrintInk, Print-
OptionsPS, PrintPaperPS, and PrintTo commands bErrHandler off or 0 (zero) for Include PostScript Error
Handler off
The GetPrintOptions queries
on or 1 for Include PostScript Error Han-
dler on
 ADOBE PAGEMAKER 7.0 129
Commands

Parameter Values to enter See also:

The Print, PrintColors, PrintDoc, PrintInk, Print-
cToDisk off or 0 (zero) for Write PostScript to File
off (to print directly to a printer) Options, PrintPaperPS, and PrintTo commands
normalpostscript or 1 for Normal on (to
The GetPrintOptionsPS query
save PostScript descriptions of a multi-
ple-page publication to disk)

eps or 2 for EPS on (to save a single page PrintPaperPS sSize, sSource, yLength,
of a publication as an Encapsulated Post- xWidth, yPaperFeed, xPaperMargin,
Script file and add the PostScript com-
ments required for an EPS-formatted bOrientation, bCenter, cTiling, xOverlap,
document) cScaleType, nVal, cDuplex
preprint or 3 for For Separations on (to Specifies paper-related print options executed
create a .sep file: a publication ready for a with the Print command (for PostScript printers
color-separation, for use with Adobe Pre-
Print Pro, TrapWise, or PressWise) (Macin- only).
tosh only)
Parameter Values to enter
bExtraBleed off or 0 (zero) for Extra Image Bleed off
(image bleed =1/8 inch) sSize Name of standard paper size, in quota-
tion marks, and exactly as it appears in
on or 1 for Extra Image Bleed on (image the Size pop-up menu
bleed =1 inch if cToDisk = eps or 2 or pre-
print or 3) "Custom" (quotation marks required) for
user-defined paper size
bComm off or 0 (zero) for 2-way Communication
off sSource Name of paper tray, in quotation marks,
and exactly as it appears in the Source
on or 1 for 2-way Communication on pop-up menu

"Manual" (quotation marks required) for

Macintosh-only parameters. The bSymbol and manual feed
bComm parameters apply only to PageMaker for
yLength -2 for standard size paper
the Macintosh. PageMaker for Windows ignores
these parameters. Length (height) of custom paper (to a
maximum of 45 inches)
Extra image bleed. Set the bExtraBleed parameter
xWidth -2 for standard paper size
on only when printing to disk as an EPS or .SEP file
(when cToDisk equals eps or 2 or preprint or 3). Width of custom paper, (to a maximum
of 45 inches)
Layout view only. The PrintOptions command
yPaperFeed Distance between pages printed in suc-
works only in layout view. cession on a roll of paper or film.
Example. The following example sets the printer xPaperMargin Distance to offset the image area laterally
options for printing the publication directly to a (from side to side), to adjust for a non-
PostScript printer. Printed pages include printer's standard media width.

marks, the name, and the date of the publication, bOrientation normal or 0 (zero) for normal orientation
and prints images at normal resolution. Page of custom paper
information is sent to the printer in binary format. transverse or 1 for transverse orienta-
The PostScript error handler is included. The tion of custom paper
publication is not printed to disk, so Extra Image -2 if paper size is standard (not custom)
Bleed is off. 2-way communication is turned off.
bCenter 0 for Center Page in Print Area off
pr intoptionsps nor malimage, on, on, nor mal,
1 for Center Page in Print Area on (for
off, off, on, off, off, off asymmetrical print areas)
 ADOBE PAGEMAKER 7.0 130
Commands

Layout view only. The PrintPaperPS command

Parameter Values to enter
works only in layout view.
cTiling none or 0 for no tiling
Example. The following example prints a
manualtiling or 1 for manual tiling
standard, letter-size publication at 100% size.
autooverlap or 2 for Auto tiling (to over- Because sSize is standard (not custom), the
lap tiles by amount specified in xOverlap)
yLength, xWidth, yPaperFeed, xPaperMargin, and
xOverlap Minimum amount of overlap between bOrientation parameters are irrelevant.
tiles, in the specified unit of measure, if
autooverlap is specified for cTiling (to a pr intpaper ps " Le t ter " , " Pa p e r Tr ay " , - 2 , - 2 , - 2 , -
maximum of five inches) 2, -2, 0, 0, -2, 0, 1000 0
cScaleType numeric or 0 (zero) to scale the publica-
tion
See also:
fitonpaper or 1 to scale the publication
to fit the selected paper size The Print, PrintColors, PrintDoc, PrintInk, Print-
Options, PrintOptionsPS, and PrintTo commands
thumbnails or 2 to print thumbnails
The GetPrintPaperPS query
nVal Percentage for numeric scaling, from 5%
(50) to 1600% (16000), if cScaleType =
scaling or 0
PrintTo sPPD, sPrinter
Number of thumbnails per page, from 1
to 100, if cScaleType = thumbnails or 2 Specifies a PostScript printer description (PPD)
-2 if cScaleType is fitonpaper or 1 (can
and, for Windows only, the name of the printer.
range from 1 to 100)
Parameter Values to enter
cDuplex none or 0 (zero) obsolete parameter; you
sPPD PPD name for printer, in quotation marks
set duplex printing with the PrintFeature
and exactly as it appears in the PPD pop-
command, depending upon printer
up menu in the Print dialog box
capability
sPrinter Name of the printer, in quotation marks
Measurement units for scripts. If you do not and exactly as it appears in the Print To
specify a unit of measure for yLength, xWidth, pop-up menu in the Print dialog box

yPaperFeed, xPaperMargin, and xOverlap (e.g., i "" (empty quotation marks) when print-
for inches), PageMaker uses the default unit of ing from a Macintosh

measure, specified in the Preferences dialog box or

with the MeasureUnits command. Query to learn printer capabilities. If the PrintTo
command specifies a different type of printer than
nVal scale values. PageMaker scales the nVal scale
was previously targeted, it is a good idea to query
value by a factor of 10. To get 100% scaling, enter a (using the GetPrintCaps query) to find the new
value of "1000." target-printer capabilities.
Some parameters ignored for standard paper.
Layout view only. The PrintTo command works
yLength, xWidth, yPaperFeed, xPaperMargin, and
only in layout view.
bOrientation are ignored unless sSize is set to
"custom," which is available only when printing to
an imagesetter. See also:
Use bCenter for asymmetrical print areas. Use
The Print, PrintColors, PrintDoc, PrintInk, Print-
Options, PrintOptionsPS, and PrintPaperPS com-
bCenter to center the page on printers with
mands
asymmetrical print areas (such as the QMS Color-
Script). The GetPrintTo query
 ADOBE PAGEMAKER 7.0 131
Commands

PrivateData sDeveloperID, sPlugInID, Parameter Values to enter

cTargetClass, nTypeFlag, nCount,
bChange true or 1 to overwrite existing private
(nTargetID, bChange, hPrivateData, data from same plug-in
nSize)... false or 0 to return error (and leave pri-
Associates private data with the specified vate data unchanged) if target already
has private data from same plug-in
graphic, image, page, master page, story, text
block, or publication, by passing a handle to the hPrivateData Handle to the buffer that contains the
buffer containing the data. You can add private private data you want to store with the
specified element
data to more than one object at a time if the
objects are the same type (class). nSize Size of buffer

Note: Works only with plug-ins and scripts written sDeveloperID. To ensure that no one else uses
in other programs. your four-character developer ID, you should
Parameter Values to enter register it with the Adobe Plug-ins Support
Engineer.
sDeveloperID Four-character string representing your
name or your company name, in quota- Free memory. The plug-in or external script
tion marks (e.g., "ADBE" for Adobe) must both allocate and free a block of global
sPlugInID Four-character string representing plug- memory for the private data.
in, in quotation marks (e.g., "KYLN" for
the Keyline plug-in) Five parameters needed to identify data.
PageMaker requires five parameters to identify
cTargetClass classobject for imported graphics and
private data:
images, as well as PageMaker lines,
boxes, ovals, polygons, or text blocks
• sDeveloperID and sPlugInID to identify the
classstory for stories plug-in
classpub for publication (current publi- • cTargetClass and nTargetID to identify the
cation only)
element being assigned the data
classpage for page
• nTypeFlag to distinguish between data types
classmaster for master page
(you define this parameter)
nTypeFlag Identifier you define to distinguish nTypeFlag. You define the value of nTypeFlag.
between types of private data for same
cTargetClass (but -1 and -2 are not This identifier lets you distinguish between
allowed). If you don't need to classify different types of private data associated with a
your private data, use 0. class of objects (graphics, page, master page,
nCount Number of private-data records you are story, or publication). If you won't be assigning
adding more than one type of data, you can set this
nTargetID Internal PageMaker identifier for element
parameter to zero. Never set this ID to -1 or -2.
(graphic, image, page, master page, text bChange. If the target already has private data
block, or story) to which the private data
is associated from the same plug-in and with the same private
ID, and bChange is:
0 (zero) for publication (PageMaker asso-
ciates private data with the current pub- • True, then PageMaker overwrites the data
lication only)
• False, then existing private data remains
unchanged and PageMaker returns an error
(CQ_PDATA_ALREADY_EXISTS)
 ADOBE PAGEMAKER 7.0 132
Commands

Errors. PageMaker returns an error if:

Parameter Values to enter
• cTargetClass and nTargetID together do not nTypeFlag Identifier you define to distinguish
specify an existing element (graphic, image, text between types of private data for same
block, story, page, master page, or publication) cTargetClass (but -1 and -2 are not
allowed). If you don't need to classify
(CQ_INVALID_TARGET) your private data, use 0.
• bChange is false, and the specified private data nCount Number of private strings you are adding
already exists
(CQ_PDATA_ALREADY_EXISTS) nTargetID Internal PageMaker identifier for the ele-
ment (graphic, image, text block, page,
• nTypeFlag is -1 or -2 master page, or story) to which the pri-
vate string is associated
(CQ_INVALID_CONTEXT)
0 (zero) for publication (PageMaker asso-
ciates private strings with the current
See also: publication only)

The DeletePrivateData and PrivateString com- bChange true or 1 to overwrite existing private
mands string from same plug-in
The GetPrivateData, GetPrivateList, and GetPri- false or 0 to return error (and leave pri-
vateString queries vate string unchanged) if the target
already has private string from the same
plug-in

PrivateString sDeveloperID, sPrivateString Private string, in quotation marks

sPlugInID, cTargetClass, nTypeFlag,
sDeveloperID. To ensure that no one else uses
nCount, (nTargetID, bChange,
your four-character developer ID, you should
sPrivateString)...
register it with the Adobe Plug-ins Support
Associates a string with the specified graphic, Engineer.
image, page, master page, story, text block, or
publication. You can add private strings to more Five parameters needed to identify data.
than one object at a time if the objects are the PageMaker requires five parameters to identify a
same type (class). private string:

Parameter Values to enter

• sDeveloperID and sPlugInID to identify the
plug-in.
sDeveloperID Four-character string representing your
name or your company name, in quota- • cTargetClass and nTargetID to identify the
tion marks (e.g., ADBE for Adobe) element being assigned the data.
sPlugInID Four-character string representing plug- • nTypeFlag to distinguish between data types
in, in quotation marks (e.g., KYLN for Key-
(you define this parameter).
line plug-in)
nTypeFlag. You define the value of nTypeFlag.
cTargetClass classobject for imported graphics and
images, as well as PageMaker lines, This identifier distinguishes between the
boxes, ovals, polygons, or text blocks different types of private data associated with a
classstory for stories class of objects (graphics, page, master page,
story, or publication). If you won't be assigning
classpub for publication (current publi-
cation only) more than one type of data, you can set this
parameter to zero. Never set this ID to -1 or -2.
classpage for page
bChange. If the target already has a private
classmaster for master page
string from the same plug-in and bChange is:
 ADOBE PAGEMAKER 7.0 133
Commands

• True, then PageMaker overwrites the string. See also:

• False, then the existing private string remains The Close, Exit, Save, and SaveAs commands
unchanged and PageMaker returns an error
(CQ_PDATA_ALREADY_EXISTS).
Errors. PageMaker returns an error if:
Redraw bEnabled
Controls whether PageMaker redraws the screen in
• cTargetClass and nTargetID together do not
either layout view or story editor, depending on the
specify an existing element (graphic, image, text view displayed when the command is sent.
block, page, master page, story, or publication)
(CQ_INVALID_TARGET). Parameter Values to enter

• bChange is false, and the specified private bEnabled off or 0 (zero) to turn off redrawing of the
screen for the currently displayed view
string already exists
(layout view or story editor)
(CQ_PDATA_ALREADY_EXISTS).
on or 1 to turn on redrawing of the
• nTypeFlag is -1 or -2 screen for the currently displayed view
(CQ_INVALID_CONTEXT). (layout view or story editor)

Example. The following example creates a private

Drawing of windows not suppressed. Turning
string ("This is my string") for the object with
target ID 15 and associates the private string with screen redraw off does not suppress the drawing of
the developer ADBE, the plug-in KYLN, and the windows, only the content of the window. For
private ID 1. example, if you turn redraw off in layout view and
create a new publication, an empty publication
pr iv atest r ing "ADBE", "KYLN", classobject, 1, 1, window appears on the screen. PageMaker draws
1 5 , t r u e , " T h i s i s my s t r i n g " its content only after you turn redraw back on.
Error detection with Redraw off. Turning screen
See also: redraw off speeds execution of the plug-in or script
The DeletePrivateData and PrivateData com- and hides steps from the user until redraw is
mands turned on again. However, if PageMaker
The GetPrivateData, GetPrivateList, and GetPri- encounters an error before redraw is turned on
vateString queries again, you may not be able to tell where the error
occurred, and you will need to send the Redraw
command separately to PageMaker to turn it back
Quit on.
Exits PageMaker without saving the changes to the Caution: Always turn Redraw on at the end of plug-
open publications. in or script. Always turn Redraw back on at the
end of a plug-in or script, before returning control
Caution: Save before quitting. Unlike its menu
back to PageMaker. (Remember to turn Redraw
counterpart, the Quit command does not warn
back on for both story editor and layout view.) The
you if you have not saved the latest changes to the
Redraw command has no menu equivalent; you
publication. Use the Save or SaveAs commands if
must turn screen redraw back on using this
you want to save changes to the open publication.
command. Before you add this command to your
Example. The following example exits plug-in or script, be sure it runs smoothly.
PageMaker.
quit
 ADOBE PAGEMAKER 7.0 134
Commands

Example. The following example turns screen Single objects only. You can reflect only one
redraw off, selects all text, changes text size to 12 object at a time.
points, deselects the text, and then turns redraw
Whole text blocks. The Reflect command reflects
back on.
whole text objects, not individual characters or
re dr aw off groups of characters within a text object. You must
selectall select a text object with the Select command or the
size 12 pointer tool, not with the TextSelect command or
deselect text tool.
re dr aw on
Reflecting lines. If the selected object is a line, the
only valid values for cHandle are:

Reflect cHandle, cAxis center or 1 for the midpoint of the line

Reflects the selected object, either vertically or lefttop or 5 for the starting point of the line
horizontally, along the specified handle.
rightbottom or 8 for the end point of the line
Parameter Values to enter

cHandle Handle to use as reflection point:

Side handles:

left or 0

right or 2 Reflection not cumulative. Reflection is not

cumulative. Always specify reflection parameters
top or 3
in relation to the original (unreflected) position of
bottom or 4 the object.
Center of object: Text automatically recomposed. When text is
center or 1 reflected, PageMaker recomposes the text to wrap
around any object that has text-wrap attributes,
Corner handles:
which is specified with the TextWrap command.
lefttop or topleft or 5
cHandle for transformed objects. If the selected
leftbottom or bottomleft or 6
object was skewed, rotated, or reflected, cHandle
righttop or topright or 7
should correspond to the handle before the object
rightbottom or bottomright or 8 was transformed. For example, LeftTop always
cAxis none or 0 to return an object to its original
refers to the original left-top handle of an object,
orientation not the handle that is currently the left-most top
horizontal or 1 to reflect horizontally
handle.
(along x axis)

vertical or 2 to reflect vertically (along y

axis)

Layout view only. The Reflect command works

only in layout view.
 ADOBE PAGEMAKER 7.0 135
Commands

Example. The following example selects the fifth RemoveColor sColorName

object drawn and reflects it horizontally, centered
Removes the specified color from the Colors
around the left-bottom corner handle.
palette and applies Black to any objects of this
select 5 color.
refl e c t l e f t b o t to m h o r izon t a l
Parameter Values to enter

sColorName Name of color to remove, in quotation

See also: marks, exactly as it appears on Colors pal-
The TextWrap command ette

The GetTransform query

Example. The following example removes the
color Fuchsia from the Colors palette. Any text or
Relink [fFilename] graphics set to Fuchsia are changed to Black.
Relinks the selected object to the specified file or to remove color "Fuchsia"
its original file.

Parameter Values to enter See also:

fFilename Name of file (including the optional path) The DefineColor and ColorPalette commands
to which the selected object is to be The GetColorInfo and GetColorNames queries
linked, in quotation marks (to a maxi-
mum of 91 characters)

"" (empty quotation marks) to relink to

currently linked file
RemovePages nFirstPage, nLastPage
Deletes the specified range of pages and their
Single objects only. The Relink command relinks contents from the open publication.
only one object at a time; if more than one object Parameter Values to enter
is selected, the plug-in or script stops running at
nFirstPage The first number in the range of pages to
the Relink statement.
remove
Updating links. To update a link, omit the
nLastPage The last number in the range of pages to
fFilename parameter or use empty quotation remove
marks.
Example. The following example links a chart Master pages. To delete a master page, use the
graphic to the currently selected object. DeleteMasterPage command.

select 1 Automatic text rethread. When a page or range of

re link "ar tfolder :Char t.eps" pages is deleted, PageMaker automatically
rethreads text that comes before and after the
deleted pages, and then renumbers the remaining
See also: pages.
The PasteLink command
No warning message. Unlike its menu
The GetLinks, GetLinkInfo, and GetLinkOptions
counterpart, the RemovePages command does not
queries
ask you to verify the action before deleting the
pages.
Layout view only. The RemovePages command
works only in layout view.
 ADOBE PAGEMAKER 7.0 136
Commands

Example. The following example deletes pages 3 Paragraphs restyled as No Style. Any paragraphs
and 4 and their contents from the open publi- in the publication formatted with the deleted style
cation. retain their formatting, but the style assigned to
them is called No Style.
removepages 3, 4
Removing styles while defining or editing. Never
send a RemoveStyle command while a style is
See also:
being defined or edited with the StyleBegin and
The Cut, Clear, and DeleteMasterPage commands StyleEnd commands. If PageMaker encounters
The GetPages query RemoveStyle between a StyleBegin/StyleEnd pair,
it returns an error, and the style-definition context
remains in effect.
RemovePrinterStyle
Example. The following example deletes the style
called Heading 4.
sPrinterStyle rem ove s t y l e " He a d i n g 4 "

Removes the specified printer style.

See also:
Parameter Value
The GetStyle and GetStyleNames queries
sPrinterStyle Name of printer style to remove, in quo-
tation marks (maximum of 31 characters)

RemoveUnusedColors [bYesToAll]
Example. The following example queries for the
names of all the printer styles and deletes the Removes all colors and inks not being used in the
printer style Laser Legal. publication from the color palette and ink list.

getpr interst yles--Reply : 4, "Laser Le gal", "Laser Parameter Values to enter

Le tter", "L in o Le g a l ", "L i n o Le tter " bYesToAll false or 0 to display an alert before delet-
removep r i n terst y l e "L a ser l eg a l " ing each color or ink, so the user can
choose which ones to delete, and then
listing the number of colors and inks
See also: removed

The AddPrinterStyle and PrinterStyle commands true or 1 to remove all unused colors and
inks and suppress the summary report of
The GetPrinterStyles query the number of colors and inks removed
(the default)

RemoveStyle sStyle Example. The following example deletes all

Removes the named style. unused colors and inks in a publication.
removeunusedcolors t r ue
Parameter Values to enter

sStyle Exact name of the style to delete, in quo-

tation marks (to a maximum of 31 char- See also:
acters)
The DefineColor, InkND, and PrintInk com-
mands
The GetColor, GetColorInfo, GetColorNames,
GetInkNames, and GetInkND queries
 ADOBE PAGEMAKER 7.0 137
Commands

RemoveWord sWord[, sLanguage] RenameMasterPage

Removes the specified word from the user
dictionary for spell checking and hyphenation. sOldMasterName, sNewMasterName,
Parameter Values to enter bOverwrite
Renames an existing master page.
sWord Word to remove from user dictionary, in
quotation marks (maximum 63 charac-
Parameter Values to enter
ters)
sOldMaster- Name of master page to rename (maxi-
sLanguage Name of language dictionary, in quota-
Name mum of 31 characters)
tion marks and exactly as it appears in
Dictionary list box (maximum of 15 char- sNewMaster- New name to assign to master page
acters) Name (maximum of 31 characters)
"" (empty quotation marks or omit
bOverwrite false or 0 (zero) to leave existing master
parameter entirely) to remove word from
unchanged (if one exists with same
a dictionary assigned to the paragraph
name)
containing insertion point or selected
with text tool true or 1 to overwrite existing master (if
one exists with same name)
Multiple paragraphs. If you do not specify a
language and more than one paragraph is selected, Document Master and None. You cannot rename
but the paragraphs have different dictionaries the prenamed master pages, Document Master
assigned to them, the RemoveWord command and None.
removes the word from the publication default Unique name. When you rename a master page,
user dictionary. make sure you are not overwriting an existing
Text tool not active. In layout view, if you do not master page. Use the GetMasterPageList to
specify a language and a tool other than the text determine the names of all existing master pages.
tool is selected, the RemoveWord command Example. The following example renames the
removes the word from the publication default master page "Editorial" to "Two-column editorial,"
user dictionary. overwriting an existing master page of the same
Example. The following example removes the name (if it exists).
word "PageMaker" from the UK English user renamemaster page "Editor ial", "Two-column
dictionary. editor ial", t r ue
removeword "PageMaker", "UK Eng lish"

See also:
See also: The DefineMasterPage, DeleteMasterPage, Mas-
The AddWord, Spell, and SpellWindow com- terPage, and SaveAsMasterPage commands
mands The GetMasterPage, GetMasterPageInfo, and Get-
The GetPMInfo, GetSpellResult, and GetSpell- MasterPageList queries
Window queries
 ADOBE PAGEMAKER 7.0 138
Commands

RenderClip bDirection Pasting from the external Clipboard. PageMaker

renders the external Clipboard into its internal
(Macintosh only) Renders the contents of the
clipboard only when it:
PageMaker internal clipboard to the external
Clipboard, or vise versa, overwriting the current • Receives the RenderClip command
contents of the receiving clipboard. • Becomes active. (When an external plug-in or
Parameter Values to enter script is sending commands to PageMaker,
PageMaker remains inactive and thus does not
bDirection in or 0 to render the contents of the
external Clipboard into the PageMaker
render its clipboard unless forced to by the
internal clipboard RenderClip command.)
out or 1 to render the contents of the • Receives a menu command through the mouse
PageMaker internal clipboard into the or a keyboard shortcut
external Clipboard
Example. The following example renders the
Macintosh only. This command has no effect in external Clipboard to the PageMaker internal
PageMaker for Windows. format.
renderclip in
PageMaker in foreground and in layout view.
PageMaker must be in the foreground and in
layout view when this command is executed; See also:
otherwise an error will be returned.
The Cut and Paste commands
Pasting from the PageMaker internal clipboard.
PageMaker cuts and copies selected objects to its
internal clipboard, not to the standard Macintosh Resize cHandle, xyLocation[,
Clipboard. To paste data copied or cut by yLocation][, bProp[, bBestSize]]
PageMaker into another application, you must Changes the size of the selected object.
force PageMaker to render its internal clipboard
into the external Clipboard. If you don't, the appli- Parameter Values to enter
cation pastes the current contents of the cHandle Handle to drag:
Clipboard, not the data from PageMaker.
Side handles:
PageMaker renders its clipboard to the external left or 0
format only when it:
right or 2
• Receives the RenderClip command
top or 3
• Becomes inactive, such as when another appli- bottom or 4
cation or desk accessory becomes active. (When an
Corner handles:
external plug-in or script is sending commands to
PageMaker, PageMaker is already inactive and thus lefttop or topleft or 5
does not render its clipboard unless forced to by leftbottom or bottomleft or 6
the RenderClip command.) righttop or topright or 7
• Sends mail. (This option is available only if rightbottom or bottomright or 8
Microsoft Mail is installed and has no plug-in
command equivalent.)
• Quits
 ADOBE PAGEMAKER 7.0 139
Commands

Proportional resizing. If you use a corner for

Parameter Values to enter
cHandle when resizing proportionally, PageMaker
xyLocation x or y coordinate, relative to the current resizes the object proportionally based only on the
zero point, to which you want the speci-
fied part dragged; if cHandle is a corner x-axis coordinate and disregards the y-axis
(that is, lefttop, leftbottom, righttop, or coordinate. Use left, right, top, or bottom for
rightbottom), both the x and y coordi- cHandle to resize the object in only one direction
nates are required
or when resizing proportionally. Specify a corner
yLocation y coordinate, relative to the current zero (lefttop, leftbottom, righttop, rightbottom) for
point, to which you want a corner cHandle to resize the object both horizontally and
dragged (required only if cHandle is a
corner) vertically, but not proportionally.

bProp false or 0 (zero) for no proportional resiz- Do not resize lines. Using Resize to change the
ing, the default length of a line may cause unexpected results. If
true or 1 for proportional resizing you want a different line length, it's best to delete
the line and create a new one.
bBestSize false or 0 (zero, the default)
cHandle for transformed objects. If the selected
true or 1 for stretching a paint-type
graphic to the best size for the printer object was skewed, rotated, or reflected, cHandle
resolution should correspond to the handle before the object
was transformed. For example, lefttop always
Measurement units for scripts. If you do not refers to the original left-top handle of an object,
specify a unit of measure for xyLocation (e.g., i for not the handle that is currently the left-most top
inches), PageMaker uses the default unit of handle.
measure, specified in the Preferences dialog box or
with the MeasureUnits command.
Single objects only. The Resize command can
resize only one object at a time; if more than one
object is selected, the plug-in or script will stop Layout view only. The Resize command works
running at the Resize statement. only in layout view.
bProp and bBestSize together. The bProp and Example. The following example turns Snap to
bBestSize parameters can be used in combination, Guides and Snap to Rulers off so the location you
if desired. specify is not pulled to a guide or ruler division.
Snap to guides and rulers. Just as when resizing Next, it selects an object, resizes the object by
an object with the pointer tool, the Resize dragging the left-edge handle as close to the
command is sensitive to the setting of the Snap to specified coordinates as possible, keeps the
Guides and Snap to Ruler options. If Snap to selection proportional, and fits it to the printer
Guides or Snap to Rulers are on, the object may be resolution. Finally, it turns Snap to Guides and
resized to a guide or ruler division rather than the Snap to Rulers back on.
location you specify. To avoid this possibility, turn snapto guides off
Snap to Guides and Snap to Rulers off prior to snaptor ulers off
resizing, using the SnapToGuides and select (column 2 left, co lumn top)
SnapToRulers commands. resize left, 3.5i, t r ue, t r ue
Size of publication window. If the publication snapto guides on
window is less than one fourth the size of the snaptor ulers on
screen, you must turn off the SnapToGuides and
SnapToRulers commands prior to resizing.
 ADOBE PAGEMAKER 7.0 140
Commands

See also: 100% yields no change. If dXYPercentage is 100,

The ResizePct command the object size does not change.
The GetTransform query Effects are cumulative. Unlike the Control
palette, resizing using the ResizePct command is
cumulative. For example, resizepct right 200
ResizePct cHandle, dXYPercentage[, followed by resizepct right 200 results in a 400%
dYPercentage][, bProp[, bBestSize]] enlargement toward the right. (When you resize an
Resizes an object to the specified percentage. object with the Control Palette, the percentage is
always applied to the original object size and,
Parameter Values to enter therefore, is not cumulative.)
cHandle Handle to drag: dXYPercentage. If dXYPercentage includes more
Side handles: than one decimal place, PageMaker truncates the
percentage to tenths of a percent. For example,
left or 0
10.199 becomes 10.1 percent.
right or 2
Proportional resizing. If you use a corner for
top or 3
cHandle when resizing proportionally, PageMaker
bottom or 4 resizes the object proportionally based on the x
Corner handles: value only and disregards the y value. Use the left,
right, top, or bottom coordinate to resize the object
lefttop or topleft or 5
in only one direction or when resizing propor-
leftbottom or bottomleft or 6
tionally. Specify a corner (lefttop, leftbottom,
righttop or topright or 7 righttop, rightbottom) to resize the object both
rightbottom or bottomright or 8 horizontally and vertically.

dXYPercentage Percentage to resize the object horizon- Snap to guides and rulers. Just as when resizing
tally (along the x axis) or vertically (along an object with the pointer tool, the ResizePct
the y axis); or both an x and y percentage
command is sensitive to the Snap to Guides and
when cHandle is a corner (that is, lefttop,
leftbottom, righttop, or rightbottom) Snap to Ruler options. If Snap to Guides or Snap to
Rulers are on, the object may be resized to a guide
dYPercentage Percentage to resize the object vertically
(along the y axis) when cHandle is a cor-
or ruler division that is close to the percentage you
ner (that is, lefttop, leftbottom, righttop, specify. To avoid this possibility, turn Snap to
or rightbottom) Guides and Snap to Rulers off prior to resizing,
bProp false or 0 (zero) for no proportional resiz- using the SnapToGuides and SnapToRulers
ing (the default) commands.
true or 1 for proportional resizing Size of publication window. If the publication
bBestSize false or 0 (zero, the default) window is less than one fourth the size of the
screen, you must turn off the SnapToGuides and
true or 1 for stretching a paint-type
graphic to the best size for the printer SnapToRulers commands prior to resizing.
resolution
Do not resize lines. Using ResizePct to change the
length of a line may cause unexpected results. If
Single objects only. The ResizePct command can
you want to change a line length, it's best to delete
resize only one object at a time; if more than one the line and create a new one.
object is selected, the plug-in or script will stop
running at the ResizePct statement.
 ADOBE PAGEMAKER 7.0 141
Commands

cHandle for transformed objects. If the selected color "Fuchsia"

object was skewed, rotated, or reflected, cHandle restorecolor
should correspond to the handle before the object
was transformed. For example, lefttop always
See also:
refers to the original left-top handle of an object,
not the handle that is currently the left-most top The Color, ColorPalette, and DefineColor com-
handle. mands
The GetColor, GetColorInfo, GetColorNames,
and GetColorPalette queries

ReversePolyVertices
Layout view only. The ResizePCT command
Reverses the order of vertices of selected polygons.
works only in layout view.
For example, if a polygon's vertices order was P1,
Example. The following example turns Snap to P2, …, Pn-1, Pn, and you apply this command, the
Guides and Snap to Rulers off so the resized object vertices order will become Pn, Pn-1,…, P2, P1.
is not pulled to a guide or ruler division. Next, it PageMaker always draws a polygon in the order of
selects an object, drags the left handles of the vertices, and it always draws a polygon side
object to make it 80% of its current size, resizes it hanging to the right. Reversing the polygon's
proportionally, and does not stretch it to the best vertices order could result in a very different
size for the printer. Finally, it turns Snap to Guides polygon in terms of how it looks, especially when
and Snap to Rulers back on. the polygon's sides have a thick stroke. This
snapto guides off command only works on irregular polygons; it has
snaptor ulers off no effect on regular ones.
select (column 2 left, co lumn bottom) Layout view only. The ReversePolyVertices
re s i ze p c t l e f t , 8 0 , t r u e , f a l s e command works only in layout view.
snapto guides on
snaptor ulers on
See also:
The PolygonVertices, CreatePolygon, PolygonType
See also: commands
The Resize command The GetPolygonVertices, GetPolygonType queries
The GetTransform query

Revert [cKind]
RestoreColor Restores the most recently saved version of the
Removes a PageMaker-applied color from the publication or template, deleting all changes made
currently selected imported image. since the last time it was saved or minisaved.

Layout view only. The RestoreColor command Parameter Values to enter

works only in layout view.
cKind saved or 0 (zero) to revert to the last-
Example. The following example selects a saved version (the default)

graphic, applies the color Fuchsia to it, and then minisaved or 1 to revert to the last
removes the color. minisaved version

select 1
 ADOBE PAGEMAKER 7.0 142
Commands

Saved value same as reverting. Using the Saved

Parameter Values to enter
value is the same as closing the publication without
saving changes from the current session and then Corner handles:

reopening the publication; it reverts to the last- lefttop or topleft or 5

saved version. leftbottom or bottomleft or 6
Minisaved value same as canceling. Using the righttop or topright or 7
minisaved value is the same as canceling the rightbottom or bottomright or 8
changes made since performing any of the actions
dAngle Degrees (up to 3 decimal places) to
that cause an automatic minisave—inserting or
rotate object (positive values are mea-
deleting a page, changing to a different page, sured counterclockwise from the x axis)
printing, copying, switching between layout view
and story editor, using the Clipboard, or changing Normal orientation. Zero (0) degrees is the
the page setup of a publication. normal, unrotated position of an object.
No confirmation required by PageMaker. Unlike Whole text blocks. The Rotate command rotates
the menu command, the command-language whole text blocks, not individual characters or
version does not display a message asking the user groups of characters within a text block. Select a
to confirm this action before proceeding. text block for rotation only with the Select
Example. The following example cancels all
command or the pointer tool, not the TextSelect
changes made since the publication was last command or text tool.
minisaved. Text automatically recomposed. When text is
re ver t mi n i save d
rotated, PageMaker recomposes the text to wrap
around any objects that have text-wrap attributes
(specified with the TextWrap command).
See also:
• Rotating lines. If the selected object is a line, the
The MiniSave, Save, and SaveAs commands
only valid values for cHandle are:
• center or 1 for the midpoint of the line
Rotate cHandle, dAngle • lefttop or 5 for the starting point of the line
Rotates selected objects by the specified degrees, • rightbottom or 8 for the end point of the line
centering the rotation on the specified object
handle.

Parameter Values to enter

cHandle Handle to use as reflection point:

Side handles:

left or 0

right or 2

top or 3

bottom or 4

Center of object:

center or 1
 ADOBE PAGEMAKER 7.0 143
Commands

Rotating single objects. When rotating a single Note: this behavior differs slightly from rotating
object that was previously skewed, rotated, or objects with the Control palette, which uses the same
reflected, cHandle should correspond to the handles as long as the objects remain selected.
handle before the object was transformed. For
example, lefttop always refers to the original left-
top handle of an object, not the handle that is
currently the left-most top handle.

Rotating around a specified point. To rotate an

object around a separate, specified point (not a
point on the object), you must use both the Move
Rotation not cumulative on single objects. As and Rotate (or Nudge and Rotate) commands.
when rotating using the Control palette, rotating a
Layout view only. The Rotate command works
single object around a specified handle is not
only in layout view.
cumulative. Always specify the degrees in relation
to the unrotated position of the object. For Example. The following example selects the third
example, if a text block has been rotated 90 degrees object drawn and rotates it 25 degrees, centered on
around the top handle and you want to rotate it an the bottom-left corner.
additional 30 degrees, you must specify a rotation select 3
of 120 degrees, not 30. rotate bottomleft 25
Rotating multiple objects. When rotating
multiple objects with the rotate command,
See also:
PageMaker defines a temporary (and invisible)
bounding box that encompasses all the objects. The TextWrap command
The cHandle parameter refers to the handles of The GetTransform query
this temporary box. Once you rotate the objects,
PageMaker redefines the bounding box (and its
handles) just as if the objects were selected again. RoundedCorners cCornerStyle
Therefore, rotation can be cumulative (rotating 90 Assigns a shape to the corners of the selected
degrees and 90 degrees again results in a total rectangles or squares, or, if nothing is selected, sets
rotation of 180 degrees), but the point of rotation the corner style for subsequently drawn rectangles
changes each time because PageMaker rotates the or squares.
objects about the new handle.
Parameter Values to enter

cCornerStyle 0, 1, 2, 3, 4, or 5, corresponding to order

of the corner styles shown in dialog box
 ADOBE PAGEMAKER 7.0 144
Commands

Making rounded corners. Unlike the toolbox,

Parameter Values to enter
which includes two rectangle tools, there is only
one command to draw rectangles, the Box cLineStyle dontcare or -2 to leave the line style
unchanged
command. The RoundedCorners command
rounds the corners of any PageMaker rectangle. none or 0 (zero)

hairline or 1
Text tool, story editor, or no box. If either the text
tool or story editor is active, or no PageMaker halfpoint or 2
boxes are selected, the specified corner shape onepoint or 3
becomes the default setting for the publication. twopoint or 4
Example. The following example draws a fourpoint or 5
rectangle with slightly curved corners. sixpoint or 6
b ox 2 i , 3 I , 7 i , 1 0 i eightpoint or 7
roundedcor n ers 1
twelvepoint or 8

thinthin or 9
See also:
thickthin or 10
The Box command
thinthick or 11
The GetRoundedCorners query
thinthickthin or 12

thindash or 13

RuleAbove bRuleOn, cLineStyle, mediumdash or 14

sLineColor, cLineWidth, xLeftIndent, thickdash or 15
xRightIndent, dWeight, bOpaque[, squares or 16
nLineTint]
dots or 17
Turns the Rule Above paragraph option on or off,
customsolid or 31 for a solid line of
and sets paragraph rule attributes. The extent of weight specified by dWeight
the action depends on which tool is active, whether
sLineColor Line-color name, in quotation marks,
any text is selected, and whether a publication is
exactly as it appears in the Line Color
open when the command is executed. pop-up list (to a maximum of 31 charac-
ters)
Parameter Values to enter
cLineWidth text or 0 to have rule span the width of
bRuleOn off or 0 (zero) text
1 or on to display the rule above the column or 1 to have rule span the width
paragraph of column

dontcare or -2 to leave width

unchanged

xLeftIndent Amount of rule indent from the left col-

umn guide or from left edge of text,
depending on the setting for cLineWidth

xRightIndent Amount of rule indent from right column

guide or from right edge of text, depend-
ing on setting for cLineWidth
 ADOBE PAGEMAKER 7.0 145
Commands

Example. The following example selects the text

Parameter Values to enter
object at the top of the left column, inserts the
dWeight Weight of a custom line (in points) insertion point before the first character of the text
dontcare or -2 to leave line weight object, displays a rule above the first paragraph in
unchanged or for predefined line the text object, and specifies the rule as a three-
weights (e.g., hairline)
point, 20% red line that runs the width of the
bOpaque false or 0 for transparent background column, with quarter-inch indents from the
behind dotted, dashed, or compound
column edges.
lines

true or 1 for opaque background behind select (column 1 left, co lumn top)
dotted, dashed, or compound lines tex te d i t
dontcare or -2 to leave transparency set- r uleabove on, custom, "Red", column, .25i, .25i,
ting unchanged 3, 0, 20

nLineTint Percentage of color to apply to rule (from

0 to 100) See also:
dontcare or -2 to leave tint setting
The ParaOptions, RuleBelow and LineStyle com-
unchanged (default)
mands
Measurement units for scripts. If you do not The GetRuleAbove and GetRuleOptions queries
specify a unit of measure for the indents (e.g., i for
inches), PageMaker uses the default unit of
measure, specified in the Preferences dialog box or RuleBelow bRuleOn, cLineStyle,
with the MeasureUnits command. sLineColor, cLineWidth, xLeftIndent,
xRightIndent, dWeight, bOpaque[,
Parameters ignored if bRuleOn is off. If the
nLineTint]
bRuleOn parameter is off, the rule above the
selected paragraph is turned off and all other Turns the Rule Below paragraph option on or off
parameters are ignored. and sets paragraph rule attributes. The extent of
the action depends on which tool is active, whether
dWeight parameter overrides cLineStyle. Set the any text is selected, and whether a publication is
dWeight parameter to -2 unless you are defining a open when the command is executed.
custom line. The value of dWeight overrides the
line weight specified in cStyle. Parameter Values to enter

dWeight truncated. If dWeight includes more bRuleOn off or 0 (zero)

than one decimal place, PageMaker truncates the on or 1 to display the rule above the
value to tenths of a point. For example, 10.199 paragraph
becomes 10.1 points.
 ADOBE PAGEMAKER 7.0 146
Commands

Parameter Values to enter Parameter Values to enter

cLineStyle dontcare or -2 to leave the line style dWeight Weight of a custom line (in points)
unchanged
dontcare or -2 to leave line weight
none or 0 (zero) unchanged or for predefined line
weights (e.g., hairline)
hairline or 1
bOpaque false or 0 for transparent background
halfpoint or 2
behind dotted, dashed, or compound
onepoint or 3 lines

twopoint or 4 true or 1 for opaque background behind

dotted, dashed, or compound lines
fourpoint or 5
dontcare or -2 to leave transparency set-
sixpoint or 6 ting unchanged
eightpoint or 7
nLineTint Percentage of color to apply to rule (from
twelvepoint or 8 0 to 100)

thinthin or 9 dontcare or -2 to leave tint setting

unchanged (default)
thickthin or 10

thinthick or 11 Measurement units for scripts. If you do not

thinthickthin or 12 specify a unit of measure for the indents (e.g., i
for inches), PageMaker uses the default unit of
thindash or 13
measure, specified in the Preferences dialog box
mediumdash or 14
or with the MeasureUnits command.
thickdash or 15
Parameters ignored if bRuleOn is off. If the
squares or 16 bRuleOn parameter is off, the rule below the
dots or 17 selected paragraph is turned off and all other
customsolid or 31 for a solid line of parameters are ignored.
weight specified by specified by dWeight
dWeight parameter overrides cLineStyle. Set the
sLineColor Line-color name, in quotation marks, dWeight parameter to -2 unless you are defining
exactly as it appears in Line Color pop-up
a custom line. The value of dWeight overrides
list (to a maximum of 31 characters)
the line weight specified in cStyle.
cLineWidth text or 0 to have rule span the width of
text dWeight truncated. If dWeight includes more
than one decimal place, PageMaker truncates the
column or 1 to have rule span the width
of column value to tenths of a point. For example, 10.199
becomes 10.1 points.
dontcare or -2 to leave width
unchanged Example. The following example selects the text
xLeftIndent Amount of rule indent from the left col- block at the top of the left column, inserts the
umn guide or from the left edge of the insertion point before the first character of the
text, depending on the value for cLine-
text block, displays a rule below the first
Width
paragraph in the text block, and specifies the
xRightIndent Amount of rule indent from right column rule as a three-point, 20% red line that runs the
guide or from right edge of text, depend-
ing on setting for cLineWidth
width of the column, with quarter-inch indents
from the column edges.
select (column 1 left, co lumn top)
 ADOBE PAGEMAKER 7.0 147
Commands

tex te d i t Measurement units for scripts. If you do not

r u l ebel ow o n , cu sto m, "Red ", co l u m n , . 2 5 i , . 2 5 i , specify a unit of measure for the offsets (e.g., i
3, 0, 20 for inches), PageMaker uses the default unit of
measure, specified in the Preferences dialog box
or with the MeasureUnits command.
See also:
The ParaOptions, RuleAbove and LineStyle com- dGridSize truncated. If dGridSize includes more
mands than one decimal place, PageMaker truncates the
The GetRuleBelow and GetRuleOptions queries value to tenths of a point. For example, 10.199
becomes 10.1 points.
Turning rules on. The RuleOptions command
RuleOptions yTopOffset, specifies the location of paragraph rules but
yBottomOffset, bAlignToGrid, dGridSize does not actually turn the rules on. Use the
Specifies the vertical placement of paragraph RuleAbove or RuleBelow command to turn the
rules and establishes a leading grid to ensure the rules on or off and to specify the rule style, color,
alignment of baselines. The extent of the action and width.
depends on which tool is active, whether any Aligning text baselines. To restore the baseline
text is selected, and whether a publication is alignment of body text, set the grid size to match
open when the command is executed. the leading of the body text. PageMaker
Parameter Values to enter
measures the leading grid from the top of the
text column containing the current paragraph.
yTopOffset Vertical offset above the baseline for the
top rule (from 0 to 22.75 inches) Example. The following example selects a text
-1 or auto for automatic alignment of the block, inserts the insertion point before the first
upper edge of the rule with the top of the character of the text block, specifies a top rule of
slug of the first line of every selected 1 pica above the baseline and automatic
paragraph
placement of the bottom rule. It also specifies
yBottomOffset Vertical offset below the baseline for the alignment of the baseline of the text in the next
bottom rule (from 0 to 22.75 inches) paragraph to a 10-point grid.
-1 or auto for automatic alignment of the
select (column 1 left, co lumn top)
bottom edge of the rule along the bot-
tom of the slug of the last line of every tex te d i t
selected paragraph r ulebelow on, twopoint, "Red", co lumn, .25i,
bAlignToGrid false or 0 .25i
r u le op t i on s 1 p, - 1 , t r u e , 1 0
true or 1 to align the baselines of the
next paragraph to the grid

dontcare or -2 to leave the setting See also:

unchanged
The ParaOptions, RuleAbove, and RuleBelow
dGridSize Grid size in points (from 0 to 1300 points) commands
dontcare or -2 to leave the setting The GetRuleOptions query
unchanged
 ADOBE PAGEMAKER 7.0 148
Commands

Rulers bState
Turns the horizontal and vertical rulers on or
off.

Parameter Values to enter

bState off or 0 (zero)

on or 1

Example. The following example turns the

rulers on.
r ulers on

See also:
The GuideHoriz, Guides, GuideVert, and Prefer-
ences commands
The GetRulers query
 ADOBE PAGEMAKER 7.0 149
Commands

Save Parameter Values to enter

Saves the active publication. cKind publication or 0 (zero, the default)

Use SaveAs command if publication is untitled. template or 1 (in Windows, include the
To save an untitled publication (and to name it) or extension .t65 in the filename)

to save a publication to a new name or location, 2 for PageMaker 6.5 format, so the publi-
use the SaveAs command. (If you try to use Save cation can be opened in PageMaker 6.5
(in Windows, include the extension .p65
while in an untitled publication, PageMaker won't in the filename)
execute the command and the plug-in or script will
cCopyWhat none or 0 (zero, the default) to save only
stop at that command statement.)
the publication, not the linked files
PageMaker warning for low disk space. If the remote or 1 to copy all files that are
hard disk does not have enough disk space needed to print that publication into one
available when the Save command is encountered, folder, including any linked files and spe-
cial files that contain instructions for
PageMaker displays an alert. composing the publication (such as the
track-kerning resource file)
Example. The following example saves the active
publication. linked or 2 to copy all externally located
files to the folder in which the publica-
save tion is being saved

bPreview none or 0 to save the publication with-

out a Fetch preview (the default)
See also:
preview or 1 to save a Fetch preview
The SaveAs command
with the publication

Using SaveAs command. Use SaveAs to do the

SaveAs fPubname[, cKind, cCopyWhat[, following:
bPreview]]
• Name and save a new publication or template
Saves the active publication, using the specified
filename, as a publication or template. Also copies • Make and name a copy of an existing publication
linked documents, if specified. or template

Parameter Values to enter

• Save the active publication or template to a
different disk or folder
fPubname Exact name and path (optional) of the
publication to save, in quotation marks • Save the active publication or template to a new
(to a maximum of 91 characters, includ- name and in the previous version format
ing path)
• Reduce the size of the active publication or
(Windows only) Include the appropriate
filename extension: .pmd (PageMaker
template (if the cSaveOption parameter of the
7.0 publication), .pmt (PageMaker 7.0 Preferences command is set to smaller, using Save
template), .p65 (if cKind is 2), or .t65(if will do the same thing)
cKind is 2 and you want the publication
to be a template) No warning if overwriting existing file. Unlike the
Save As command on the File menu, the SaveAs
command does not prompt you if a file of the same
name exists; instead, it automatically replaces the
file.
 ADOBE PAGEMAKER 7.0 150
Commands

Links not saved in cases of low disk space. If you Facing pages. If a two-page spread is currently
specify linked for the cCopyWhat parameter and displayed, SaveAsMasterPage creates a two-page
there is not enough room for both the publication master spread. If a single page is displayed, SaveAs-
and its linked files, PageMaker displays an alert MasterPage creates a single master page.
message and does not copy the linked files.
Unique name. When you copy a page to a new
Saving templates in Windows. To save a publi- master page, be sure you are not overwriting an
cation as a template in Windows, you must specify existing one. Use the GetMasterPageList to
the filename extension ".pmt." PageMaker for determine the names of all existing master pages.
Windows uses the extension to distinguish
Example. Copies the content, guides, and margins
between templates and publications.
of the current page to a new master named
Saving as 6.5 format. If you specify cKind as 2, "Chapter." If an existing master already has the
PageMaker disregards the cCopyWhat and name "Chapter," the SaveAsMasterPage overwrites
bPreview parameters. it.
Example. The following example saves "mypub" saveasmaster page "Chapter", t r ue
as a publication, copies all documents linked to
"mypub," and does not include a Fetch preview
See also:
with the publication (the default setting when the
parameter is omitted). The DefineMasterPage, DeleteMasterPage, Mas-
terPage, and RenameMasterPage commands
saveas "my floppy :my folder :my pub", publi-
The GetMasterPage, GetMasterPageInfo, and Get-
c a t i o n , l i n ke d MasterPageList queries

See also:
The Save command
SaveStatusOff
Turns off the save status of the current publication.
Use with caution! Check status first! If you turn
SaveAsMasterPage sMasterName, the save status off, PageMaker does not know the
bOverwrite true save state of the publication, which might
Copies the content, guides, and margins of the contain changes made prior to running the script
current pages to the specified master page, either or plug-in. Therefore, if you plan to turn off the
creating a new master or overwriting an existing save status, always check the save state before your
one. script or plug-in does anything to the publication.
In this way, you can save any changes in the publi-
Parameter Values to enter
cation and thus not lose work made prior to
sMasterName Name of new master page (maximum of running the script or plug-in.
31 characters)
Alerts always suppressed while running script or
bOverwrite false or 0 (zero) to leave existing master plug-in. PageMaker uses the save status to
unchanged (if one exists with same
name) determine if it should display an alert before
closing a publication, thus protecting the user
true or 1 to overwrite existing master (if
one exists with same name) from losing changes. However, when running
scripts and plug-ins, PageMaker alerts and dialog
Layout view only. The SaveAsMasterPage
boxes are suppressed, regardless of the save status.
command works only in layout view. Therefore, you do not need to use this command to
suppress the save alert.
 ADOBE PAGEMAKER 7.0 151
Commands

See also: See also:

The GetSaveStatus query The GetScrollbars query

Scroll x1, y1 Select nDrawOrder Select x1, y1

Centers the specified location within the publi- Selects a text block or graphic object by drawing
cation window. order or by location. The syntax you use for the
command depends upon whether you specify the
Parameter Values to enter
object by its drawing order or by its coordinates:
x1 x coordinate, relative to the current zero
point, of the location to appear in the Parameter Values to enter
center of the publication window
DrawOrder Drawing-order number of the object
y1 y coordinate, relative to the current zero
point, of the location to appear in the x1 x coordinate of object, relative to the cur-
center of the publication window rent zero point

y1 y coordinate of the object, relative to the

Measurement units for scripts. If you do not current zero point

specify a unit of measure (e.g., i for inches),

PageMaker uses the default unit of measure, Measurement units for scripts. If you do not
specified in the Preferences dialog box or with the specify a unit of measure (e.g., i for inches),
MeasureUnits command. PageMaker uses the default unit of measure,
specified in the Preferences dialog box or with the
Layout view only. The Scroll command works
MeasureUnits command.
only in layout view.
Using the location method of selection. Selecting
Example. The following example positions the
an object with x and y coordinates (the location
specified point (4 inches to the right on the x axis
method) is identical to selecting the object with the
and 1.3 inches down the y axis) in the center of the
mouse. Your choice of allowable coordinates
publication window.
depends upon the type of object:
s c ro l l 4 1 , 1 . 3 i
• For an imported image or a text block, you can
specify coordinates anywhere within the area
defined by the selection handles of the object.
Scrollbars bState
• For a filled oval drawn in PageMaker, the coordi-
Turns the scrollbars off and on.
nates must intersect the oval, not its bounding box
Parameter Values to enter (for example, not its corner handles).
bState off or 0 (zero) • For unfilled boxes or ovals drawn in PageMaker,
on or 1 the coordinates must intersect the object line (or,
for round-cornered boxes, its handles).
Layout view only. The Scrollbars command Drawing order. The drawing order is determined
works only in layout view. by the order in which objects are drawn, inserted,
pasted, or placed on the page. Note that some
Example. The following example displays the
commands, such as Send to Back and Send to
scrollbars.
Front on the Arrange menu and moving or resizing
scrollbars on an object with the mouse, can also affect drawing
order.
 ADOBE PAGEMAKER 7.0 152
Commands

No drawing order for inline graphics. Inline Example. The following example selects all
graphics are not assigned a drawing order and objects on the page and pasteboard.
must be selected using the location method.
selectall
Selecting text. To select (highlight) text, use the
TextSelect command.
See also:
Layout view only. The Select command works The Select, SelectExtend, and TextSelect com-
only in layout view. mands
Example . The following example selects the The GetSelectInfo and GetSelectList queries
second object drawn.
select 2
SelectExtend
The following example selects the object
positioned 1 inch to the right on the x axis and 4 nDrawOrderSelectExtend x1, y1
inches down on the y-axis. Extends the selection to include the specified
select 1i, 4i object without deselecting other selected objects.
The syntax you use for the command depends
upon whether you specify the object by its drawing
See also: order or by its coordinates.
The SelectAll, SelectExtend, and TextSelect com-
Parameter Values to enter
mands
The GetSelectInfo and GetSelectList queries DrawOrder Drawing order of object

x1 x-coordinate of object, relative to the

current zero point number
SelectAll y1 y-coordinate of the object, relative to the
Selects all objects (text blocks, graphics, and current zero point
frames) on the current page and pasteboard, or
selects all the text in the story, depending upon the Measurement units for scripts. If you do not
tool that is used and whether layout view or the specify a unit of measure for the coordinates (e.g.,
story editor is active. i for inches), PageMaker uses the default unit of
measure, specified in the Preferences dialog box or
Layout view: Selection varies among tools. When
with the MeasureUnits command.
any tool except the text or cropping tool is active,
PageMaker selects all items on the current page (or Shift + click equivalent for selection. The Select-
facing pages) and on the pasteboard. Extend command is equivalent to holding down
the Shift key while clicking on an object. However,
If the text tool is active and there is no insertion
this command does not deselect an object if it is
point in a text object, or if the cropping tool is
already selected.
active, nothing is selected.
Drawing order. Drawing order is determined by
If the text tool is active and an insertion point (text
the order that objects were drawn, inserted, pasted,
cursor) is in the text, the entire story is selected,
or placed on the page. Note that some commands,
including portions that are not on the current
such as Send to Back and Send to Front on the
page.
Arrange submenu and moving or resizing an
Story editor. If story editor is open, PageMaker object with the mouse, can also affect the drawing
selects all the text in the currently active story. order.
 ADOBE PAGEMAKER 7.0 153
Commands

No drawing order for inline graphics. Inline SelectIDExtend nObjectID

graphics are not assigned a drawing order and
Extends the selection to include the specified
must be selected by position on the page.
object (if it is on the current page) without
Layout view only. The SelectExtend command deselecting other selected objects.
works only in layout view.
Parameter Values to enter
Example. The following example adds the second
nObjectID Unique ID of object.
object drawn to the current selection.
s e l e c texten d 2 Objects on current page only. To select an object
using SelectIDExtend, the object must be on the
See also: current page (or pages, for facing pages). If the
object is not on the current pages, PageMaker
The Select and SelectAll commands
disregards the command and does nothing.
The GetSelectInfo and GetSelectList queries
Layout view only. The SelectIDExtend
command works only in layout view.
SelectID nObjectID Example. The following example adds the
Selects a text block or graphic in the current publi- object with the ID of 20 to the current selection.
cation by unique ID.
s e l e c t i d exten d 2 0
Parameter Values to enter

nObjectID Unique ID of object. See also:

The Select, SelectID, SelectAll, SelectExtend, and
PageMaker turns page. If the object is not on the TextSelect commands
current page, PageMaker turns to the page The GetSelectIDList, GetSelectInfo, and GetSe-
containing the object. lectList queries
Layout view only. SelectID command works
only in layout view.
SelectLayer sLayerName, bExtend
Example. The following example selects the
Selects the objects on the current page that are
object whose ID is 20.
assigned to the layer indicated by sLayerName.
selectid 20
Parameter Values to Enter

sLayerName Name of the layer to select

See also:
bExtend True adds objects to the current selec-
The Select, SelectAll, SelectExtend, SelectIDEx-
tion list
tend, and TextSelect commands
False deselects all objects first, then
The GetSelectIDList and GetSelectInfo queries selects layer

Layout view only. The SelectLayer command

works only in layout view.
Example. The following example selects the
objects on Layer 2.
s e l e c t l ayer " L ayer 2 " , Tr u e
 ADOBE PAGEMAKER 7.0 154
Commands

See Also: Multiple objects sent to back in same stacking

order. If you have multiple objects selected, the
The AssignLayer, DeleteLayer, DeleteUnusedLay-
ers, LayerOptions, LockLayers, MoveLayer, New- selected objects retain their stacking order in
Layer, PasteRemembers, ShowLayers, and relation to each other, but they are sent to the
TargetLayer commands bottom layer, behind everything else, and their
The GetLayerFromID, GetLayerList, GetLayerOp- drawing order changes accordingly.
tions, GetPasteRemembers, and GetTargetLayer Layout view only. The SendToBack command
queries works only in layout view.
Example. The following example selects the third
SendBackward object drawn and moves it behind all other objects
on the page.
Sends the selected object back one position,
decreasing its drawing order by one. Multiple select 3
objects retain their stacking order in relation to sendtoback
each other.
Drawing order. The first-drawn object on a page See also:
(or pages for facing pages) has drawing-order The BringToFront and Move commands
number 1 and is the bottom-most object. The top-
most object is drawn last and has the highest
drawing-order number. SendToPage nPageNumber[,
A group is considered an object and has a drawing-
sMasterName]
order number like any other object. If you send the Moves all selected objects to the specified page.
group backward, the objects within the group Text must be selected with the pointer tool.
retain their stacking order in relation to each other,
Parameter Values to enter
but their drawing-order numbers each decrease by
one. nPageNumber Number of the page to which the
selected objects are to be copied
Example. The following example selects the
lm or -3 for left master page
fourth object drawn and sends it backward,
rm or -4 for right master page
changing its drawing order to three.
next or -5 for next page
select 4
sendbackward prev or -6 for previous page

sMasterName Name of master to switch to if nPage is -3

or -4
See also:
The BringForward, BringToFront, Move, and Select text with pointer tool. Text that is selected
SendToBack commands with the text tool or the TextSelect command
cannot be sent to another page. The text block
must be selected with the pointer tool before using
SendToBack SendToPage.
Moves the selected text or graphic to the bottom
Multipage stories stay threaded. Stories that span
layer, behind other objects.
more than one page remain threaded to each other.
 ADOBE PAGEMAKER 7.0 155
Commands

Page position maintained. Unlike Cut and Paste, SeparateContent

which pastes the objects in the center of the
Separates content from a selected frame, without
window, SendToPage maintains the positions of
deleting the content.
objects on the page. Be aware that it does not adjust
the positions to accommodate double-sided pages Layout view only. The SeparateContent
with inside and outside margins that are not the command works only in layout view.
same.
Example. The following example leaves both the
Double-sided, facing pages. Either turn Facing frame and its content selected once they are
Pages off temporarily before you use SendToPage separated.
or send objects only from a right page to another
s e p a r a te con ten t
right page and from a left page to another left page.
PageMaker places objects according to their
original coordinates in a two page spread. Unless See Also:
you turn off Facing Pages, objects sent from the left The AttachContent, DeleteContent, BreakLinks,
page of a two-page spread are placed on the left FrameContentPos, FrameInset, LinkFrames, and
page of the receiving spread (or on the pasteboard ToggleFrame commands
if you try to send the left-page objects to page one). The GetFrameContentPos, GetFrameInset, GetFr-
Sending to master pages. If you set nPage-
ameContentType, GetIsFrame, and GetNext-
Frame queries
Number to the left or right master page (lm or -3,
rm or -4) but do not specify a master page, the
SendToPage command switches to the left or right
page of Document Master.
SetTextCursor nStoryID, nBegin[,
nEnd]
If the master page is a single-page master, you can Selects text from the specified location to the
set nPageNumber to either the left or right master ending location, turning the page as appropriate. If
(lm or -3, rm or -4). the ending location is the same as the beginning
Layout view only. Use the SendToPage command location, the cursor moves to that location without
only in layout view. selecting any text.
Example. The following example switches to the Parameter Values to enter
left page of the Document Master, selects every-
nStoryID Identifier for story (value ignored if in
thing on the page, and sends the selected objects to story editor)
page 5. It selects the object in the top-left corner
dontcare or -2 to select text in story cur-
and sends the object to the right page of the rently containing the insertion point
Document Master.
nBegin Starting location for text selection, in
page -3, "Document Master" characters from beginning of story (0
selectall sets insertion point prior to first charac-
ter in story)
sendtopage 5
select (column 1 left, co lumn top) nEnd Ending location of text selection, in char-
acters from beginning of story (if nBegin
sendtopage -4, "Document Master"
equals nEnd, the cursor remains in that
location)

See also:
The Cut and Paste commands
 ADOBE PAGEMAKER 7.0 156
Commands

Count of nonprinting characters. Include inline See also:

graphics and nonprinting characters (such as The NewStory, TextCursor, and TextEdit com-
index markers, tabs, and returns) in nBegin and mands
nEnd.
The GetTextLocation, GetTextRun, GetTextCur-
Getting the story ID . To get the identifier for the sor, and GetStoryIDList queries
story (as a value for nStoryID), use the
GetTextRun, GetTextCursor, or GetStoryIDList
queries. SetWidth dPercentage
Story editor . When in story editor, PageMaker Specifies the printed width of text characters. The
ignores nStoryID and selects text in the current extent of the action depends on which tool is
story, scrolling the screen as necessary. active, whether any text is selected, and whether a
publication is open when the command is
Unplaced text . When layout view is active, executed.
PageMaker displays an error message if the values
for nBegin or nEnd would position the insertion Parameter Values to enter
point in unplaced text i.e., (text in a story that has dPercentage Percentage to scale width of characters
not been placed on the page or pasteboard). (from 5.0 to 250.0; normal is 100.0)

Selection direction irrelevant. The SetText-

Display may vary from print. This command
Cursor command does not record the direction in
which you select text. The end of the selection is specifies the width of printed characters. The
always the last (right-most) character. For results seen on the screen and in the printed output
example, PageMaker selects the same characters depend on the kind of printer, the screen fonts, and
using either of the following lines: the type manager (if any) installed on the system
on which the plug-in or script is running.
settextcursor -2, 3, 7
tex t s e l e c t + ch a r
dPercentage truncated. If dPercentage includes
settextcursor -2, 7, 3
more than one decimal place, PageMaker truncates
tex t s e l e c t + ch a r
the value to tenths of a percent. For example,
Value out of range. If nEnd exceeds the number
10.199 becomes 10.1 percent.
of characters in the story, PageMaker selects text Example. The following example sets the printed
from nBegin to the end of the story. If nBegin width at 70% of normal.
exceeds the number of characters in the story,
setwidth 70
PageMaker selects text from the end of the story
back to nEnd. If both nEnd and nBegin are in
overset text, the command fails. See also:
Warning. Use the TextCursor command, not The GetWidth query
SetTextCursor, to move the cursor to the end of a
story. If the SetTextCursor parameters nBegin and
nEnd are both equal to the number of characters in
the story, PageMaker returns an error and removes
the insertion point from the story.
Example. The following example selects the
characters between the fifth and tenth characters in
the story with the PageMaker ID "3."
settextcursor 3, 5, 10
 ADOBE PAGEMAKER 7.0 157
Commands

ShowErrorAlert bState ers, LayerOptions, LockLayers, MoveLayer, New-

Layer, PasteRemembers, SelectLayer, and
Turns on or suppresses the display of error alerts
TargetLayer commands
normally suppressed when a plug-in or script is
The GetLayerFromID, GetLayerList, GetLayerOp-
running.
tions, GetPasteRemembers, and GetTargetLayer
Parameter Values to enter queries

bState off or 0 to suppress error alerts when a

plug-in or script is running (the Page-
Maker default state) ShowPages
on or 1 to display error alerts when a Briefly displays each page of the active publication,
plug-in or script is running starting at the first page and proceeding by page
spread.
Caution: Always turn off error alerts. If you
enable the display of error alerts, always turn them
off before your plug-in or script finishes. Click to stop display. Use this command to show
Otherwise, PageMaker could display them while all pages of a publication before printing it. Once
another plug-in or script is running. The ShowEr- started, the display will continue to cycle from the
rorAlert command has no menu equivalent; you first page; click repeatedly to stop it.
must turn off the error alerts using this command.
Last command in script. Always place this
Example. The following example enables the command as the last command in the script;
display of error alerts. otherwise the results are unpredictable. Although
shower ror aler t on
other commands don't stop ShowPages,
PageMaker can still receive and perform the
commands while cycling through the pages.
See also: Therefore, you cannot control where in the publi-
The GetShowErrorAlert query cation a particular command is executed once
ShowPages has begun.
Menu equivalent. The ShowPages command is
ShowLayers bShow equivalent to holding down the Shift key while
Performs either a Hide Others function, which selecting Go to Page from the Layout menu.
Hides all but the target layer, or a Show All
Layout view only. The ShowPages command
function.
works only in layout view.
Parameter Values to Enter
Example. The following example allows you to
bShow True makes all layers visible preview each whole page in the entire publication
False hides all layers except the target by turning off the palettes and showing the pages
layer of the publication (until you click to stop).
to o l b ox 0
Example. The following example makes all of the
color p a le t te 0
layers visible. s t y l e p a l e t te 0
showl ayers Tr u e con t ro l p a l e t te 0
show pages--Click to stop

See Also:
The AssignLayer, DeleteLayer, DeleteUnusedLay-
 ADOBE PAGEMAKER 7.0 158
Commands

Size dPointSize select 1

tex te d i t
Specifies the point size of text. The extent of the
tex t s e l e c t + wo rd
action depends on which tool is active, whether
sizebump upone
any text is selected, and whether a publication is
Assuming the currently selected text is 14 points,
open when the command is executed.
this example decreases its size to the next smaller
Parameter Values to enter standard size on the Size menu (12 points).
dPointSize Point size of the type (from 4.0 to 650.0) sizebump dow nnext

Value truncated. If dPointSize includes more than

See also:
one decimal place, PageMaker truncates the value
to tenths of a point. The Size and TextSelect commands
The GetSize query
Example. The following example specifies a type
size of 13.5 points.
size 13. 5 Skew cHandle, dAngle
Skews the selected object by the specified angle,
See also: using the designated handle as the fixed point.

The SizeBump command

The GetSize query

SizeBump cHowMuch
Changes the size of the text to a standard size.

Parameter Values to enter Parameter Values to enter

cHowMuch upone or 0 to bump the type up to the cHandle Handle to use as fixed point of skew:
next whole size
Top handles (each results in the same
downone or 1 to bump the type down to
skew):
the next whole size
top or 3
upnext or 2 to bump type up to the next
standard size on the Size submenu lefttop or topleft or 5

downnext or 3 to bump type down to righttop or topright or 7

the next standard size on the Size sub-
menu Middle handles (each results in the same
skew):

Layout view only. The SizeBump command center or 1

works only in layout view. left or 0

Examples . Assuming the currently selected text is right or 2

11.5 points, this example increases its size to the
next whole point size (12 points).
 ADOBE PAGEMAKER 7.0 159
Commands

cHandle for transformed objects. If the selected

Parameter Values to enter
object was previously skewed, rotated, or reflected,
Bottom handles (each results in the same cHandle corresponds to the handle position before
skew):
the object was transformed. For example, lefttop
bottom or 4 always refers to the original left-top handle of an
leftbottom or bottomleft or 6 object, not the handle that is currently the left-
rightbottom or bottomright or 8 most top handle.

dAngle Angle to skew object (from -85 to +85

degrees; up to 2 decimal places; positive
values are measured clockwise from y
axis)

Normal orientation. Zero degrees is the normal, Layout view only. The Skew command works
unskewed position of an object. only in layout view.

dAngle truncated. If dAngle includes more than Example. The following example selects the third
two decimal places, PageMaker truncates the value object drawn and skews it 25 degrees, centered
to hundredths of a degree. For example, 10.119 around the lower-left corner.
becomes 10.11 degrees. select 3

Skewing not cumulative. Skewing is not skew bottomleft, 25

cumulative. Always specify the degrees in relation

to the unskewed position of the object. For See also:
example, skewing a text block 30 degrees twice
The TextWrap command
results in a 30-degree skew, not a 60-degree skew.
The GetTransform query
Text objects, not individual characters. This
command skews whole text object, not individual
characters or groups of characters within a text SnapToGuides bState
object. You must select a text object with the Select Turns Snap to Guides on or off.
command or the pointer tool, not the TextSelect
command or text tool. Parameter Values to enter

Text automatically recomposed. When text is bState off or 0 (zero)

skewed, PageMaker recomposes the text to wrap on or 1
around any object that has text-wrap attributes (as
specified with the TextWrap command or Text Positioning graphics near guides. Consider
Wrap on the Element menu). turning off SnapToGuides when positioning text
or graphics near (but not on) a guide.
Aligning with rulers. To align text or graphics
precisely to ruler increments, use the
SnapToRulers command.
Example. The following example turns Snap to
Guides on.
snapto guides on
 ADOBE PAGEMAKER 7.0 160
Commands

See also: Parameter Values to enter

The SnapToRulers command
cLeading proportional or 0
The GetSnapToGuides query
topofcaps or 1

baseline or 2

SnapToRulers bState dAutoleading Percentage of font point-size to use for

automatic leading (from 0 to 200)
Turns Snap to Rulers on or off.

Parameter Values to enter Editing kern tables. Character pairs to be kerned

and kerning amounts are specified by the font
bState off or 0 (zero)
manufacturer. You activate pair kerning using
on or 1
SpaceOptions. To alter the kerning rules set in a
kern table by the font manufacturer, use a
Positioning graphics near ruler tick marks. commercially available kern-table editor.
Consider turning off SnapToRulers when
positioning text or graphics near (but not on) the dPtThreshold and dAutoleading truncated. If
ruler tick marks. dPtThreshold or dAutoleading include more than
one decimal place, PageMaker truncates the values
Aligning with guides. To align objects precisely to tenths of a point or percent. For example, 10.199
on guides, use the SnapToGuides command. points becomes 10.1 points.
Example. The following example turns Snap to Example. The following example turns pair
Rulers on. kerning on and specifies that any pairs in a point
snaptor ulers on size larger than 10 will be kerned. It sets propor-
tional leading and autoleading at 30% larger than
the font point-size.
See also:
space options t r ue, 10, propor tional, 130
The SnapToGuides command
The GetSnapToRulers query
See also:
The KernText, LetterSpace, ManualKerning,
SpaceOptions bAutoKerning, Track, and WordSpace commands
dPtThreshold, cLeading, dAutoleading The GetSpaceOptions query
Sets spacing attributes for text. The extent of the
action depends on which tool is active, whether
any text is selected, and whether a publication is
open when the command is executed.

Parameter Values to enter

bAutoKerning false or 0 (zero)

true or 1 to turn pair kerning on

dPtThreshold Point size of text above which Page-

Maker will automatically kern pairs of let-
ters
 ADOBE PAGEMAKER 7.0 161
Commands

Spell [cRange], [bWrapAround], Current publication only. Unlike the Spelling

[bAlternateSpell], [bShowDuplicate], dialog box, the Spell command cannot search
[bIgnore] multiple publications. It can search only the stories
in the currently active publication.
Checks for misspelled words in the selected range,
the active story, or all stories of the current bWrapAround. PageMaker disregards the bWrap-
publication. Selects the first unrecognized Around parameter in two cases, when
spelling it encounters. cSearchRange is set to either:

Parameter Values to enter • selectedtext (or 0), which confines search to the
selected text.
cRange selectedtext or 0 to spell-check only
selected text • allstories (or 2), which starts the search at the
currentstory or 1 to spell-check only the beginning of the active story and automatically
current story, starting from position of wraps to the beginning of the next story.
insertion point (default setting)
Optional parameters. PageMaker does not
allstories or 2 to spell-check all stories in require any of the Spell parameters. If you do not
current publication, starting from begin-
ning of currently active story include values for a parameter (e.g., spell or spell ,
, , false), PageMaker uses the setting from the last
default or -1 to use default or previously
defined range Spell command. (Or, if the command hasn't been
executed this session, PageMaker uses the default
dontcare or -2 to let system choose
range based on current text selection. If settings.
text is selected, Spell spell-checks only
Scripts palette. Do not use the Spell command in
selected text; if no text is selected, Spell
spell-checks only the current story, start- scripts you plan to run using the Scripts palette.
ing from position of insertion point. When PageMaker finds no match or completes the
bWrapAround stopatend or 0 to stop checking when search, the Scripts palette interprets this as an error
PageMaker reaches end of story and stops at that point in the script.
wrap or 1 to continue checking from Plug-ins and external scripts only. PageMaker
beginning of story when PageMaker
reaches end of story (default setting)
returns the following codes to indicate the success
of the search:
bAlternateSpell off or 0 (zero) not to display alternative
spellings in the Spelling dialog box Example. The following example begins spell-
on or 1 to display alternative spellings in
checking all the stories and selects the first unrec-
the Spelling dialog box ognized word.
bShowDupli- off or 0 (zero) not to highlight a duplicate s p e l l a l l s to r i e s
cate word

on or 1 to highlight a duplicate word

(default setting)
See also:
The AddWord, RemoveWord, and SpellWindow
bIgnore off or 0 (zero) to highlight each occur-
rence of an unrecognized word
commands
The GetPMInfo, GetSpellResult, and GetSpell-
on or 1 to highlight only first occurrence
of an unrecognized word and ignore all Window queries
other instances of it (default setting)

Story editor only. The Spell command works only

in story editor.
 ADOBE PAGEMAKER 7.0 162
Commands

SpellWindow bOpen Parameter Values to enter

Opens or closes the Spelling dialog box. bDisplayStyle false or 0 to hide the paragraph style
names in story editor
Parameter Values to enter
true or 1 to display the paragraph style
bOpen close or 0 to close Spelling dialog box names in the left margin of story editor
open or 1 to open Spelling dialog box dSize Point size of text displayed in story editor

sFont Name of the font (exactly as it appears

Story editor only. The SpellWindow command when you choose Font from the Type
works only in story editor. menu), in quotation marks (to a maxi-
mum of 31 characters)
Plug-ins and external scripts only. If story editor
is not active, PageMaker returns Specifying defaults. If a publication is open, the
CQ_LO_INVALID_MODE and disregards the new preference specifications apply only to that
command. publication. If no publication is open, the specifi-
Change and Find closed in Windows. Windows cations apply to any new publication that is
allows only one dialog box to be open at a time. created.
PageMaker for Windows closes either the Find or dSize truncated. If dSize includes more than one
Change dialog box before opening the Spelling decimal place, PageMaker truncates the value to
dialog box. Since the Macintosh allows more than tenths of a point. For example, 10.199 becomes
one open dialog box, PageMaker for the Macintosh 10.1 points.
can open the Spelling dialog box without closing
either the Find or Change dialog box. Example. The example specifies the following
story editor preferences:
Example. The following example opens the
Spelling dialog box. • Display all nonprinting characters.

s p e l lw i n d ow o p e n • Do not display style names.

• Display text in 14-point Geneva.
See also: stor ye ditpref t r ue, false, 14, "Gene va"

The AddWord, RemoveWord, and Spell com-

mands See also:
The GetPMInfo, GetSpellResult, and GetSpell- The MeasureUnits and Preferences commands
Window queries
The GetStoryEditPref query

StoryEditPref bDisplayPara,
bDisplayStyle, dSize, sFont
Establishes the story-editor display preferences.

Parameter Values to enter

bDisplayPara false or 0 to display only printable char-

acters in story editor

true or 1 to display all nonprinting char-

acters—such as paragraph marks,
spaces, and index-entry markers—in
story editor
 ADOBE PAGEMAKER 7.0 163
Commands

Style sStyle Use StyleEnd command to end definition. If you

do not complete a style definition with the
Sets the specified paragraph style. The extent of the
StyleEnd command (e.g., by omitting the StyleEnd
action depends on which tool is active, whether
command or by not completing the definition due
any text is selected, and whether a publication is
to an error), PageMaker remains in the style-
open when the command is executed.
definition state until you either send the StyleEnd
Parameter Values to enter command or:
sStyle Name of the style (exactly as it appears • Open a new or existing publication.
when you choose Style from the Type
menu), in quotation marks (to a maxi- • Close the publication or quit PageMaker.
mum of 31 characters)
• Revert to the last-saved version of the publi-
cation.
Example. This command applies the Headline
style to the first paragraph in the text block. • Paste information from the Clipboard.

select (column 1 left, co lumn top) • Import a file.

tex te d i t While in the style definition state, the Define Styles
s t y l e " He a d l i n e " command remains dimmed in the Type menu.
Until PageMaker receives the StyleEnd command,
all subsequent commands and queries relevant to
See also:
paragraph styles (such as type, paragraph, hyphen-
The BasedOn, NextStyle, StyleBegin, and StyleEnd ation, and color commands) apply to the style
commands
being defined.
The GetStyle query
Commands that comprise a style. The commands
that comprise a style definition are:
StyleBegin sStyle • AlignmentPosition
Marks the beginning of a style definition. Until • BasedOnRuleAbove
PageMaker receives a StyleEnd command, it uses
any type- and paragraph-related commands that • CaseRuleBelow
follow StyleBegin to define (or edit) the specified • ColorRuleOptions
style (rather than applying them directly to text).
• DictionarySetWidth
Parameter Values to enter • FontSize
sStyle Name of the style to define, in quotation • HyphenationSpaceOptions
marks (to a maximum of 31 characters)
• IndentsTabs
No nested definitions. The StyleEnd command • LeadingTint
completes the definition. Style definitions cannot
• LetterSpaceTrack
be nested; you must complete a style definition
with the StyleEnd command before beginning the • NextStyleTypeOptions
next style definition. • ParaOptionsTypeStyle
• ParaSpaceWordSpace
 ADOBE PAGEMAKER 7.0 164
Commands

Style based on current style. If you do not base While in the style-definition state, the Define
the style on a specific style (using the BasedOn Styles command remains dimmed in the Type
command), PageMaker bases the style on the menu. Until PageMaker receives the StyleEnd
current style. The current style is the style of the command, all subsequent commands and queries
text containing the insertion point, or, if either the relevant to paragraph styles (such as type,
pointer tool is active or no publications are open, paragraph, hyphenation, and color commands)
the default style. apply to the style being defined.
Example. The following example defines Heading Example. The following example defines Heading
1 as point-size 24 in the font Times. 1 as point-size 24 in the font Times.
s t y l e b e g i n " He a d i n g 1 " s t y l e b e g i n " He a d i n g 1 "
size 24 s i ze 2 4
font "Times" font "Times"
styleend styleend

See also: See also:

The Style and StyleEnd commands The Style and StyleBegin commands
The GetStyle and GetStyleNames queries The GetStyle and GetStyleNames queries

StyleEnd StylePalette bState

Marks the end of the current style definition. Turns the Styles palette off and on.
Apply style with Style command. The StyleEnd Parameter Values to enter
command is used with StyleBegin and is required
bState off or 0 (zero) to close the Styles palette
to complete a style definition. The newly defined
style is then available to be specified with the Style on or 1 to display the Styles palette

command.
Example. The following example displays the
Use StyleEnd command to end definition. If you
Styles palette.
do not complete a style definition with the
StyleEnd command (e.g., by omitting the StyleEnd s t yle p a le t te on
command or by not completing the definition due
to an error), PageMaker remains in the style See also:
definition state until you either send the StyleEnd
The GetStylePalette query
command or:
• Open a new or existing publication.
• Close the publication or quit PageMaker.
• Revert to the last-saved version of the publi-
cation.
• Paste information from the Clipboard.
• Import a file.
 ADOBE PAGEMAKER 7.0 165
Commands

SuppressAutosave [bSuppress] The PageMaker default. If you omit the

bSuppress parameter, SuppressAutosave turns off
Suppresses or activates the automatic mini-save
the automatic minisave feature. However, the
feature.
PageMaker default state is with the minisave
Parameter Values to enter feature turned on.
bSuppress off or 0 to activate automatic mini-save Caution: Always turn off SuppressAutosave at
feature end. Always turn off the SuppressAutosave
on or 1 to suppress automatic mini-save command before returning control back to
feature (command default setting) PageMaker. This command has no menu equiv-
alent, so the user would need to run a script to
When minisaves occur. When SuppressAutosave return PageMaker to its default state. The
is off (the PageMaker default state), PageMaker automatic minisave feature is a safeguard for users
performs a minisave if you: and allows them to recover work since the last save
or minisave.
• Paste.
Example. The following example suppresses
• Modify a setting in the Document Setup dialog
box and click OK. automatic minisaves.

• Insert or delete a page. suppressautosave on

• Move to another page or click current page icon.

See also:
• Autoflow text.
The MiniSave command
• Display the Indents/Tabs ruler.
The GetSuppressAutosave query
• Display the Define Styles dialog box or use the
StyleBegin/StyleEnd commands.
• Create a table of contents or index. SuppressPalDraw cPalette, bState
• Switch between views (story editor and layout).
Suppresses or enables updating the specified
palette if it is currently displayed.
• Close or switch from the Find, Change, or
Spelling dialog boxes back to a story that has Parameter Values to enter
changed since last save or minisave. (No minisave cPalette stylepalette or 1 for the Styles palette
occurs if the story has not been placed.)
colorpalette or 2 for the Colors palette
• Switch to another story in story editor that has controlpalette or 3 for the Control Pal-
changed since the last minisave. (No minisave ette
occurs if the story has not been placed.) masterpagepalette or 4 for Master
• Resize the story window of a story that has Pages palette

changed since the last minisave. (No minisave bState false or 0 to enable palette updating
occurs if the story has not been placed.) true or 1 to suppress updating the pal-
• Change all instances of a search item using either ette

the ChangeAll command or the Change All button

in the Change dialog box.
 ADOBE PAGEMAKER 7.0 166
Commands

Caution: Always re-enable palette updating. If Example. The following example suppresses the
you suppress palette updating, always re-enable it display of progress indicators.
before your plug-in or script finishes. The
suppresspi on
SuppressPalDraw command has no menu equiv-
alent; you must turn palette updating back on
using this command.
SuppressPrint obsolete command;
Flickering palette. If a palette is already set to be see NonPrinting
updated and you send the command to update it,
To match the command name on the menu, this
PageMaker redraws the palette, causing it to flicker.
command has been renamed as NonPrinting.
Example. The following example suspends the
updating of the Control Palette.
suppresspaldr aw cont rolpalette, t r ue
Tabs nCount[, cKind, xPosition,
sLeader]...
Specifies the number of tab stops and sets the kind,
See also:
the offset from the left side of the text block, and a
The ColorPalette, ControlPalette, MasterPagePal- leader characters (if any) for each. The extent of
ette, and StylePalette commands the action depends on which tool is active, whether
The GetSuppressPalDraw query any text is selected, and whether a publication is
open when the command is executed.

SuppressPI bState Parameter Values to enter

Suppresses or turns on the display of progress nCount Number of tab stops

indicators. 0 (zero) to clear user-defined tabs and
reset ruler to default setting of one tab
Parameter Values to enter every 0.5 inch or 3 picas (10mm in inter-
national versions)
bState off or 0 to display the progress indicators
For each tab stop (nCount not equal to zero):
on or 1 to suppress the progress indica-
tors cKind left or 0 (zero)

center or 1
Caution: Always re-enable progress indicators. If
right or 2
you suppress progress indicators, always re-enable
them before your plug-in or script finishes. The decimal or 3
SuppressPI command has no menu equivalent; xPosition Offset from left side of text block
you must turn the progress indicators back on
sLeader Leader characters, in quotation marks (to
using this command.
a maximum of 2 characters; any single
character is automatically doubled)

"" (empty quotation marks) for no leader

 ADOBE PAGEMAKER 7.0 167
Commands

Measurement units for scripts. If you do not Example. The following example creates three
specify a unit of measure for xPosition (e.g., i for tabs: the first, a center tab offset 0.25 inches from
inches), PageMaker uses the default unit of the text block; the second, a left tab offset 0.5
measure, specified in the Preferences dialog box or inches from the text block; and the third, a decimal
with the MeasureUnits command. tab with leader dots, offset 3.5 inches from the text
block.
Use quotation marks for no leader characters.
You can specify the absence of leader characters by tabs 3, (center, .25i, ""), (left, .5i, ""), (decimal,
entering double quotation marks with nothing 4i, "..")
between them ("") for the sLeader parameter.
Define tabs left to right. Specify the tab positions See also:
from left to right across the page. If the tab The GetTabs query
positions are out of order, PageMaker returns an
error.
Predefined tabs. The Indents/Tabs ruler has TargetLayer sLayerName
default tab settings every 0.5 inches or 3 picas Makes the layer in sLayerName the target layer.
(marked by small triangles—see dialog box). The
Parameter Values to Enter
tab positions you specify replace any predefined
settings between the left margin and those sLayerName Name of the layer to make the target
positions. layer

In international versions of PageMaker, the metric Example. The following example makes Circles
system is the default measurement system, and the the target layer.
default tab settings are every 10mm.
targetlayer "Circles"
User-defined tabs cleared. The Tabs command
removes any existing tabs before applying the new
ones. To clear all user-defined tabs and return the See Also:
ruler to the default setting of one tab every 0.5 The AssignLayer, DeleteLayer, DeleteUnusedLay-
inches or 3 picas (10mm in international versions), ers, LayerOptions, LockLayers, MoveLayer, New-
use zero for the nCount parameter: Layer, PasteRemembers, SelectLayer, and
ShowLayers commands
ta bs 0
The GetLayerFromID, GetLayerList, GetLayerOp-
tions, GetPasteRemembers, and GetTargetLayer
Story editor or no insertion point. If you use the
queries
Tabs command when story editor is active, if there
is no insertion point in a story, or if a tool other
than the text tool is active, then PageMaker sets the
default tab locations for the publication.
 ADOBE PAGEMAKER 7.0 168
Commands

TextCursor cHowMuch, nHowMany Text selected. If text is selected when you send
this command, PageMaker moves the insertion
Moves the insertion point (text cursor), by the
point from the ending point of the selection. The
specified range.
ending point can be either before the first character
Parameter Values to enter or after the last character of the selected range,
depending upon how the text was selected: by
cHowMuch +char or 0 (zero) for forward one charac-
ter dragging the insertion point, a Plug-in command
(SetTextCursor or TextSelect), or double- or triple-
-char or 1 for back one character
clicking the mouse.
+word or 2 for forward one word (or
punctuation mark), including trailing Out-of-range values. If cHowMuch or
space nHowMany exceed the limits of the story,
-word or 3 for back one word (or punctu- PageMaker moves the insertion point to the
ation mark) beginning or end of the story, according to the
+line or 4 for down one line (equivalent direction specified. For example, if you attempt to
to down arrow key) move the insertion point forward five paragraphs
-line or 5 for up one line (equivalent to (textcursor +para 5), but only three paragraphs
up arrow key) remain, PageMaker moves the insertion point to
+para or 6 for forward to beginning of the end of the story.
next paragraph
nHowMany ignored for textblocks. If cHowMuch
-para or 7 for back to beginning of para-
graph
is +textblock or -textblock (8 or 9), PageMaker
ignores the value of nHowMany and moves the
+textblock or 8 for forward to end of
text block
insertion point to the beginning or end of the
current text block.
-textblock or 9 for back to beginning of
text block Story editor: cHowMuch ignored if ±textblocks.
+story or 10 for forward to end of story While in story editor, if you set cHowMuch to
+textblock or -textblock (8 or 9), PageMaker does
-story or 11 for back to beginning of
story not move the insertion point. Text blocks have no
meaning in story editor.
+eol or 12 for forward to end of line

-eol or 13 for back to beginning of line Example. The following example moves the
insertion point (text cursor) forward by 50 words.
+sent or 14 for forward to end of sen-
tence (including trailing spaces) textcursor +word, 50
-sent or 15 for back to beginning of sen-
tence
See also:
nHowMany Number of times the value specified in
cHowMuch is to be repeated; the default The TextEnter and TextSelect commands
is 1 The GetTextCursor query

PageMaker won't turn page. In layout view,

PageMaker does not turn the page if you send the TextEdit
insertion point to a page not currently displayed. Positions the insertion point in front of the first
PageMaker beeps if you add or edit text on the character in the text block when the text block is
undisplayed page. selected with the pointer tool or with the Select
command.
 ADOBE PAGEMAKER 7.0 169
Commands

PageMaker left in layout view. Unlike EditStory, To include a quotation mark within the text you
this command leaves PageMaker in layout view. It want to enter, precede it with a single backslash (\).
is equivalent to selecting the text tool and clicking
To enter the automatic page number character
before the first character of the text block.
(Command + Option + p on the Macintosh or Ctrl
Creating a new story. To create a new story, use + Shift + 3 in Windows) use the special character
the NewStory command. ^(PgN). Otherwise, enter the hexadecimal
Layout view only. The TextEdit command works number 0x18, using the method required by the
only in layout view. scripting application or programming
environment in which you are writing your Plug-
Example. The following example selects a text in or script.
block and positions the insertion point in front of
the first character in the text block. Example . The following example enters a date
and a client's name and address at the insertion
select (column 1 left, co lumn top) point. Notice that to include a quotation mark
tex te d i t within a string you must precede it with a
backslash (Ian \"Big Guy\" Zander). The end of the
string is denoted by the double quotation mark
TextEnter sText after the zip code.
Enters text at the location of the insertion point select (column 1 left, co lumn top)
(text cursor). tex te d i t
Parameter Values to enter textenter "Januar y 1, 1992

sText Text to enter, in quotation marks; the

Ian \"Big Guy\" Zander
number of characters is limited only by
available memory C A In c .
1 0 2 7 - 1 9 7 3 B a s i q u e Ka t t D r ive
Placing and moving the insertion point. The Ha ppy, IL 12244"
insertion point must be within a text block to use
this command. Place the insertion point (text See also:
cursor) into a text block using the TextEdit
The NewStory, TextCursor, and TextEdit com-
command, and then move the insertion point to
mands
the desired location with the TextCursor
The GetTextCursor query
command.
Creating a new story. To create a new story, use
the NewStory command.
Entering special characters. Quotation marks,
both standard and curly (printer's) quotation
marks, the automatic page number marker and
other characters require special treatment in the
command language. See the Special characters
section under Using Functions for a full list.
 ADOBE PAGEMAKER 7.0 170
Commands

TextSelect cHowMuch, nHowMany Command works like PageMaker interface. The

TextSelect command works the same way as
Selects text from the position of the insertion point
selecting text using the mouse or the keyboard.
forward or back by the selected range. If text is
The insertion point serves as an anchor point for
currently selected, it extends the selection or
the selection. You can select forward or back from
deselects text, depending upon the direction
that point, but you cannot select text on one side of
specified.
the insertion point and extend that selection to the
Parameter Values to enter other side of the insertion point.
cHowMuch +char or 0 (zero) for forward one charac- Extending the selection. If text is already selected,
ter PageMaker extends the selection or deselects text
-char or 1 for back one character depending on both the direction of cHowMuch
+word or 2 for forward one word (or and the direction the insertion point was originally
punctuation mark), including trailing moved from the anchor point when the text was
spaces first selected.
-word or 3 for back one word (or punctu-
Out-of-range values. If cHowMuch or
ation mark)
nHowMany exceed the limits of the story,
+line or 4 for down one line (equivalent
to down arrow key)
PageMaker selects text to the beginning or end of
the story, according to the direction specified. For
-line or 5 for up one line (equivalent to
up arrow key)
example, if you attempt to select forward five
paragraphs (textselect +para 5), but only three
+para or 6 for forward to beginning of
next paragraph
paragraphs remain, PageMaker selects text to the
end of the story.
-para or 7 for back to beginning of para-
graph nHowMany ignored for textblocks. If cHowMuch
+textblock or 8 for end of text block is +textblock or -textblock (8 or 9), PageMaker
ignores the value of nHowMany and selects text
-textblock or 9 for back to beginning of
text block only to the beginning or end of the current text
block.
+story or 10 for forward to end of story

-story or 11 for back to beginning of Story editor: cHowMuch ignored if ±textblocks.

story If you set cHowMuch to +textblock or -textblock
+eol or 12 for forward to end of line (8 or 9) while in story editor, PageMaker does not
move the insertion point. Text blocks have no
-eol or 13 for back to beginning of line
meaning in story editor.
+sent or 14 for forward to end of sen-
tence (including trailing spaces) Example. The following example extends the
-sent or 15 for back to beginning of sen- selection forward to the end of the current line and
tence then to the end of the following three lines.
all or 18 to select entire story tex t s e l e c t + e o l , 3

nHowMany Number of times value specified in

cHowMuch is to be repeated; the default
is 1
See also:
The SetTextCursor command
The GetTextCursor and GetTextRun queries
 ADOBE PAGEMAKER 7.0 171
Commands

TextWrap cWrapOption, cTextFlow, Parameter Values to enter

xLeftSO, yTopSO, xRightSO, yBottomSO,
cLayerWrap 0 text wraps around object normally
cLayerWrap
1 only text on the same layer wraps
Specifies how the text will wrap, or flow, around an around the object
independent graphic. -1 text wraps around the object accord-
ing to the publication default
Parameter Values to enter
-2 the text wrap layer option does not
cWrapOption none or 0 (zero) to flow text over a change for this object
graphic

rect or 1 to create a rectangular graphic Measurement units for scripts. If you do not
boundary around which the text will flow specify a unit of measure for the stand-offs (e.g., i
irregular or 2 only if the boundary has for inches), PageMaker uses the default unit of
already been changed with the Text- measure, specified in the Preferences dialog box or
WrapPoly command
with the MeasureUnits command.
cTextFlow columnbreak or 0 (zero) to stop text
flow at a graphic and then continue the Place graphics after using TextWrap command.
text flow at the start of the next column To wrap text around all or most of the graphics in
jumpover or 1 to stop text flow above a publication in the same way, use the TextWrap
the graphic and then to continue below command before placing any graphics.
it, leaving white space on either side
Default when no publication is open. To set text-
allsides or 2 to flow text around the
graphic on all sides wrap defaults for all graphics you create or place in
future PageMaker publications, use the TextWrap
xLeftSO Left stand-off for graphics with a rectan- command when no publication is open.
gular text wrap, from -22.75 to 22.75
inches Wrap set on master pages applies throughout pub-
0 (zero) for either irregular or no text lication. Selecting a text-wrap style for a graphic
wrap on a master page causes text to wrap around that
yTopSO Top stand-off for rectangular text wrap, graphic on any page on which it appears.
from -22.75 to 22.75 inches
Layout view only. The TextWrap command works
0 (zero) for either irregular or no text only in layout view.
wrap
Example. The following example wraps text
xRightSO Right stand-off for rectangular text wrap,
from -22.75 to 22.75 inches
around the top and bottom sides of the selected
graphic, with an offset from the graphic of 0.2
0 (zero) for either irregular or no text
wrap
inches. Only text on the same layer will wrap
around the graphic.
yBottomSO Bottom stand-off for rectangular text
wrap, from -22.75 to 22.75 inches s e le c t ( gu i d e 3 , colu m n b ot tom )
textw r ap re ct, jumpover, (0, .2i, 0, .2I), 1
0 (zero) for either irregular or no text
wrap

See also:
The TextWrapPoly command
The GetTextWrap and GetTextWrapPoly queries
 ADOBE PAGEMAKER 7.0 172
Commands

TextWrapPoly nPoints (xLocation, Example. The following example selects a

yLocation)... graphic, specifies text-wrapping around the
outside of the object, and creates a triangular
Creates a custom, text-wrap polygon for the
polygon, starting at the first coordinate (03p, 03p)
selected graphic, based on specified points.
in the upper left handle of the graphic and moving
clockwise to the second coordinate (3p6, 2p) and
third coordinate (1p6, 5p6).
select 1
textw r a ppoly 3 (0p3, 0p3) (3p6, 2p) (1p6, 5p6)

Parameter Values to enter

See also:
nPoints Number of points in the polygon The Select and TextWrap commands
For each of the points in the polygon, specify a pair of coor- The GetTextWrap and GetTextWrapPoly queries
dinates (relative to the upper left handle of the graphic)

xLocation x coordinate of point

Tile
yLocation y coordinate of point
Tiles the displayed windows, whether these are
either publications in layout view or stories in
Measurement units for scripts. If you do not
story editor (from the current publication only).
specify a unit of measure for the coordinates (e.g.,
Tiling resizes and repositions the windows so that
i for inches), PageMaker uses the default unit of
they all fit on the screen.
measure, specified in the Preferences dialog box or
with the MeasureUnits command. Stories in current publication only. The Tile
command rearranges stories only within the
Important: xLocation and yLocation specifica-
current publication. Stories from other publica-
tions. Unlike most coordinates, which are relative
tions remain unchanged.
to the rulers' zero point, xLocation and yLocation
values are relative to the upper-left handle of the Example. The following example switches to the
graphic. story editor and tiles the displayed stories.
Wrapping around the object. To wrap the text editstor y
around the outside of the object, specify xLocation tile
and yLocation in clockwise order, starting with the
upper-left handle.
Wrapping inside the object. To wrap the text on
TintSelection nTintValue
the inside of the object, specify xLocation and Tints the selected text or graphics or, if nothing is
yLocation in counter-clockwise order, starting selected, sets the default tint for the next object
with the upper-left handle. drawn or placed.

Wrap specifications. Although you can create a Parameter Values to enter

text-wrap polygon with the columnbreak or
nTintValue Percentage of object's current color to
jumpover text flow settings, the text conforms to apply (from 0 to 100)
the specified shape only if it flows on all sides of the
object.
Layout view only. The TextWrapPoly command
works only in layout view.
 ADOBE PAGEMAKER 7.0 173
Commands

Example. The following example changes the tint Tool cTool

of the first object drawn on the page to 25% of its
Selects the designated tool in the Tool palette.
existing color.
Parameter Values to enter
select 1
tintselection 25 cTool pointer or 1 for pointer tool

textcursor or 2 for text tool

See also: oval or 3 for oval tool

The Color, ColorPalette, and DefineColor com- rectangle or 4 for rectangle tool
mands diagline or 5 for line tool
The GetColor, GetColorInfo, GetColorNames,
constrainedline or 6 for constrained line
GetColorPalette, and GetTint queries tool

polygon or 7 for polygon tool

ToggleFrame zoom or 8 for zoom tool

rotate or 9 for rotate tool

The selected object is converted from a frame to a
PageMaker box, oval, or polygon or from a box, crop or 10 for cropping tool
oval or polygon to a frame.
Layout view only. The Tool command works only
Layout view only. The ToggleFrame command
in layout view.
works only in layout view.
Example. The following example selects the oval
Example. The following example toggles the
tool in the Tool box.
selected objects between frames and graphics.
to ol ov a l
to g g l e f r a m e

See Also: See also:

The GetTool query
The AttachContent, BreakLinks, DeleteContent,
FrameContentPos, FrameInset, LinkFrames, Sep-
arateContent, and ToggleFrame commands
The GetFrameContentPos, GetFrameInset, GetFr-
Toolbox bState
ameContentType, GetIsFrame, and GetNext- Displays or closes the toolbox.
Frame queries
Parameter Values to enter

bState off or 0 (zero) to close the toolbox

on or 1 to display the toolbox

Layout view only. The Toolbox command works

only in layout view.
Example. The following example displays the
toolbox.
to olbox on
 ADOBE PAGEMAKER 7.0 174
Commands

See also: tions commands

The GetToolbox query The GetTrack query

Track cTrack TrapSettings bEnable, xDefWidth,

Adjusts the space between letters and words (track xBlackWidth, dStepLimit, dCentThresh,
kerning) of selected text or of the next text typed. dTextLimit, bTrapOverImp
The extent of the action depends on which tool is Sets the main settings that determine how
active, whether any text is selected, and whether PageMaker traps overlapping elements in a
a publication is open when the command is publication (found in the Trapping Options
executed. dialog box).

Parameter Values to enter Parameter Values to enter

cTrack notrack or 0 (zero) bEnable off or 0 (zero) to disable trapping

veryloose or 1 on or 1 to enable trapping

loose or 2 dontcare or -2 to leave enable state

unchanged
normaltrack or 3
xDefWidth Width of non-black traps
tight or 4
dontcare or -2 to leave width
verytight or 5
unchanged

PageMaker predefined tracking. For each font on xBlackWidth Width of black traps

the system, PageMaker applies predefined param- dontcare or -2 to leave black width
eters, or "tracks," to loosen or tighten the look of unchanged

the text. dStepLimit Percentage for step limit, from 1% (1.0) to

100% (100.0)
These adjustments are made in addition to the
dontcare or -2 to leave step limit
kerning specified as part of the font design. Track-
unchanged
kerning is a way to kern a range of selected text
uniformly. dCentThresh Percentage for centerline threshold, from
0% (0.0) to 100% (100.0)
In general, PageMaker applies more kerning to dontcare or -2 to leave centerline
large point sizes and less to small point sizes. threshold unchanged

When to use ManualKerning instead of the Track dTextLimit Point size above which text is trapped,
command. To adjust the spacing across a line of from 4.0 to 650.0
text (such as a heading), use the Track command. dontcare or -2 to leave text limit
Then use ManualKerning, if necessary, to adjust unchanged
the spacing between specific pairs of letters. bTrapOverImp off or 0 (zero) to disable trapping where
foreground objects overlap imported
Example. The following example kerns the
graphics
selected text tighter.
on or 1 to enable trapping over non-
t r a ck t i g ht PageMaker graphics (i.e., to trap to a
PageMaker object underneath an
imported image, not to the image itself )
See also: dontcare or -2 to leave state unchanged
The LetterSpace, ManualKerning, and SpaceOp-
 ADOBE PAGEMAKER 7.0 175
Commands

Measurement units for scripts. If you do not

Parameter Values to enter
specify a unit of measure for xDefWidth and
xBlackWidth (e.g., i for inches), PageMaker uses dSuperPos Superscript position, specified as a per-
centage of the type size, to shift up from
the default unit of measure, specified in the Prefer- the baseline (from 0% to 500%)
ences dialog box or with the MeasureUnits
dontcare or -2 to leave current value
command. unchanged
Example. The following example enables dSubPos Subscript position, specified as a per-
trapping of the publication and uses quarter-point centage of the selected type size, to shift
widths for non-black traps, half-point widths for below the baseline (from 0% to 500%)

black traps, a step limit of 20%, a centerline dontcare or -2 to leave current value
threshold of 70%, a text limit of 23.9 points, and unchanged

no trapping over imported graphics. dBaseline Amount to shift the baseline in points
(up to one decimal point; positive values
t r a p settin g s o n , 0p 0. 25 0p 0. 5 20. 0 7 0 . 0 2 3 . 9 of f only)

bDirection up or 0 to shift baseline up (the default)

See also:
down or 1 to shift baseline down
The BlackAttributes command
The GetTrapSettings and GetBlackAttributes que- Values truncated. If the percentages or point size
ries include more than one decimal place, PageMaker
truncates the values to tenths of a percent or point.
For example, 10.199 becomes 10.1 points.
TypeOptions dSmallSize, dScriptSize, Example. The following example selects an entire
dSuperPos, dSubPos, dBaseline, story and specifies:
bDirection
• A small-cap size of 80% of the selected type size
Specifies the sizes and positions of small caps,
superscript, and subscript text, as well as the • A superscript and subscript size of 70%
amount and direction of a baseline shift. The • Superscript and subscript positions of 33.3%
extent of the action depends on which tool is (one third) of the type size above and below the
active, whether any text is selected, and whether baseline, respectively
a publication is open when the command is
• A baseline shift of 0.5 points down
executed.
select (column 1 left, co lumn top)
Parameter Values to enter
tex te d i t
dSmallSize Small-caps size, specified as a percentage selectall
of the selected type size (from 1% to t y peoptions 80, 70, 33.3, 33.3, .5, dow n
200%)

dontcare or -2 to leave current value

unchanged See also:
dScriptSize Superscript or subscript size, specified as The Position command
a percentage of the selected type size The GetTypeOptions query
(from 1% to 200%)

dontcare or -2 to leave current value

unchanged
 ADOBE PAGEMAKER 7.0 176
Commands

TypeStyle cStyle See also:

Switches the specified type-style on or off. The The Color, TextEdit, and TextSelect commands
extent of the action depends on which tool is The GetTypeStyle query
active, whether any text is selected, and whether
a publication is open when the command is
executed. Ungroup
Parameter Values to enter Ungroups the currently selected groups, leaving
each individual item selected.
cStyle normal or 0 (zero) to remove all other
styles How ungrouping affects the drawing order. A
bold or 1 to apply or remove the bold group is considered an object and has a drawing-
style order number like any other object. When you
italic or 2 to apply or remove the italic ungroup, all objects retain their stacking order, but
style the drawing order numbers of the ungrouped
underline or 3 to apply or remove the objects, and any objects above them, drop by one.
underline style
Example. The following example selects all
outline or 4 to apply or remove the out- objects on the current pages and ungroups any
line style (Macintosh only)
grouped objects.
shadow or 5 to apply or remove the
shadow style (Macintosh only) selectall
u n g rou p
strikethru or 6 to apply or remove the
strikethru style

reverse or 7 to reverse the type to or See also:

from the color of the paper
The Group command
Command acts as toggle. The TypeStyle
The GetGroupList query
command acts as a toggle or switch. If bold is
already specified and you specify bold again, the
style will change to "not bold." Specifying normal,
Unlink
however, always sets the normal style. Removes links from the selected object.
Change text color with Color command. You can Unlinked files become pasted graphics. If you
change the color of text (including reversed type, unlink a Macintosh-edition file, it becomes the
which is the color of the paper and white by equivalent of a graphic that has been pasted from
default) with the Color command. the Clipboard.
Example. The following example selects a text Example. The following example selects the
block, positions the insertion point at the second object drawn and removes all links to it.
beginning of the text block, and selects to the end select 2
of the paragraph, changing the current style to (or u n li n k
from) bold and italic.
select (column 1 left, co lumn top)
See also:
tex te d i t
tex t s e l e c t + p a r a The LinkOptions and Relink commands
typestyle bold The GetLinkOptions query
typestyle italic
 ADOBE PAGEMAKER 7.0 177
Commands

Unmask The GetSelectIDList and GetSelectInfo queries

Unmasks the selected objects and any objects
masked by the selected objects. If a selected object
UnselectID nObjectID
is masked, its mask is removed. If a selected object
is a mask, all objects it masks (regardless whether Deselects a single object by its ID.
or not they are currently selected) are unmasked. Parameter Values to Enter

Objects that mask and are masked. If a selected nObjectID Unique ID of object to deselect
PageMaker-drawn box, oval, or polygon is both
masked by another object and used as a masking Layout view only. The Unselect command works
object, then the Unmask command has two effects: only in layout view.
it removes the mask from the selected object and
unmasks all objects masked by it.
See Also:
The DragSelectExtend, Select, SelectAll, SelectEx-
See also:
tend, SelectID, and SelectIDExtend commands
The Mask command The GetSelectIDList and GetSelectInfo queries
The GetGroupList, GetObjectIDList, GetObjec-
tIDListTop, GetSelectIDList, and GetSelectIDList-
Top queries View nPercentage, bAllPages
Sets the page view display.
Unselect nDrawOrderUnselect Parameter Values to enter
xLocation, yLocation
nPercentage Percentage of actual page size (any inte-
Deselects a single object either by drawing order or ger from 25 to 800)
by location. Other objects remain selected. fit or -3 for fit in window to display all
text, graphics, and guides on the page
Parameter Values to Enter
pasteboard or -4 to display all text
nDrawNumber The drawing-order number of the object blocks and graphics that have been
to deselect moved off the page

xLocation x coordinate of one of the handles of the bAllPages 0 change only the current page to the
object to deselect new view

yLocation y coordinate of one of the handles of the 1 change all pages to the new view
object to deselect
(bAllPages is only valid when nPercent-
age is specified as one of the preset view
Layout view only. The Unselect command works sizes.)
only in layout view.
For print size, specify 100. To display pages at the
Example. The following example deselects an
approximate size at which the publication is
object whose drawing-order number is 3.
printed, specify 100.
unselect 3
Layout view only. The View command works only
in layout view.
See Also:
Preset view sizes. Sizes 25, 50, 75, 100, 200, 400,
The DragSelectExtend, Select, SelectAll, SelectEx- fit, and pasteboard are preset sizes.
tend, SelectID, and SelectIDExtend commands
 ADOBE PAGEMAKER 7.0 178
Commands

Example. The following example displays only the WordSpace dWordMin, dWordDesired,
current page of the publication at approximately dWordMax
half its actual printed size.
Sets the acceptable range of space between words
v iew 50, 0 in justified text. The extent of the action depends
on which tool is active, whether any text is selected,
See also: and whether a publication is open when the
command is executed.
The GetView query
Parameter Values to enter

dWordMin Minimum space, as a percentage (from

Window sWindowName[, 0% to 500%)
sPublicationName] dontcare or -2 to leave current setting
Activates either the named publication (in layout unchanged
view) or the named story (in story editor). dWordDesired Desired space, as a percentage (from 0%
to 500%); the default is 100% of the
Parameter Values to enter space band of the associated font
sWindowName Name of story or publication, in quota- dontcare or -2 to leave current setting
tion marks, exactly as it appears on Win- unchanged
dows menu (for publications) or publica-
tion submenu (for stories) dWordMax Maximum space, as a percentage (from
0% to 500%)
sPublication- Name of publication that contains the
Name story specified in sWindowName, in quo- dontcare or -2 to leave current setting
tation marks and exactly as it appears on unchanged
Windows menu. Necessary only if the
name of the story matches the name of a
Spacing percentage relates to font. The
story in another open publication.
percentages specified for the parameter values are
relative to the size of the space character provided
Example. The following example displays a story
by the font manufacturer.
named "Requirements:1" in the publication named
"The Plan." Relationships of the three parameters. Make sure
that dWordMin is less than or equal to the
w indow "Requirements:1" "The Plan"
percentage set for dWordDesired, and that
dWordMax is greater than or equal to the
See also: percentage set for dWordDesired.
The GetPubWindows query Values truncated. If the percentages include more
than one decimal place, PageMaker truncates the
value to tenths of a percent. For example, 10.199
becomes 10.1%.
Example. The following example sets the
minimum spacing allowed between words at 75%
of the desired spacing (the space band for the
selected font), and sets the maximum spacing at
50% larger than the desired spacing.
word s p a ce 7 5 , 1 0 0 , 1 5 0
 ADOBE PAGEMAKER 7.0 179
Commands

See also: ZeroPoint x1, y1

The LetterSpace command Moves the zero point of the rulers to the
The GetWordSpace query specified x and y coordinates.

Parameter Values to enter

ZeroLock bState x1 x coordinate where the zero point is to be

located, relative to the current zero point
Locks the zero point where the rulers are location
located.
y1 y coordinate where the zero point is to be
Parameter Values to enter located, relative to the current zero point
location
bState off or 0 (zero) to unlock the zero point

on or 1 to lock the zero point Measurement units for scripts. If you do not
specify a unit of measure (e.g., i for inches),
Automatic zero-point position. When you create PageMaker uses the default unit of measure,
a new publication, PageMaker automatically specified in the Preferences dialog box or with
locates the rulers' zero point at either the top-left the MeasureUnits command.
corner of the page or, for facing pages, the middle
Know the zero-point location. All coordinates
of the top edge of the paper where pages intersect.
(except those set by the TextWrapPoly
command) are relative to the rulers' zero point.
It is important to know where the zero point is
before using commands that use x and y
coordinate parameters.
ZeroLock must be off. The ZeroPoint command
Many graphic designers prefer to reposition the returns an error when the zero point is locked.
rulers' zero point at the intersection of the top and To turn the lock off, use the ZeroLock
left margins for measuring within the image area command.
of each page. Layout view only. The ZeroPoint command
Example. This command locks the zero point works only in layout view.
where the rulers are currently located. Example. The following example moves the
zerolock on zero point one inch below the vertical axis.
zerop oi n t 0 i , 1 i
See also:
The ZeroPoint and ZeroPointReset commands See also:
The GetZeroLock query The ZeroLock and ZeroPointReset commands
The GetZeroPoint query

ZeroPointReset
Resets the rulers' zero point to the default
position.
 ADOBE PAGEMAKER 7.0 180
Commands

Default ZeroPoint location. When you create a Example. The following example resets the
new publication, PageMaker automatically puts rulers' zero point at the default position, which
the rulers' zero point at the top-left corner of the depends on whether the pages are specified as
page; or, for facing pages, at the middle of the facing pages or single pages.
top edge of the paper where pages intersect.
zerop o i n t re s e t

See also:
The ZeroLock and ZeroPoint commands
The GetZeroPoint query

ZeroLock must be off. The ZeroPointReset

command returns an error when the zero point
is locked. To turn it off, use the ZeroLock
command.
Layout view only. The ZeroPointReset
command works only in layout view.
 181

Queries

GetAdditions Gets the number of plug-ins GetAutoflow

listed on the Plug-ins submenu and, for each, lists Gets the current setting (on or off) of the Autoflow
its filename and menu name. command.
Reply: nNumOfPlugIns[, sFilename, Reply: bState
sPlugInName]...

See also:
See also:
The Autoflow command
The Addition command

GetBasedOn
GetAdditionsDir
Gets the name of the style on which the current
Gets the path to the PlugIns folder. style is based.
Reply: sPath, sNetPath Reply: sBasedOn
Full path returned. This query returns the full Defining or editing a style. If you are defining or
path name (e.g., C:\ALDUS\USENGLSH\ editing a style using the StyleBegin command,
ADDITION). PageMaker gets the style on which that style is
based rather than the Based On style for the
selected text.
GetAlignment
Empty string. PageMaker returns an empty string
Gets the Alignment setting that is assigned to the
for sBasedOn if:
selected text or to the paragraph containing the
insertion point. • The style is not based on another style (Based On
is set to No Style).
Reply: cType
• Multiple paragraphs are selected and they have
Defining or editing a style. If you are defining or
different styles assigned to them.
editing a style using the StyleBegin command,
PageMaker gets the alignment setting for that style
rather than for the selected text. See also:
The GetNextStyle, GetStyle, and GetStyleNames
Multiple alignment types. If you select more than
queries
one paragraph and they have different alignments
assigned to them, PageMaker returns -2 for cType. The BasedOn command

Pointer tool is active. If the pointer tool is active,

PageMaker gets the default alignment-setting. GetBlackAttributes
Gets the values that control the trapping and
See also: automatic overprinting of black objects (from the
The Alignment command Trapping Preferences dialog box).
 ADOBE PAGEMAKER 7.0 182
Queries

Reply: dBlackLimit, bOverprintTxt, dOvrprn- No text selected. If the text contains the insertion
tTxtSz, bOvrprntLines, bOvrprntFills point but no text is selected, PageMaker returns the
case setting of the character preceding the
What is black? A Color with any black value
insertion point. If the insertion point is before the
greater than or equal to the black limit and with no
first character of the story, PageMaker returns the
cyan, magenta, or yellow, is considered black for
case setting of the first character.
the purposes of trapping and auto-overprinting.

See also:
See also:
The GetTypeOptions query
The TrapSettings and BlackAttributes commands
The Case command
The GetTrapSettings query

GetBook GetChangeParaAttr
Gets paragraph attributes (paragraph style,
Gets the Auto Renumbering setting, the number of
alignment, and leading method) to be used for the
publications in the book list, and the name
search text in the Change and ChangeAll
(complete path) of each publication listed.
commands.
Reply: cAutoRenum, nNumOfPubs[,
Reply: sParaStyle, cAlignment, cLeadingType
fPubName]...
Story editor only. The GetChangeParaAttr query
works only in story editor.
See also:
The Book command Example. The following example changes all left-
aligned text in the current publication to justified
text. (Notice that it sets all other Find and Change
GetCase attributes to Any.) It then queries for the Find and
Change paragraph attributes.
Gets the Case setting (Normal, All Caps, or Small
Caps) assigned to the selected text. findpar aatt r "Any", left, -3
changepar aatt r "Any", justify, -3
Reply: cCase
fi n d t y p e a t t r 1 " Any" , - 3 , - 3 , - 3 , - 3 , - 3
Defining or editing a style. If you are defining or ch a n g e t y p e a t t r 1 " Any " , - 3 , - 3 , - 3 , - 3 , - 3
editing a style using the StyleBegin command, fi n d t y p e a t t r 2 - 3 , - 3 , " Any" , - 3
PageMaker gets the case for that style rather than ch a n g e t y p e a t t r 2 - 3 , - 3 , " Any " , - 3
for the selected text. ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s ,
useatt r i butes
Multiple settings. If PageMaker finds more than
getfindpar aatt r--Reply : "Any", 0, -3
one case setting in the selected text, PageMaker
getchangepar aatt r--Reply : "Any", 3, -3
returns -2 for cCase.
No insertion point. If the text does not contain the
insertion point, PageMaker gets the default case See also:
setting. The GetChangeTypeAttr1, GetChangeTypeAttr2,
GetChangeWindow, GetFindParaAttr,
GetFindTypeAttr1, GetFindTypeAttr2, and Get-
FindWindow queries
The Change, ChangeAll, ChangeNext,
ChangeParaAttr, ChangeTypeAttr1,
 ADOBE PAGEMAKER 7.0 183
Queries

ChangeTypeAttr2, ChangeWindow, Find, FindN- Example. The following example changes all 10-
ext, FindParaAttr, FindTypeAttr1, FindTypeAttr2, point, bold, underlined text in the current publi-
and FindWindow commands cation to 9-point, Helvetica bold. (Notice that it
sets all other Find and Change attributes to Any.) It
then queries for the Find and Change type
GetChangeTypeAttr1 attributes.
Gets the text attributes (font, point size, type style, fi n d t y p e a t t r 1 " Any" , 1 0 , - 3 ,
position, and case) to be used for the search text in boldstyle+underline, -3, -3
the Change and ChangeAll commands. ch a n g e t y p e a t t r 1 " He lve t i c a " , 9 , - 3 , b o l d s t y l e , - 3 ,
Reply: sFontName, dPointSize, dLeading, -3
cTypeStyle, cPosition, cCase fi n d p a r a a t t r " Any" , - 3 , - 3
changepar aatt r "Any", -3, -3
Story editor only. The GetChangeTypeAttr1
fi n d t y p e a t t r 2 - 3 , - 3 , " Any" , - 3
query works only in story editor. ch a n g e t y p e a t t r 2 - 3 , - 3 , " Any " , - 3
Type styles are additive. If the cTypeStyle ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s ,
parameter is set to multiple type styles, the return useatt r i butes
value is the sum of the numeric equivalents for the getfindt y p eatt r1--Reply : "Any", 10, -3, 5, -3, -3
styles. For example, if the type style is set to both g e tch a n g e t y p e a t t r 1 - - Re p l y : " He lve t i c a " , 9 , - 3 , 1 ,
bold (1) and underline (4), PageMaker returns 5 -3, -3
(the sum of 1 and 4).
Any for cTypeStyle, cPosition, and cCase. Unlike See also:
the Type Styles pop-up menu in the Change The GetChangeParaAttr, GetChangeTypeAttr2,
Attributes dialog box, the -3 setting for cTypeStyle GetChangeWindow, GetFindParaAttr,
pertains only to the type styles Bold, Italic, GetFindTypeAttr1, GetFindTypeAttr2, GetFind-
Underline, Strikethru, Outline, Shadow, and Window, and GetTypeStyle queries
Reverse. The value of cTypeStyle does not affect The Change, ChangeAll, ChangeNext,
the cPosition and cCase parameters, which are ChangeParaAttr, ChangeTypeAttr1,
turned off and on separately. ChangeTypeAttr2, ChangeWindow, Find, FindN-
ext, FindParaAttr, FindTypeAttr1, FindTypeAttr2,
GetTypeStyle values doubled. If you are using the
and FindWindow commands
GetTypeStyle query in conjunction with
ChangeTypeAttr1, FindTypeAttr1,
GetChangeTypeAttr1, or GetFindTypeAttr1, note GetChangeTypeAttr2
that the GetTypeStyle query returns different
values for the type styles. With the exception of Gets additional text attributes (set width, tracking,
normal, all the GetTypeStyle values are twice the color, and tint) to be used for the search text in the
values used in the find and change commands and Change and ChangeAll commands.
queries. For example, bold is 2 for GetTypeStyle Reply: dSetWidth, cTrack, sColorName,
and 1 for ChangeTypeAttr1, FindTypeAttr1, nTintValue
GetChangeTypeAttr1, and GetFindTypeAttr1.
Story editor only. The GetChangeTypeAttr2
Normal, however, is 1 in GetTypeStyle and 0 in the
query works only in story editor.
other commands and queries.
 ADOBE PAGEMAKER 7.0 184
Queries

Example. The following example changes all GetFindTypeAttr1, GetFindTypeAttr2, and Get-
purple text in the current publication to a 93% tint FindWindow queries
of purple. (Notice that it sets all other Find and The Change, ChangeAll, ChangeNext,
Change attributes to Any.) It then queries for the ChangeParaAttr, ChangeTypeAttr1,
Find and Change type settings. ChangeTypeAttr2, Find, FindNext, FindParaAttr,
FindTypeAttr1, FindTypeAttr2, and FindWindow
fi n d p a r a a tt r "Any ", - 3, - 3
commands
changepar aatt r "Any", -3, -3
fi n d t y p ea tt r1 "Any ", - 3, - 3, - 3, - 3 , - 3
ch a n g e t y p e a t t r 1 " Any " , - 3 , - 3 , - 3 , - 3 , - 3
GetCMSOn bState
fi n d t y p ea tt r2 - 3, - 3, "Pu r p l e", - 3
Determines whether or not the Color
ch a n g e t y p e a t t r 2 - 3 , - 3 , " Pu r p l e " , 9 3
Management System is turned on.
ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s ,
useatt r i butes Parameter Reply Values
getfindt y p eatt r2--Reply : -3, -3, "Pur ple", -3
bState True if Color Management is enabled
getchanget y p eatt r2--Reply : -3, -3, "Pur ple", 93
False if Color Management is disabled

See also:
The GetChangeParaAttr, GetChangeTypeAttr1, See also:
GetChangeWindow, GetFindParaAttr, The PrintDeviceIndpntColor command
GetFindTypeAttr1, GetFindTypeAttr2, and Get-
FindWindow queries
The Change, ChangeAll, ChangeNext, GetColor
ChangeParaAttr, ChangeTypeAttr1,
Gets the name of the color applied to the selected
ChangeTypeAttr2, ChangeWindow, Find, FindN-
ext, FindParaAttr, FindTypeAttr1, FindTypeAttr2, object or text.
and FindWindow commands Reply: sColorName, nTintValue

Defining or editing a style. If you are defining or

GetChangeWindow editing a style using the StyleBegin command,
PageMaker gets the color assigned to that style,
Gets the display status (open or closed) of the even when text or an object is selected.
Change dialog box.
Multiple selections. If more than one object or
Reply: bOpen character is selected and they have different colors
Story editor only. The GetChangeWindow query applied to them, PageMaker returns an empty
works only in story editor. string for sColorName and -2 for nTintValue.

Example. The following example opens the Insertion point. If the text contains the insertion
Change dialog box and then queries for its status. point but no text is selected, PageMaker returns the
color of the character preceding the insertion
changew indow open
point. If the insertion point is before the first
getchangew indow
character of the story, PageMaker returns the color
- - ex p e c te d rep l y : 1
of the first character.
Nothing selected. If no objects or text are selected
See also:
or no publication is open, PageMaker returns the
The GetChangeParaAttr, GetChangeTypeAttr1, default color.
GetChangeTypeAttr2, GetFindParaAttr,
 ADOBE PAGEMAKER 7.0 185
Queries

Fill color of boxes and ovals. PageMaker returns d e fi n e color " Pe a ch " , p ro ce s s , c myk , 0 , 1 5 , 3 0 , 1 0 ,0
the color of the fill (not the line) of a box or oval getcolor info 0 "Peach "
drawn in PageMaker. To get the color of the line, - - ex p e c te d rep l y :
use the GetFillAndLine query. 85.00,65.00,75.00,0.00,1,0,0,"",4,1,1,"",0

See also: See also:

The GetColorInfo, GetColorNames, GetColorPal- The GetColor, GetColorNames, GetColorPalette,
ette, and GetTint queries and GetTint queries
The Color and TintSelection commands The DefineColor command

GetColorInfo cModel, sColorName GetColorNames

Gets the color information for the specified color, Gets the names of all the colors defined in the
using the designated color model and library. publication.
Parameter Values Reply: nNumOfColors(, sColorname)...

cModel 0 (zero) for RGB color model, expressed

in percentages See also:
1 for process color (CMYK) model The GetColor, GetColorInfo, GetColorPalette,
2 for HLS color model and GetTint queries
4 for multi-ink model

5 for RGB color model, expressed in units

from 0 to 255
GetColorPalette
Gets the display state (on or off) of the Colors
sColorName Name of the color, in quotation marks
and exactly as it appears on the Colors palette.
palette
Reply: bState

Reply: nPercent1, nPercent2, nPercent3,

nPercent4, cType, nEPS, bOverprint, sBaseColor, See also:
cDefinedModel[, nInks, (sInkName, dInkLevel)...] The GetColor, GetColorInfo, GetColorNames,
and GetTint queries
Reference to color library is lost for color-picker
defined colors. No association with the original The ColorPalette command
color library is maintained if the color was origi-
nally defined with a color picker. Only the CMYK
values remain. GetColumnGuides
cModel ignored for tints. PageMaker ignores the
Gets the number of columns on the current page
cModel parameter if sColorName is a tint. (or pages for facing pages) and the position of the
left and right column-guides for each column.
Example. This example defines the color Peach
Reply: nColumns[, xLeftPosition, xRightPo-
using the CMYK model. It then requests the
definition of Peach using the RGB model. Notice sition]...
that while a color can be defined using one model,
you can request the color definition using a
different model.
 ADOBE PAGEMAKER 7.0 186
Queries

Measurement units for scripts. PageMaker Specifying units for sMeasurement. You can
returns coordinates using the publication default specify the measurement units of sMeasurement
units, specified in the Preferences dialog box or either with the cMeasureUnits parameter or by
with the MeasureUnits command. including a unit abbreviation with the value, as
shown below:
See also: Units Abbreviation Example
The ColumnGuides command Inches i 5.625i

Millimeters m 25m

GetControlPalette Picas p after 8p

Gets the display state (on or off) of the Control Points p before p6
palette.
Picas and points p between 18p6
Reply: bState
Ciceros c after number 5c

See also: Note: Do not insert a space between the

The ControlPalette command measurement and the abbreviation.

See also:
GetConvertStr sMeasurement[,
cMeasureUnits] The GetConvertTwips query

Converts the specified measurement to twips (the

PageMaker internal measurement system).
GetConvertTwips dTwips,
Parameter Values to enter cMeasureUnits
sMeasurement Measurement to convert, in quotation Converts the specified measurement from twips
marks, with or without unit abbreviation (the PageMaker internal measurement system)
to the specified units.
cMeasureUnits Measurement units of the value if the
units are not specified in sMeasurement.
Parameter Values to enter
Options are:

inches or 0 (zero) dTwips Measurement in twips to be converted

inchesdecimal or 1 cMeasureUnits Measurement units to convert the mea-

surement to:
millimeters or 2
inches or 0 (zero)
picas or 3 for picas and points
inchesdecimal or 1
ciceros or 4
millimeters or 2
dontcare or -2 to use the default mea-
surement system picas or 3 for picas and points

ciceros or 4
Reply: dTwips
dontcare or -2 to use the default mea-
surement system

Reply: sMeasurement
 ADOBE PAGEMAKER 7.0 187
Queries

Unit specified in return value. When you specify GetDefaultDir

measurement units, PageMaker includes the
Gets the name and path of the current default
unit abbreviation with the value. These abbrevi-
folder.
ations are:
Reply: sPath
Units Abbreviation Example
Default folder reset. PageMaker automatically
Inches i 5.625i
resets the default folder to the folder last-
Millimeters m 25m accessed whenever you open, place, export, or
Picas p after 18p
save with either File > Save As or the SaveAs
command.
Points p before p6
Examples. The following Macintosh example
Picas and points p between 18p6
saves the current publication to a new name,
Ciceros c after number 5c setting the default path to the disk MyDisk and
the Pubs folder. It then queries for the default
If you set cMeasureUnits to dontcare or -2, folder.
PageMaker uses the default measurement s ave a s " MyD i s k : Pu b s : Ne w Na m e " , 0 , n on e , 1
system and does not include the units abbrevi- g e tde f a u l td i r - - ex p e c te d rep l y : " My D i s k : Pu b s : "
ation with the return value. The following Windows example saves the
current publication to a new name, setting the
See also: default path to the subfolder Pubs within the
MyDir folder. It queries for the default folder. It
The GetConvertStr query
then saves the publication to the root on drive C
and queries for the new default folder.
GetCropRect saveas "c:\MyDir\Pubs\newname.pm6", 0, none, 1

Gets the coordinates of the crop rectangle for g e tde f a u l td i r - - ex p e c te d rep l y

the selected imported image. (Select only one "c:\mydir\mysubdir"

image at a time.) saveas "c:\new name.pm6", 0, none, 1

g e tde f a u l td i r - - ex p e c te d rep l y " c : \ "
Reply: xLeft, yTop, xRight, yBottom

Device coordinates. PageMaker uses the device

See also:
coordinates specified in the image.
The DefaultDir command
Single object only. If multiple objects are
selected, PageMaker returns an error.
Imported images only. Use this query for GetDefaultPrintClrSpace
imported images only. If you select an image sColorSpace
drawn in PageMaker and then use this query, Returns the default color space for the publi-
PageMaker returns an error. cation's target printer.

Parameter Reply Values

See also:
sColorSpace Color space for the print job, one of the
The Crop command following values:

"Gray", "CMYK", "RGB", or "CMY"

 ADOBE PAGEMAKER 7.0 188
Queries

See also: GetDisplaySpecial

The DefaultPrintClrSpace, PrintDoc, and Print- Gets the display status of the Display ¶ option for
Colors commands the story active in the story editor. Display ¶
The GetPrintDoc, GetPrintColor, and GetPrint- displays or hides special characters (spaces, tab
Caps query characters, hard returns, and soft returns).
Reply: bDisplay
GetDictionary Story editor only. The GetDisplaySpecial query
Gets the language for hyphenation and spelling works only in story editor and gets the status of
assigned to the selected text or to the paragraph only the active story.
containing the insertion point. Example. The following example switches to story
Reply: sLanguage editor and queries for the display status of special
characters.
Defining or editing a style. If you are defining or
editing a style using the StyleBegin command, editstor y
PageMaker gets the dictionary assigned to that ge td i s p lays p e c i a l on
style rather than the dictionary assigned to the
selected text. See also:
Empty string. If multiple paragraphs are selected The GetDisplayStyleNames query
and they have different languages assigned to The DisplaySpecial command
them, PageMaker returns an empty string for
sLanguage.
Pointer tool active. If the pointer tool is active, GetDisplayStyleNames
PageMaker gets the default language. Gets the display status of the Display Style Names
option for the story active in the story editor.
See also: (Display Style Names displays or hides paragraph
style names in a sidebar in the left margin of a
The GetPMInfo and GetPMLanguage queries.
story.)
The Dictionary command
Reply: bDisplay

Story editor only. The GetDisplayStyleNames

GetDisplayNonPrinting query works only in story editor and gets the status
Gets the current state (on or off) of the Display of only the active story.
Non-Printing command. Example. The following example switches to story
Reply: bState editor and queries for the display status of style
names in the active story.

See also: editstor y

getdisplayst y lenames
The GetNonPrinting query
The NonPrinting and DisplayNonPrinting com-
mands See also:
The GetDisplaySpecial query
The DisplayStyleNames command
 ADOBE PAGEMAKER 7.0 189
Queries

GetExportFilters GetFillStyle
Gets the number of installed export filters and the Gets the fill style applied to the currently selected
name and version number of each. object.
Reply: nNumOfFilters[, sFilterName, sVersion]... Reply: cFillStyle

Default settings. If the text tool or story editor is

See also: active, or if no PageMaker drawn objects are
The GetImportFilters query selected, PageMaker gets the publication default
fill style.
Multiple fill styles. If multiple objects are selected
GetFillAndLine and have different fill styles, PageMaker returns -2
Gets the style and color of the fill and stroke for the for cFillStyle.
selected objects (drawn in PageMaker). Tinted or shaded objects. In PageMaker, you get
Reply: cFillStyle, sFillColor, bFillOverprint, the tint of an object's fill using the GetFil-
cLineStyle, bReverse, dWeight, bOpaque, sLine- lAndLine query. If an object has a shaded fill
Color, bLineOverprint, nFillTint, nLineTint from PageMaker 5.0, GetFillStyle returns 2
(solid) for cFillStyle. Use GetFillAndLine to
PageMaker objects only. The GetFillAndLine
obtain the percentage of the shade (from 10% to
query returns fill and line information about
80%).
objects drawn in PageMaker, not imported objects.
Multiple settings. If multiple objects are selected
See also:
and they have different fills or line styles assigned
to them, PageMaker returns -2 for cFillStyle or The GetFillAndLine and GetLineStyle queries
cLineStyle, respectively. The FillAndLine, FillStyle, and LineStyle com-
mands
Default settings. If the text tool or story editor is
active or if no PageMaker drawn objects are
selected, PageMaker gets the publication default GetFindParaAttr
fill and line styles.
Gets paragraph attributes (paragraph style,
Tinted and shaded objects. The nFillTint alignment, and leading method) to be used for the
parameter replaces the shade fill styles from search text in the Find, Change, and ChangeAll
PageMaker 5.0, which set solid fills from 10% to commands.
80% of the object's color (using cFillStyle values 3
Reply: sParaStyle, cAlignment, cLeadingType
to 8). If an object's fill has been tinted using a
PageMaker 5.0 shaded fill, GetFillAndLine returns Story editor only. The GetFindParaAttr query
2 (solid) for cFillStyle and the percentage of color works only in story editor.
for nFillTint.
Example. The following example changes all left-
aligned text in the current publication to justified
See also: text. (Notice that it sets all other Find and Change
The GetFillStyle and GetLineStyle queries attributes to Any.) It then queries for the Find and
The FillAndLine, FillStyle, and LineStyle com- Change paragraph settings.
mands findpar aatt r "Any", left, -3
changepar aatt r "Any", justify, -3
fi n d t y p e a t t r 1 " Any" , - 3 , - 3 , - 3 , - 3 , - 3
 ADOBE PAGEMAKER 7.0 190
Queries

ch a n g e t y p e a t t r 1 " Any " , - 3 , - 3 , - 3 , - 3 , - 3 GetTypeStyle values doubled. If you are using the
fi n d t y p ea tt r2 - 3, - 3, "Any ", - 3 GetTypeStyle query in conjunction with
ch a n g e t y p e a t t r 2 - 3 , - 3 , " Any " , - 3 ChangeTypeAttr1, FindTypeAttr1,
ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s , GetChangeTypeAttr1, or GetFindTypeAttr1, note
useatt r i butes that the GetTypeStyle query returns different
getfindpar aatt r--Reply : "Any", 0, -3 values for the type styles. With the exception of
getchangepar aatt r--Reply : "Any", 3, -3 normal, all the GetTypeStyle values are twice the
values used in the find and change commands and
queries. For example, bold is 2 for GetTypeStyle
See also:
and 1 for ChangeTypeAttr1, FindTypeAttr1,
The GetChangeParaAttr, GetChangeTypeAttr1, GetChangeTypeAttr1, and GetFindTypeAttr1.
GetChangeTypeAttr2, GetChangeWindow, Normal, however, is 1 in GetTypeStyle and 0 in the
GetFindTypeAttr1, GetFindTypeAttr2, and Get-
other commands and queries.
FindWindow queries
The Change, ChangeAll, ChangeNext, Example. The following example changes all 10-
ChangeParaAttr, ChangeTypeAttr1, point, bold, underlined text in the current publi-
ChangeTypeAttr2, ChangeWindow, Find, FindN- cation to 9-point, Helvetica bold. (Notice that it
ext, FindParaAttr, FindTypeAttr1, FindTypeAttr2, sets all other Find and Change attributes to Any.) It
and FindWindow commands then queries for the Find and Change type
attributes.
fi n d t y p e a t t r 1 " Any" , 1 0 , - 3 ,
GetFindTypeAttr1
boldstyle+underline, -3, -3
Gets the text attributes (font, point size, type style, changetypeattr1 "Helvetica", 9, -3, boldstyle, -3, -3
position, and case) to be used for the search text in fi n d p a r a a t t r " Any" , - 3 , - 3
the Find, Change, and ChangeAll commands. changepar aatt r "Any", -3, -3
Reply: sFontName, dPointSize, dLeading, fi n d t y p e a t t r 2 - 3 , - 3 , " Any" , - 3
cTypeStyle, cPosition, cCase ch a n g e t y p e a t t r 2 - 3 , - 3 , " Any " , - 3
ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s ,
Story editor only. The GetFindTypeAttr1 query
useatt r i butes
works only in story editor. getfindt y p eatt r1--Reply : "Any", 10, -3, 5, -3, -3
Type styles are additive. If the cTypeStyle g e tch a n g e t y p e a t t r 1 - - Re p l y : " He lve t i c a " , 9 , - 3 , 1 ,
parameter is set to multiple type styles, the return -3, -3
value is the sum of the numeric equivalents for the
styles. For example, if the type style is set to both
See also:
bold (1) and underline (4), PageMaker returns 5
(the sum of 1 and 4). The GetChangeParaAttr, GetChangeTypeAttr1,
GetChangeTypeAttr2, GetChangeWindow, Get-
Any for cTypeStyle, cPosition, and cCase. Unlike FindParaAttr, GetFindTypeAttr2, GetFindWin-
the Type Styles pop-up menu in the Find dow, and GetTypeStyle queries
Attributes dialog box, the -3 setting for cTypeStyle The Change, ChangeAll, ChangeNext,
pertains only to the type styles Bold, Italic, ChangeParaAttr, ChangeTypeAttr1,
Underline, Strikethru, Outline, Shadow, and ChangeTypeAttr2, ChangeWindow, Find, FindN-
Reverse. The value of cTypeStyle does not affect ext, FindParaAttr, FindTypeAttr1, FindTypeAttr2,
the cPosition and cCase parameters, which are and FindWindow commands
turned off and on separately.
 ADOBE PAGEMAKER 7.0 191
Queries

GetFindTypeAttr2 Example. The following example opens the "Find"

dialog box and then queries for its status.
Gets additional text attributes (set width, tracking,
color, and tint) to be used for the search text in the findw indow open
Find, Change, and ChangeAll commands. getfindw indow
- - ex p e c te d rep l y : 1
Reply: dSetWidth, cTrack, sColorName,
nTintValue
See also:
Story editor only. The GetFindTypeAttr2 query
works only in story editor. The GetChangeParaAttr, GetChangeTypeAttr1,
GetChangeTypeAttr2, GetChangeWindow, Get-
Example. The following example changes all FindParaAttr, GetFindTypeAttr1, and
purple text in the current publication to a 93% tint GetFindTypeAttr2 queries
of purple. (Notice that it sets all other Find and The Change, ChangeAll, ChangeNext,
Change attributes to Any.) It then queries for the ChangeParaAttr, ChangeTypeAttr1,
Find and Change type settings. ChangeTypeAttr2, ChangeWindow, Find, FindN-
ext, FindParaAttr, FindTypeAttr1, FindTypeAttr2,
fi n d p a r a a tt r "Any ", - 3, - 3
and FindWindow commands
changepar aatt r "Any", -3, -3
fi n d t y p ea tt r1 "Any ", - 3, - 3, - 3, - 3 , - 3
ch a n g e t y p e a t t r 1 " Any " , - 3 , - 3 , - 3 , - 3 , - 3
GetFont
fi n d t y p ea tt r2 - 3, - 3, "Pu r p l e", - 3
ch a n g e t y p e a t t r 2 - 3 , - 3 , " Pu r p l e " , 9 3 Gets the name of the font applied to the
ch a n g e a l l " " , " " , a l l s to r i e s , a nyc a s e , a l l i n s t a n ce s , highlighted text.
useatt r i butes Reply: sFontName
getfindt y p eatt r2--Reply : -3, -3, "Pur ple", -3
Defining or editing a style. If you are defining or
getchanget y p eatt r2--Reply : -3, -3, "Pur ple", 93
editing a style using the StyleBegin command,
PageMaker gets the font for that style, rather than
See also: for the selected text.
The GetChangeParaAttr, GetChangeTypeAttr1, Empty string. If multiple characters are selected
GetChangeTypeAttr2, GetChangeWindow, Get-
and they have different fonts assigned to them,
FindParaAttr, GetFindTypeAttr1, and GetFind-
PageMaker returns an empty string for
Window queries
sFontName.
The Change, ChangeAll, ChangeNext,
ChangeParaAttr, ChangeTypeAttr1, No insertion point. If the text does not contain the
ChangeTypeAttr2, ChangeWindow, Find, FindN- insertion point, PageMaker gets the default font.
ext, FindParaAttr, FindTypeAttr1, FindTypeAttr2,
No text selected. If the text contains the insertion
and FindWindow commands
point but no text is selected, PageMaker returns the
font of the character preceding the insertion point.
If the insertion point is before the first character of
GetFindWindow
the story, PageMaker returns the font of the first
Gets the display status (open or closed) of the Find character.
dialog box.
Reply: bOpen See also:
Story editor only. The GetFindWindow query The Font command
works only in story editor.
 ADOBE PAGEMAKER 7.0 192
Queries

GetFontDrawing • The default font for the publication.

Gets the TrueType line-spacing or character-shape Fonts in EPS files not listed. PageMaker does not
preference. list fonts used in EPS files (unless the font is already
on the Font submenu or used elsewhere in the
Reply: bIgnore, cPresrvShape
publication).
bIgnore replaces bUseATM. The bIgnore
parameter replaces the bUseATM parameter found See also:
in earlier versions of the PageMaker command
The Font command
language. Because this version of PageMaker uses
ATM whenever it is present, the bUseATM
parameter is invalid. The bIgnore parameter acts
as a placeholder to maintain compatibility with
GetFrameContentPos
plug-ins or scripts created using earlier versions of Returns the Content Position settings for the
the command language. currently selected frame(s).
Reply: nVertAlign, nHorzAlign, nScale Type,
See also: nKeep, AspectRatio
The FontDrawing command Layout view only. The GetFrameContentPos
query works only in layout view.

GetFontList See Also:

Lists the number of fonts displayed in the Font
The GetFrameInset, GetFrameContentType, Get-
submenu and specifies (for each): IsFrame, and GetNextFrame queries
• Name The AttachContent, BreakLinks, DeleteContent,
FrameContentPos, FrameInset, LinkFrames, Sep-
• ID
arateContent, and ToggleFrame commands
• Whether it is installed in the system
• Whether it is used in the publication (which
includes any fonts displayed in story editor, named GetFrameContentType
in style definitions, or selected as the default font Returns the content type for the selected frame.
for the publication)
Reply: nType
Reply: nNumOfFonts[, sFontName, nFontID,
Layout view only. The GetFrameContentType
bInstalled, bUsedInPub]...
query works only in layout view.
Processing time. This query may take a while to
process, but the processing time will not exceed the
time PageMaker takes to open the publication.
See Also:
The GetFrameContentPos, GetFrameInset, GetIs-
What bUsedInPub means. PageMaker sets bUsed-
Frame, and GetNextFrame queries
InPub to 1 if the font is:
The AttachContent, BreakLinks, DeleteContent,
• Applied to text in the publication, even if the text FrameContentPos, FrameInset, LinkFrames, Sep-
is unplaced or on the pasteboard. arateContent, and ToggleFrame c
• Used to display text in story editor.
• Named in style definitions.
 ADOBE PAGEMAKER 7.0 193
Queries

GetFrameInset Coordinates for transformed objects. If the object

was skewed, rotated, or reflected, the coordinate
Returns the inset for the selected text frame.
pairs (xLeftOrStart, yTopOrStart), (xRight-
Reply: nTop, nLeft, nBottom, nRight OrStart, yTopOrStart2), (xLeftOrEnd,
yBotOrEnd2), and (xRightOrEnd, yBotto-
Layout view only. The GetFrameInset query
mOrEnd) indicate the current locations of the
works only in layout view.
handles that originally were in the left-top, right-
top, left-bottom, and right-bottom positions.
See Also:
The GetFrameContentPos, GetFrameContent-
Type, GetIsFrame, and GetNextFrame queries
The AttachContent, BreakLinks, DeleteContent,
FrameContentPos, FrameInset, LinkFrames, Sep-
Coordinates for lines. PageMaker returns the
arateContent, and ToggleFrame commands
corners of the bounding box for most objects, but
returns the starting and end points for lines. The
first coordinate pair (xLeftOrStart, yTopOrStart)
GetGroupList nGroupID
corresponds to the starting point of the line. The
Gets the number of objects in the specified group second coordinate pair (xRightOrEnd, yBotto-
and, for each object, gets its object ID, group ID, mOrEnd) corresponds to the end point of the line.
drawing number, type, whether the object is linked The third and fourth coordinate pairs are irrel-
and has been transformed, and its coordinates. evant because they duplicate the values of the first
Parameter Values to enter two coordinate pairs.

nGroupID Unique ID of group.

Reply: nNumOfObj[, nObjectID, nMaskID,

nGroupID, nDrawNumber, cTypeOfObject,
bTransformed, bLinked, xLeftorStart,
yTopOrStart, xRightOrEnd, yBottomOrEnd,
xRightOrStart, yTopOrStart2, xLeftOrEnd,
Where the weight of a line lies in relation to the end
yBotOrEnd2]...
points depends upon the type of line and whether
Measurement units for scripts. PageMaker the user has flipped the weight of the line with the
returns coordinates using the publication default pointer tool to the other side of the line (horizontal
units, specified in the Preferences dialog box or and vertical lines only). The illustration above
with the MeasureUnits command. shows the default locations: Horizontal lines hang
down from the end points; vertical lines hang to
the right of the end points; diagonal lines are
centered.
 ADOBE PAGEMAKER 7.0 194
Queries

Example. The following example creates a new ToRulers, and GetZeroLock queries
publication, draws and styles two boxes (of The Guides command
different sizes), and skews the second box. It selects
both boxes, groups them, and then queries for
information about the group. Notice that although GetHorizGuides
the two objects are different sizes and shapes, their
Gets the number of horizontal ruler guides and the
left-top and right-bottom handles overlap,
position of each guide.
resulting in the same return values. To get more
detailed information about transformed objects, Reply: nNumber[, yPosition]...
use the GetTransform query. To get more detailed Measurement units for scripts. PageMaker
information about linked objects, use the returns coordinates using the publication default
GetLinkInfo and GetLinks query. Notice also the units, specified in the Preferences dialog box or
nDrawNumber for this group is 1 and the with the MeasureUnits command.
nDrawNumber for the boxes are 2 and 3 respec-
tively. Order guides returned. PageMaker returns
horizontal guides in the reverse order in which
new
they were created.
b ox 0 , 0 , 3 , 1
l i n est y l e o n ep o i n t
fi l l s t y l e n o n e See also:
b ox 0 , 0 , 2 , 1 The GetGuides, GetVertGuides, GetLockGuides,
linestyle none GetRulers, GetSnapToGuides, GetSnapToRulers,
fi l l s t y l e s o l i d and GetZeroLock queries
skew lefttop, -45 The GuideHoriz command
selectall
g ro u p
g e t g ro u p l i s t 3 GetHyperLinkPalette
- - ex p e c te d rep l y : Gets the state (on or off) of the Hyperlinks panel.
2, 1, 3, 2, 4, 0, 0, 0, 0, 3, 1, 0, 0, 1, 2, 2, 3, 3, 4 , 1 , 0 , 0 , 0 , 3 , 1 , 2
, 0, 1, 1 Reply: bState

See also: See also:

The GetObjectLoc, GetSelectIDList, GetTrans- The GetColorPalette, GetControlPalette, GetMas-
form, GetLineStyle, GetObjectIDListTop, and terPagePalette, and GetStylePalette queries
GetSelectIDListTop queries The ColorPalette, ControlPalette, HyperLinkPal-
ette, MasterPagePalette, and StylePalette com-
mands
GetGuides
Gets the current setting (on or off) of the Show
GetHyphenation
Guides command.
Gets the hyphenation settings assigned to the
Reply: bState selected text or to the paragraph containing the
insertion point.
See also: Reply: cState, nHyphenLimit, xZone
The GetHorizGuides, GetVertGuides, GetLock-
Guides, GetRulers, GetSnapToGuides, GetSnap-
 ADOBE PAGEMAKER 7.0 195
Queries

Measurement units for scripts. PageMaker Reply: nNumOfFilters[, sFilterName, sVersion]...

returns coordinates using the publication default
units, specified in the Preferences dialog box or
See also:
with the MeasureUnits command.
The GetExportFilters query
Defining or editing a style. If you are defining or
editing a style using the StyleBegin command,
PageMaker gets the hyphenation setting for that GetIndents
style, rather than for the selected text.
Gets the indent settings assigned to the selected
Pointer tool active. If the pointer tool is active, text or to the paragraph containing the insertion
PageMaker gets the default hyphenation setting. point.
Multiple settings. If multiple paragraphs are Reply: xLeftIndent, xFirstIndent, xRightIndent
selected and they have different hyphenation
Measurement units for scripts. PageMaker
settings, PageMaker returns -2 for the parameters
returns coordinates using the publication default
with conflicting settings.
units, specified in the Preferences dialog box or
with the MeasureUnits command.
See also:
Defining or editing a style. If you are defining or
The Hyphenation command editing a style using the StyleBegin command,
PageMaker gets the indent settings for that style,
rather than for the selected text.
GetImageFrame
Multiple settings. If multiple paragraphs are
Returns the coordinates of the image frame of the
selected and they have different indent settings,
selected imported image. (Select only one image at
PageMaker returns the settings of the first
a time.)
paragraph.
Reply: xLeftDC, yTopDC, xRightDC,
Pointer tool active. If the pointer tool is active,
yBottomDC
PageMaker gets the default indent settings.
Device coordinates. PageMaker uses the device
coordinates specified in the image.
See also:
Single object only. If multiple objects are The GetTabs query
selected, PageMaker returns an error.
The Indents command
Imported images only. Use this query for
imported images only. If you select an image
drawn in PageMaker and then use this query, GetInkInfo sInk Name
PageMaker returns an error. Gets the print settings for a particular ink. This
query applies only to HiFi inks.
See also: Parameter Values to Enter
The GetCropRect query
sInk Name Name of the ink, as it appears in Print Dia-
log Box

GetImportFilters
Gets the number of installed import filters and the
name and version number for each.
 ADOBE PAGEMAKER 7.0 196
Queries

Reply:sAngle, sRuling, bCustomND, Reply: cKind, dNDValue

nNeutralDensity Calculating tints. To calculate the neutral density
Parameter Reply Values of a tint, use the root color for sName and multiply
its neutral density by the tint percentage.
sAngle Angle at which the ink will be screened
(the value is returned in a string format as
it appears in the Print Dialog Box)
See also:
sRuling Ruling at which the ink will be screened The InkND command
(the value is returned in a string format,
as it appears in the Print Dialog Box)

bCustomND 0 if the default neutral density value for GetIsFrame

this ink will be used
Determines whether a selected object is a frame by
1 if a custom neutral density value for
this ink will be used sending this query.

nNeutralDen- Neutral density for ink from 0.000 to Reply: bFrame

sity 10.000 (to three decimal places) that will
be used in printing the ink Layout view only. The GetIsFrame query works
only in layout view.

See also: See Also:

The DefineColor, InkND, and PrintInk com- The GetFrameContentPos, GetFrameInset, GetFr-
mands ameContentType, and GetNextFrame queries
The GetColor, GetColorInfo, GetColorNames, The AttachContent, BreakLinks, DeleteContent,
GetInkNames, and GetInkND FrameContentPos, FrameInset, LinkFrames, Sep-
queries arateContent, and ToggleFrame commands

GetInkNames GetKern obsolete query; see

Gets the names of all the high fidelity inks defined GetKernText
in the publication. The GetKernText query replaces the GetKern
Reply: nNumOfInks[, sInkName]... query.

See also: GetKernText

The GetColor, GetColorInfo, GetColorPalette,
Gets the amount of kerning for the highlighted
and GetTint queries
text.
Reply: nAmount
GetInkND sName Select text with TextSelect command or text tool.
Gets the neutral-density value for a process ink or To use this command, you must select the text (two
spot color. or more characters) with the TextSelect command
(or the text tool). If no text is selected, PageMaker
Parameter Values to enter
gets the kerning of the two letters on either side of
sName Name of ink or spot color (no tints), in the insertion point.
quotation marks and exactly as it
appears on the Colors palette.
 ADOBE PAGEMAKER 7.0 197
Queries

GetKernText replaces GetKern. The GetKernText GetLayerList

command replaces the GetKern command.
Gets the number of layers in the current publi-
cation and for each layer, the name of the layer, and
See also: the layers options.
The GetTrack query Reply: nCount, (sLayerName, bShow, bLock,
The KernText, ManualKerning, TextSelect, and nColorIndex, nRed, nGreen, nBlue)
Track commands

See Also:
GetLayAdjOpts The GetLayerOptions, GetLayerFromID, GetPas-
teRemembers, and GetTargetLayer queries
Gets the settings from the Layout Adjustment
Preferences dialog box. The AssignLayer, DeleteLayer, DeleteUnusedLay-
ers, LayerOptions, LockLayers, MoveLayer, New-
Reply: nSnapToZone, bResizeOK, bIgnoreLocks, Layer, PasteRemembers, SelectLayer, ShowLayers,
bIgnoreGuides, bMoveGuides, bKeepGuide- and TargetLayer commands
sAligned

See also: GetLayerOptions sLayerName

Gets the layer options for the layer specified in
The GetLayerList, GetLayerFromID, GetPasteRe-
members, and GetTargetLayer queries sLayerName.
The AssignLayer, DeleteLayer, DeleteUnusedLay- Reply: bShow, bLock, nColorIndex, nRed,
ers, LayerOptions, LockLayers, MoveLayer, New- nGreen, nBlue
Layer, PasteRemembers, SelectLayer, ShowLayers,
and TargetLayer commands Note. On the Macintosh, the red, green, and blue
values range from 0 to 65535. On Windows, the red,
green, and blue values range from 0 to 255. For
GetLayerFromID nObjectID custom colors, nColorIndex has the value custom-
handlecolor; otherwise values range from 0 to
Returns the name of the layer to which the object
customhandlecolor.
is assigned, given the ID of an object.
Reply: sLayerName
See Also:
Layout view only. The GetLayerFromID query The GetLayerList, GetLayerFromID, GetPasteRe-
works only in layout view. members, and GetTargetLayer queries
The AssignLayer, DeleteLayer, DeleteUnusedLay-
See Also: ers, LayerOptions, LockLayers, MoveLayer, New-
Layer, PasteRemembers, SelectLayer, ShowLayers,
The GetLayerList, GetLayerOptions, GetPasteRe-
and TargetLayer commands
members, and GetTargetLayer queries
The AssignLayer, DeleteLayer, DeleteUnusedLay-
ers, LayerOptions, LockLayers, MoveLayer, New-
GetLayerPalette
Layer, PasteRemembers, SelectLayer, ShowLayers,
and TargetLayer commands Determines whether the palette that contains the
layers panel is currently displayed.
Reply: bState
 ADOBE PAGEMAKER 7.0 198
Queries

See Also: See also:

The GetLayerList, GetLayerOptions, GetPasteRe- The GetLastError query
members, and GetTargetLayer queries
The AssignLayer, DeleteLayer, DeleteUnusedLay-
ers, LayerOptions, LockLayers, MoveLayer, New- GetLeading
Layer, PasteRemembers, SelectLayer, ShowLayers, Gets the leading value assigned to the selected text.
and TargetLayer commands
Reply: nPoints

Defining or editing a style. If you are defining or

GetLastError editing a style using the StyleBegin command,
Returns the code for the error encountered by PageMaker gets the leading value for that style
PageMaker when trying to execute the last plug-in rather than for the selected text.
command or query.
Multiple settings. If multiple characters are
Reply: nErrorCode selected and the characters have different leading
values assigned to them, PageMaker returns -2 for
Getting the last error code and string. If you
nPoints.
follow GetLastError with GetLastErrorStr (or vice
versa), only the first query returns a valid error No insertion point. If the text does not contain the
code or message (unless the first query fails). The insertion point, PageMaker gets the default leading
second query gets the error code or message from value.
the first query. A successful query (or command)
No text selected. If the text contains the insertion
automatically resets the parameter block.
point but no text is selected, PageMaker returns the
leading value of the character preceding the
See also: insertion point. If the insertion point is before the
The GetLastErrorStr query first character of the story, PageMaker returns the
leading value of the first character.

GetLastErrorStr See also:

Returns the error string for the error encountered The Leading command
by PageMaker when trying to execute the last plug-
in command or query.
Reply: sErrorString GetLetterSpace
Gets the letter-spacing attributes assigned to the
Getting the last error code and string. If you
selected text or the paragraph containing the
follow GetLastError with GetLastErrorStr (or vice
insertion point.
versa), only the first query returns a valid error
code or message (unless the first query fails). The Reply: dLetterMin, dLetterDesired, dLetterMax
second query gets the error code or message from
Defining or editing a style. If you are defining or
the first query. A successful query (or command)
editing a style using the StyleBegin command,
automatically resets the parameter block.
PageMaker gets the letter-spacing attributes for
No error. If PageMaker did not encounter an that style rather than for the selected text.
error, it returns a space within quotation marks.
 ADOBE PAGEMAKER 7.0 199
Queries

Multiple settings. If multiple paragraphs are Layout view only. The GetLineBreak query works
selected and they have different letter-spacing only in layout view.
attributes, PageMaker returns -2 for the param-
Example. The following example gets the number
eters with conflicting settings. Because PageMaker
of line breaks in the highlighted text, the type of
also returns -2 when the letter spacing is set to -2,
break, and character count since last break.
this reply may be ambiguous in such cases.
getlinebreak
Pointer tool active. If the pointer tool is active,
PageMaker gets the default letter-spacing
attributes.

See also:
The GetWordSpace query
See also:
The LetterSpace command
The GetLineBreakLoc and GetTextRun queries

GetLineBreak GetLineBreakLoc
Gets the number of line breaks in the highlighted
Gets the number of line breaks in the highlighted
text and gets the type (e.g., text wrap, end of line,
text and gets the type (e.g., text wrap, end of line,
tab, soft return, or hard return) and character
tab, soft return, or hard return), height (line
count since the last line break for each.
depth), line width, and character count since the
Reply: nLineCount[, nCharCount, nLine- last line break for each.
BreakType]...
Reply: nLineCount[, nCharCount, cLine-
Several lines selected. Be careful not to select too BreakType, nLineHeight, nComposeWidth]...
much text; this query can return a large amount of
Several lines selected. Be careful not to select too
data, especially if the text contains numerous tabs.
much text; this query can return a large amount of
nCharCount includes line breaks, not end of selec- data, especially if the text contains numerous tabs.
tion. If more than one type of line break occurs at If your plug-in, rather than PageMaker, allocates
the same point, PageMaker returns an nChar- the reply buffer but doesn't make it large enough,
Count/nLineBreakType pair for each line break. the query will fail.
However, the end of the selection is not a character
nCharCount includes line breaks. If more than
and is not included in nCharCount.
one type of line break occurs at the same point,
Extra space between paragraphs. PageMaker PageMaker returns an nCharCount/nLine-
returns a separate nCharCount/cLineBreakType BreakType pair for each line break.
pair for extra space between paragraphs, setting
Extra space between paragraphs. PageMaker
nCharCount to 0 (zero) and cLineBreakType to 2.
returns a separate nCharCount/cLineBreakType
Extra space includes space added by the:
pair for extra space between paragraphs, setting
• Space Before and Space After paragraph options. nCharCount to 0 (zero) and cLineBreakType to 2.
• Align to Grid option. Extra space includes space added by the:

• Top and bottom text-wrap boundary of a • Space Before and Space After paragraph options.
graphic. • Align to Grid option.
 ADOBE PAGEMAKER 7.0 200
Queries

• Top and bottom text-wrap boundary of a GetLinkInfo

graphic.
Gets the detailed link information of the selected
Measurement units for scripts. PageMaker object or text block.
returns measurements using the publication
Reply: fFilename, cLinkTech, sKind, nSize,
default units, specified in the Preferences dialog
box or with the MeasureUnits command. sPlacedTime, sModTime, sInternalDateMod
Empty string or -2. PageMaker returns an empty
Layout view only. The GetLineBreakLoc query
works only in layout view. string for fFilename, sKind, sModTime, and
sInternalDateMod and -2 for cLinkTech and nSize
Example. The following example gets the number if you select:
of line breaks in the highlighted text, the type of
break, the height, line width, and character count • No object or the text tool is active.
since last break. • More than one object.
getlinebreak • An unlinked object (such as a text block or object
drawn in PageMaker).
Date string formats. The format of the date
strings (sPlacedTime, sModTime, sInternalDa-
teMod) matches the format displayed in the Link
Info dialog box. The format depends upon the
See also: language version of the system, not the language
The GetLineBreak and GetTextRun queries version of PageMaker. In Windows, PageMaker
obtains the format from the win.ini file. On the
Macintosh, PageMaker reads the format from the
GetLineStyle international resource (INTL, ID=0) in the system.
Gets the line style assigned to the selected object. For example, when running under a Macintosh US
English system, any language version of PageMaker
Reply: cStyleIndex, bReverse, dWeight, bOpaque
returns the date and time in this format: 9/19/91,
Multiple settings. If multiple objects are selected 11:30 AM.
and they have different line styles assigned to them,
PageMaker returns -2 for cStyleIndex. If the
See also:
reverse settings do not match, PageMaker returns 0
(zero) for bReverse. The GetLinkOptions and GetLinks queries
The LinkOptions and Relink commands
Default settings. If the text tool or story editor is
active, or if no PageMaker-drawn objects are
selected, PageMaker gets the publication default GetLinkOptions [bDefault]
line style.
Gets the link-option settings for the selected object
or, if nothing is selected (or no publication is
See also: open), gets the default link options. (Select only
The GetFillAndLine query one object at a time.)
The FillAndLine, FillStyle, and LineStyle com- Parameter Values to enter
mands
bDefault 0 for link options for selected object or, if
in story editor, for current story

1 for publication default link options

 ADOBE PAGEMAKER 7.0 201
Queries

Reply: bTextUpdate, bTextAlert, bImageStore, See also:

bImageUpdate, bImageAlert The GetGuides, GetHorizGuides, and GetVert-
-2 reply value. PageMaker returns -2 for a Guides queries
parameter in the following instances: The LockGuides command
• The selected object is text: PageMaker returns -2
for all the image parameters (bImageStore,
GetLock
bImageUpdate, and bImageAlert).
Gets the lock status of the selected object.
• The selected object is an image: PageMaker
returns -2 for all the text parameters (bTextUpdate Reply: bLockStatus
and bTextAlert). No object selected. If either the text tool or story
• Multiple objects or text blocks are selected: editor is active or if no object is selected,
PageMaker returns -2 for all parameters. PageMaker returns a failure.
• The selected object is not linked to an external Multiple settings. If multiple objects are selected
file, PageMaker returns -2 for all parameters. and they have different lock settings, PageMaker
Default settings. If bDefault is set to true or no returns -2 for bLockStatus.
imported image or story is selected, PageMaker Locking freezes position and size, not attributes.
gets the publication default link options. A locked object cannot be deleted, moved, or
transformed. However, the Lock command does
See also: not lock other attributes of an object, such as color,
line style, and fill for PageMaker-drawn graphics,
The GetLinkInfo and GetLinks queries
or point size and paragraph style for text within a
The LinkOptions and Relink commands text block. The following commands have no affect
on locked objects: Cut, Clear, Crop, Delete, Move,
Nudge, Reflect, Resize, ResizePct, Rotate, and
GetLinks Skew.
Gets the number of linked files in the publication
Inline graphics. The size and baseline of a locked
and the filename, type (text, EPS, TIFF, PICT), and
inline graphic are frozen, but not its position on
a page on which each linked file appears.
the page.
Reply: nNumOfLinks[, fFilename, cKind,
nPage]...
See also:
The Lock command
See also:
The GetLinkOptions and GetLinkInfo queries
The LinkOptions and Relink commands GetMasterItems
Gets the current state (on or off) of the Display
Master Items command.
GetLockGuides
Reply: bState
Gets the current state (on or off) of the Lock
Guides option.
See also:
Reply: bState
The MasterItems command
 ADOBE PAGEMAKER 7.0 202
Queries

GetMasterPage Measurement units for scripts. PageMaker

returns coordinates using the publication default
Gets the names of the master pages associated with
units, specified in the Preferences dialog box or
the current pages.
with the MeasureUnits command.
Reply: sLeftMaster, sRightMaster
Document Master. To get information about the
Document Master and None. The GetMasterPage Document Master, do not include the brackets that
query returns the prenamed master pages, enclose the name in the menu. For example:
Document Master and None, but without the
get master pageinfo "Document Master"
brackets ([]) that appear in the palette.
Example. The following example creates the
Example. The following example sets the publi- master spread Ad Layout with an inside margin of
cation to double-sided pages with facing pages 1 inch, a top margin of 0.5 inches, an outside
turned off. It applies the master page Editorial to margin of 0.75 inches, and a bottom margin of 0.5
all left pages and the master page Advertisement to inches. Both pages have two columns with a 0.2-
all right pages. It then switches to page 1 and inch gutter between the columns. It then queries
queries for the master page. The reply values for the master page settings.
indicate that only a right page is displayed and that
definemaster page "Ad Layo ut", t r ue, 1i, .5i, .75i,
its master page is Advertisement.
.5i, 2, .2i, 2, .2i
pageoptions on, off get master pageinfo "Ad Layout"
master page "Editor ial", "Adver tisement", "" - - ex p e c te d rep l y : 1 , 1 , . 5 , . 7 5 , . 5 , 2 , . 2 , 2 , . 2
page 1
get master page
See also:
- - exp ecte d rep l y : "", "Adver ti seme n t "
The GetMasterPage and GetMasterPageList que-
ries
See also: The DefineMasterPage, DeleteMasterPage, Mas-
The GetMasterPageInfo and GetMasterPageList terPage, RenameMasterPage, and SaveAsMaster-
query Page commands
The DefineMasterPage, DeleteMasterPage, Mas-
terPage, RenameMasterPage, and SaveAsMaster-
Page commands GetMasterPageList
Gets the number of master pages in the publi-
cation, and for each gets its ID and name.
GetMasterPageInfo sMasterName
Reply: nNumMasters( ,nPageID,
Gets whether the master page is a single page or
sMasterName)...
spread, its margins, the number of columns, and
the space between columns. Page ID stays with page. While the name of a
master page may change (if you rename it), its ID
Parameter Values to enter
remains the same: A master page is independent of
sMasterName New master page name (maximum of 31 its name. If you assign private data to a master page
characters) and the page is subsequently renumbered, you can
still access the private data using the page ID.
Reply: bSpread, xLeftOrInside, yTop, xRghtOr- (Assigning private data to a master page is one of
Outsd, yBottom, nColumns, xGutter, nColumn- the few instances where you need the ID of a
sRightPage, xGutterRghtPg master page.)
 ADOBE PAGEMAKER 7.0 203
Queries

Example. The following example returns the GetMasterPagePalette

number of master pages in the current publication
Gets the display status (open or closed) of the
and gets the ID and name for each.
Master Pages palette.
get master pagelist
Reply: bOpen

Example. The following example opens the

See also:
Master Page palette and then queries for its status.
The GetMasterPage and GetMasterPageInfo que-
ries master pagepalette on
get master pagepalette
The DefineMasterPage, DeleteMasterPage, Mas-
terPage, RenameMasterPage, and SaveAsMaster- - - ex p e c te d rep l y : 1
Page commands
See also:
The MasterPagePalette command
GetMasterPageName nPageID
Gets the current name of the master page
associated with the specified page ID. GetMeasureUnits
Parameter Value to enter Gets the default measurement system for the
nPageID PageMaker internal ID for master page
publication and the units for the vertical ruler.
Reply: cMeasureUnits, cVertical[, nCustPoints]
Reply: sMasterName

Page ID stays with page. While the name of a See also:

master page may change (if you rename it), its ID The MeasureUnits command
remains the same: A master page is independent of
its name. If you assign private data to a master page
and the page is subsequently renumbered, you can GetMultPasteOffset
still access the private data using the page ID.
Gets the offsets set in the Paste Multiple dialog box.
(Assigning private data to a master page is one of
the few instances where you need the ID of a Reply: xOffset, yOffset
master page.) Measurement units for scripts. PageMaker
Example. The following example returns the returns coordinates using the publication default
name of the master page currently associated with units, specified in the Preferences dialog box or
the ID15. with the MeasureUnits command.
get master pagename 15 MultiplePaste changes defaults. Each time you
use the MultiplePaste command, it sets the default
offsets in the Paste Multiple dialog box. Use the
See also:
MultPasteOffset command to reset the default
The GetMasterPage, GetMasterPageInfo, and Get- offsets either to a different value or back to their
MasterPageList queries original value.
The DefineMasterPage, DeleteMasterPage, Mas-
terPage, RenameMasterPage, and SaveAsMaster-
Page commands
 ADOBE PAGEMAKER 7.0 204
Queries

Example. The following example selects and Defining or editing a style. If you are defining or
copies the third object drawn. It queries for the editing a style using the StyleBegin command,
current default offset, pastes five copies, and then PageMaker gets the Next Style for that style rather
resets the default offsets back to their previous than for the selected text.
values.
Empty string. PageMaker returns an empty string
select 3 for sNextStyle:
copy
• If the Next Style is set to Same Style.
g e t mu l t p a s te o f f s e t - - ex p e c te d rep l y 3 , 3
mu l t i p l e p a s te 5 , 0 p 4 , 0 p 9 • If multiple paragraphs are selected and they have
mu l t p a s te o f f s e t 3 , 3 different styles assigned to them.
Pointer tool active. If the pointer tool is active,
See also: PageMaker gets the Next style for the default style.

The Copy, MultiplePaste, MultPasteOffset, and

Paste commands See also:
The GetBasedOn, GetStyle, and GetStyleNames
queries
GetNextFrame nDirection The NextStyle command
Gets the object ID of the next (or previous) frame
in a chain.
GetNoBreak
Parameter Value
Gets the Break/No Break setting of text, which
nDirection 0 for next frame
determines whether the selected text can be broken
1 for previous frame between lines or kept together on same line.
Reply: bState
Reply: nObjectID

Layout view only. The GetNextFrame query

See also:
works only in layout view.
The NoBreak command

See Also:
The GetFrameContentPos, GetFrameInset, GetFr- GetNonPrinting
ameContentType, and GetIsFrame queries
Gets the print state (printing or nonprinting) of
The AttachContent, BreakLinks, DeleteContent, the selected objects.
FrameContentPos, FrameInset, LinkFrames, Sep-
arateContent, and ToggleFrame commands Reply: bState

Objects must be selected. If no objects are

selected (or text is highlighted with the text tool or
GetNextStyle TextSelect command) when the query is received,
Gets the name of the style designated as the Next PageMaker returns an error.
Style in the current style's definition.
Objects with different settings. If the selected
Reply: sNextStyle objects do not have the same print state (that is,
some print and others do not), PageMaker returns
an error.
 ADOBE PAGEMAKER 7.0 205
Queries

GetNonPrinting replaces GetSuppressPrint. To Coordinates for transformed objects. If the

match the name on the PageMaker Layout menu, selected object was skewed, rotated, or reflected,
the GetNonPrinting command replaces the the coordinate pairs (xLeftOrStart, yTopOrStart),
GetSuppressPrint command. (xRightOrStart, yTopOrStart2), (xLeftOrEnd,
yBotOrEnd2), and (xRightOrEnd, yBotto-
Example. The following example selects the third
mOrEnd) correspond to the original left-top,
object drawn, marks it to not print, and queries for
right-top, left-bottom, and right-bottom handles,
its nonprinting setting.
but indicate their current locations.
select 3
nonpr inting on
g e t n o n p r i n t i n g - - ex p e c te d rep l y : 1

See also: Coordinates for lines. PageMaker returns the

The GetDisplayNonPrinting query corners of the bounding box for most objects, but
The DisplayNonPrinting and NonPrinting com- returns the starting and end points for lines. The
mands first coordinate pair (xLeftOrStart, yTopOrStart)
corresponds to the starting point of the line. The
second coordinate pair (xRightOrEnd, yBotto-
GetObjectIDList mOrEnd) corresponds to the end point of the line.
The third and fourth coordinate pairs are irrel-
Gets the number of objects on the currently
evant because they duplicate the values of the first
displayed page or pages and gets the ID, group ID,
two coordinate pairs.
drawing order, type, and coordinates for each, and
whether the object is linked and transformed.
(This query does not return information about
groups; use GetObjectIDListTop instead.)
Reply: nNumofObj[, nObjectID, nMaskID,
nGroupID, nDrawNumber, cTypeOfObject,
bTransformed, bLinked, xLeftOrStart,
yTopOrStart, xRightOrEnd, yBottomOrEnd,
Where the weight of a line lies in relation to the end
xRightOrStart, yTopOrStart2, xLeftOrEnd,
points depends upon the type of line and whether
yBotOrEnd2]...
the user has flipped the weight of the line with the
Measurement units for scripts. PageMaker pointer tool to the other side of the line (horizontal
returns coordinates using the publication default and vertical lines only). The illustration above
units, specified in the Preferences dialog box or shows the default locations: horizontal lines hang
with the MeasureUnits command. down from the end points; vertical lines hang to
the right of the end points; diagonal lines are
Facing pages. In double-sided, facing-pages
centered.
mode, PageMaker returns the object list for both
pages. This query does not return fields that specify:
Story editor. If you insert any inline graphics • The type of line (horizontal, vertical, or
while in story editor, switch to layout view before diagonal). Instead, use the GetTransform query.
sending the GetObjectIDList query. Otherwise, the
• The width of a diagonal line. Instead, use the
inserted graphics will not be included in the list of
GetLineStyle query.
objects returned by the query.
 ADOBE PAGEMAKER 7.0 206
Queries

• The location of the weight of horizontal or Reply: nNumOfObj[,nObjectID, nMaskID,

vertical lines. Currently, no query returns this nGroupID, nDrawNumber, cTypeOfObject,
information. bTransformed, bLinked, xLeftorStart,
Example. The following example creates a new
yTopOrStart, xRightOrEnd, yBottomOrEnd,
publication, draws and styles two boxes (of xRightOrStart, yTopOrStart2, xLeftOrEnd,
different sizes), and skews the second box. It yBotOrEnd2]...
queries for the ID, drawing number, type, and Precede with MiniSave. To make sure all objects
coordinates of the objects on the page. Notice that are listed, always precede GetObjectIDListTop
although these two objects are different sizes and with the MiniSave command. Otherwise inline
shapes, their left-top and right-bottom handles graphics inserted since the last minisave will not be
overlap, resulting in the same return values. To get included in the list of objects returned by the
more detailed information about transformed query.
objects, use the GetTransform query. To get more
Facing pages. In double-sided, facing-pages
detailed information about linked objects, use the
mode, PageMaker returns the object list for both
GetLinkInfo and GetLinks query.
pages.
new
Measurement units for scripts. PageMaker
b ox 0 , 0 , 3 , 1
returns coordinates using the publication default
l i n est y l e o n ep o i n t
units, specified in the Preferences dialog box or
fi l l s t y l e n o n e
with the MeasureUnits command.
b ox 0 , 0 , 2 , 1
linestyle none Coordinates for transformed objects. If the object
fi l l s t y l e s o l i d was skewed, rotated, or reflected, the coordinate
skew lefttop, -45 pairs (xLeftOrStart, yTopOrStart), (xRight-
g e tob j e c t i d l i s t OrStart, yTopOrStart2), (xLeftOrEnd,
- - ex p e c te d rep l y : yBotOrEnd2), and (xRightOrEnd, yBotto-
2, 1, 0, 1, 4, 0, 0, 0, 0, 3, 1, 3, 0, 0, 1, 2, 0, 2, 4 , 1 , 0 , 0 , 0 , 3 , 1 , 2 mOrEnd) correspond to the original left-top,
, 0, 1, 1 right-top, left-bottom, and right-bottom handles,
but indicate their new locations.

See also:
The GetObjectLoc, GetSelectIDList, GetTrans-
form, and GetLineStyle queries

Coordinates for transformed Group. If the group

GetObjectIDListTop was skewed, rotated, or reflected, the coordinate
pairs (xLeftOrStart, yTopOrStart), (xRight-
Gets the number of top-level objects (groups and
OrStart, yTopOrStart2), (xLeftOrEnd,
ungrouped objects only) on the currently
yBotOrEnd2), and (xRightOrEnd, yBotto-
displayed pages. Gets the object ID, group ID,
mOrEnd) correspond to the group's current left-
drawing number, coordinates, and type for each
top, right-top, left-bottom, and right-bottom
object, and whether the object is linked and trans-
handles.
formed. This query does not return information
about objects within groups.
 ADOBE PAGEMAKER 7.0 207
Queries

Coordinates for lines. PageMaker returns the See also:

corners of the bounding box for most objects, but The GetObjectList, GetObjectLoc, GetSelec-
returns the starting and end points for lines. The tIDList, GetSelectList, GetTransform, GetLine-
first coordinate pair (xLeftOrStart, yTopOrStart) Style, GetGroupList, and GetSelectIDListTop
corresponds to the starting point of the line. The queries
second coordinate pair (xRightOrEnd, yBotto-
mOrEnd) corresponds to the end point of the line.
The third and fourth coordinate pairs are irrel- GetObjectList
evant because they duplicate the values of the first
Gets the number of objects on the currently
two coordinate pairs.
displayed pages and gets the drawing order, type,
and coordinates for each.
Reply: nNumofObj[, nDrawNumber, cTypeO-
fObject, xLeftOrStart, yTopOrStart, xRightOrEnd,
yBottomOrEnd]...
Facing pages. In double-sided, facing-pages
mode, PageMaker returns the object list for both
Where the weight of a line lies in relation to the end pages.
points depends upon the type of line and whether
Precede with MiniSave. To make sure all objects
the user has flipped the weight of the line with the
are listed, always precede GetObjectList with the
pointer tool to the other side of the line (horizontal
MiniSave command. Otherwise inline graphics
and vertical lines only). The illustration above
inserted since the last minisave will not be included
shows the default locations: Horizontal lines hang
in the list of objects returned by the query.
down from the end points; vertical lines hang to
the right of the end points; diagonal lines are Measurement units for scripts. PageMaker
centered. returns coordinates using the publication default
units, specified in the Preferences dialog box or
Example. The following example creates a new
with the MeasureUnits command.
publication, draws and styles two boxes (of
different sizes), and skews the second box. It selects Coordinates for transformed objects. If the
both boxes, groups them, and then queries for the selected object was skewed, rotated, or reflected,
top-level object. In this case, only the group object the coordinate pairs (xLeftOrStart, yTopOrStart)
is returned. The two boxes are not included since and (xRightOrEnd, yBottomOrEnd) correspond
they are part of the group. to the original left-top and right-bottom handles,
but indicate their new locations.
new
b ox 0 , 0 , 3 , 1
l i n est y l e o n ep o i n t
fi l l s t y l e n o n e
b ox 0 , 0 , 2 , 1
linestyle none
fi l l s t y l e s o l i d
skew lefttop, -45
selectall
g ro u p
g e tob j e c t i d l i s t to p
- - ex p e c te d rep l y : 1 , 3 , 0 , 1 , 1 4 , 0 , 0 , 0 , 0 , 3 , 1 , 3 , 0 , 0 , 1
 ADOBE PAGEMAKER 7.0 208
Queries

Coordinates for lines. PageMaker returns the fi l l s t y l e n o n e

corners of the bounding box for most objects, but b ox 0 , 0 , 2 , 1
returns the starting and end points for lines. The linestyle none
first coordinates (xLeftOrStart, yTopOrStart) fi l l s t y l e s o l i d
correspond to the starting point of the line. The skew lefttop, -45
second coordinates (xRightOrEnd, yBotto- g e tob j e c t l i s t
mOrEnd) correspond to the end point of the line. - - ex p e c te d rep l y : 2 , 1 , 4 , 0 , 0 , 3 , 1 , 2 , 4 , 0 , 0 , 3 , 1

See also:
The GetObjectLoc, GetTransform, and GetLine-
Style queries
Where the weight of a line lies in relation to the end
points depends upon the type of line and whether
the user has flipped the weight of the line with the GetObjectLoc cHandle
pointer tool to the other side of the line (horizontal Returns the location of the specified handle of the
and vertical lines only). The default locations are: selected object, taking any transformations applied
Horizontal lines hang down from the end points; to the object into account.
vertical lines hang to the right of the end points;
Parameter Values to enter
diagonal lines are centered.
cHandle Handle you want to locate:
This query does not return fields that specify:
Side handles:
• The type of line (horizontal, vertical, or
left or 0
diagonal). Instead, use the GetTransform query.
right or 2
• The width of a diagonal line. Instead, use the
GetLineStyle query. top or 3

bottom or 4
• The location of the weight of horizontal or
vertical lines. Currently, no query returns this Center of object:
information. center or 1
Example. This example creates a new publication,
Corner handles:
draws and styles two boxes (of different sizes), and
lefttop or topleft or 5
skews the second box. It queries for the drawing
number, type, and coordinates of the objects on leftbottom or bottomleft or 6
the page. Notice that although these two objects righttop or topright or 7
are different sizes and shapes, their left-top and rightbottom or bottomright or 8
right-bottom handles overlap, resulting in the
same return values. To get more detailed infor-
Reply: xValue, yValue
mation about transformed objects, use the
GetTransform query. Select only one object. The query returns the
location of a single object. If multiple objects are
new
selected, PageMaker returns an error.
b ox 0 , 0 , 3 , 1
l i n est y l e o n ep o i n t
 ADOBE PAGEMAKER 7.0 209
Queries

Measurement units for scripts. PageMaker - - ex p e c te d rep l y : - 1 . 4 1 4 , 0

returns coordinates using the publication default g e tob j e c t l o c r i g h t b o t to m
units, specified in the Preferences dialog box or - - ex p e c te d rep l y : 1 . 4 1 5 , 0
with the MeasureUnits command.
cHandle for transformed objects. If the selected See also:
object was skewed, rotated, or reflected, cHandle The GetObjectList, GetTransform, and GetLine-
should correspond to the handle before the object Style queries
was transformed. For example, lefttop always
refers to the original left-top handle of an object,
not the handle that is currently the left-most top GetPageID nPageNumber
handle.
Gets the PageMaker internal ID for the specified
page in the current publication.

Parameter Value to enter

nPageNumber Number of page

Working with lines. To get the location of a line,
the only valid values for cHandle are: Reply: nPageID

center or 1 for the midpoint of the line Page ID stays with page. While the number of a
page may change (if you insert or delete a page), its
lefttop or 5 for the starting point of the line
ID remains the same: A page is independent of its
rightbottom or 8 for the end point of the line page number (see example below).
If you assign private data to a page and the page is
subsequently renumbered, you can still access the
private data using the page ID.
Example. The following example returns the ID
Example. This example creates a box and queries currently associated with page 15.
for the location of the left-top and right-bottom new 20
handles. It then rotates the box and queries for the g e t p a g e i d 1 5 - - ex p e c te d rep l y 1 7
new locations of the same handles. (Remember: y rem ovep a ge s 1 3 , 1 4 - - p a ge 1 5 b e com e s p a ge 1 3
coordinates in PageMaker are positive when g e t p a g e i d 1 5 - - ex p e c te d rep l y 1 9
moving down from the zero point and negative g e t p a g e i d 1 3 - - ex p e c te d rep l y 1 7
moving up from the zero point.)

See also:
The GetPageNumber, GetPageNumberByID, and
GetPageNumbers queries
new
b ox 1 , 1 , - 1 , - 1
g e tob j e c t l o c l e f t to p
- - ex p e c te d rep l y : - 1 , - 1
g e tob j e c t l o c r i g ht b o t to m
- - ex p e c te d rep l y : 1 , 1
rotate center 45
g e tob j e c t l o c l e f t to p
 ADOBE PAGEMAKER 7.0 210
Queries

GetPageImag bSelect, hDC. In Windows, the GetPageImage query

cViewPercentage, nRefNumber, hDC requires a handle to the Device Context (hDC).
(Windows) The hDC must declare a bitmap with the desired
rectangular coordinates. PageMaker for Windows
maps the page image into the specified bitmap,
scaling the page as necessary. The size of this image
GetPageImage bSelect, cViewPercent,
depends on the size of the bitmap, not the value
nRefNumber, nPictID (Macintosh)
specified by cViewPercentage.
Gets the image of the current page or selected
items. Returns a bitmap image in Windows and a nRefNumber. On the Macintosh, nRefNumber is
PICT image on the Macintosh. the file reference number. PageMaker will use the
Macintosh toolbox routine AddResource to draw
Parameter Values the page image into this resource file, using PICT
bSelect 0 for entire page as the resource type and nPictID as the resource
ID. If nRefNumber is -1, PageMaker returns
1 for only selected items
hImage. The plug-in is responsible for deleting the
cViewPercent 25 for 25% PICT resource.
50 for 50%
Memory. You may run out of memory when
75 for 75% working with complex or multiple pages in low-
100 for 100% memory situations. To help avoid this problem,
delete the memory used for one page-image
200 for 200%
handle before getting the next page image.
400 for 400%
Also note that pages containing large or complex
-3 for fit in window
graphics may cause problems in low-memory
-4 for entire pasteboard
situations. Whenever possible, we recommend that
nRefNumber File reference number for Mac you change the PageMaker preference for graphic
-2 for Windows display to a gray box or to normal resolution before
using GetPageImage.
hDC (Windows only) Windows handle to
device context
See also:
nPictID (Macintosh only) Resource ID
The GetPreferences query
Reply: [hImage] The Preferences command

Facing pages. In double-sided, facing-pages

mode, PageMaker returns a single image of both
GetPageMargins
pages.
Gets the page margins of the Document Master
bSelect. If bSelect is true, PageMaker returns an master page.
image of only the selected objects on the page (not
the entire page). Reply: xInside, yTop, xOutside, yBottom

cViewPercentage. Only PageMaker for the Layout view only. Use this query only in layout
Macintosh uses the cViewPercentage parameter. view.
Although PageMaker for Windows disregards the
value of the parameter, the parameter is required.
(See "hDC" below.)
 ADOBE PAGEMAKER 7.0 211
Queries

Measurement units for scripts. PageMaker Reply: nPageNumber

returns coordinates using the publication default
Page ID stays with page. While the number of a
units, specified in the Preferences dialog box or
page may change (if you insert or delete a page), its
with the MeasureUnits command.
ID remains the same: A page is independent of its
Example. The following example changes the page number (see example below).
default measurement units to inches. It sets the
If you assign some private data to a page and the
margins of the Document Master to: an inside
page is subsequently renumbered, you can still
margin of 1 inch; a top margin of .5 inches; an
access the private data using the page ID.
outside margin of .75 inches; and a bottom margin
of .5 inches. It then queries for the Document Example. The following example returns the page
Master margins. number currently associated with the page with ID
15.
measureunits inches, inches, 0
pagemarg ins 1, .5, .75, .5 new 20
g e t p a g e m a r g i n s - - ex p e c te d rep l y : 1 , . 5 , . 7 5 , . 5 g e t p a g e i d 1 5 - - ex p e c te d rep l y 1 7
rem ovep a ge s 1 3 , 1 4 - - p a ge 1 5 b e com e s p a ge 1 3
g e t p a g e nu m b e r by i d 1 5 - - ex p e c te d rep l y : nu l l
See also:
( p a ge w i t h I D 1 5 d e le te d )
The GetMasterPageInfo query
The PageMargins command
See also:
The GetPageID, GetPageNumber, and GetPage-
GetPageNumber Numbers queries

Gets the page number of the currently displayed

page or, if a master page is displayed, gets the name GetPageNumbers
of the master page.
Gets some of the settings in the Document Setup
Reply: nCurrentPage, sMasterName dialog box and all of the settings in the Page
Facing pages. In double-sided, facing-pages Numbering dialog box:
mode, PageMaker returns the odd page number of • Starting page number
any facing-page pair.
• Number of pages
• Restart numbering setting (on or off)
See also:
The GetMasterPage, GetPages, and GetPageNum- • Numbering style
bers queries • Prefix for table of contents and index entry page
numbers
Reply: nStartPage, nNumPages, bRestart, cStyle,
GetPageNumberByID nPageID sPrefix
Gets the current number of the page associated
with the specified page ID (in the current publi-
cation). See also:
The PageNumbers command
Parameter Value to enter

nPageID PageMaker internal ID for page

 ADOBE PAGEMAKER 7.0 212
Queries

GetPageOptions GetPageRect
Gets the settings (on or off) of the Double-Sided Gets the coordinates of the current page (or of
and Facing Pages options in the Document the two-page spread if facing pages are
Setup dialog box. displayed).
Reply: bDoubleSided, bFacingPages Reply: xLeft, yTop, xRight, yBottom

Measurement units for scripts. PageMaker

See also: returns coordinates using the publication
The GetPageNumbers, GetPageMargins, and default units, specified in the Preferences dialog
GetPageSize queries box or with the MeasureUnits command.
The PageOptions command Facing pages. With facing pages specified, xLeft
corresponds to the left edge of the left page and
xRight corresponds to the right edge of the right
page.
 ADOBE PAGEMAKER 7.0 213
Queries

GetPageHistory nItem GetPaperSizes

Gets the history of the current page and the last 16 Returns a list of the paper sizes currently available.
pages visited in the publication during the current
Reply: nCount(, sName)...
PageMaker session.

Parameter Value
See also:
nItem -1 to query number of items in history The PageSize command
0 to query current location within history

1-17 to query that particular item in his-

tory GetPaperSources
Returns a list of the paper sources (manual feed
Reply: nPageNumber, sMasterPage and paper trays) currently available.
Note: If the GoBack command is used, PageMaker Reply: nCount(, sName)...
jumps to the previous item in the history but the
history does not change, thus the current item is not
See also:
always the last one. The history can have five items
with the current page being the third item. The PrintPaperPS command

Layout view only. The GetPageHistory query

works only in layout view. GetParaOptions
Gets the paragraph options applied to the selected
See Also: text or to the paragraph containing the insertion
The GoForward and HyperJump commands point.
Reply: bKeepTog, bColumnBreak, bPageBreak,
bIncludeTOC, nKeepWith, nWidow, nOrphan
GetPages
Defining or editing a style. If you are defining or
Gets the number of pages in the publication.
editing a style using the StyleBegin command,
Reply: nNumOfPages PageMaker gets the paragraph options for that
style rather than for the selected text.
Multiple settings. If multiple paragraphs are
GetPageSize selected and they have different options applied to
Gets the width and height of the pages in the publi- them, PageMaker returns -2 for the parameters
cation. that conflict.
Reply: xWidth, yHeight Pointer tool active. If the pointer tool is active,
Measurement units for scripts. PageMaker PageMaker gets the default paragraph options.
returns coordinates using the publication default
units, specified in the Preferences dialog box or See also:
with the MeasureUnits command.
The ParaOptions command

See also:
The PageSize command
 ADOBE PAGEMAKER 7.0 214
Queries

GetParaSpace GetPickers
Gets the settings of the Space Before and Space Gets a list of color pickers currently available to
After paragraph options for the selected text or for PageMaker and their associated libraries.
the paragraph containing the insertion point.
Reply: nCount[, sPicker, sLibrary]...
Reply: nSpaceBefore, nSpaceAfter
Multiple libraries. Some color pickers may use
Measurement units for scripts. PageMaker several libraries; a separate picker and library pair
returns coordinates using the publication default is returned for each library available to the picker.
units, specified in the Preferences dialog box or
with the MeasureUnits command.
See also:
Defining or editing a style. If you are defining or The GetColorInfo query
editing a style using the StyleBegin command,
The DefineColor command
PageMaker gets the Space Before and Space After
settings for that style rather than for the selected
text. GetPMInfo
Multiple settings. If multiple paragraphs are Gets the version of PageMaker and its associated
selected and they have different Space Before and libraries and dictionaries.
Space After settings, PageMaker returns -2 for
nSpaceBefore and nSpaceAfter. Reply: sPageMakerVer, sFileSystemVer, sVMVer,
sImageLibVer, nCount(, sLanguage,
Pointer tool. If the pointer tool is active, sDictionary)...
PageMaker gets the default settings.
Three spaces after name. Three spaces separate
the language name of each dictionary and its
See also: version number in the sLanguage parameter.
The ParaSpace command
Full version name. PageMaker 7.0 returns the
full product and version for the sPageMakerVer
parameter in both Windows and on the
GetPasteRemembers Macintosh (for example, "Adobe PageMaker
Returns the setting for the Paste Remembers Layers 7.0").
setting in the Layers menu.
Reply: bRemembers See also:
The GetDictionary and GetPMLanguage queries.
See Also:
The AssignLayer, DeleteLayer, DeleteUnusedLay-
ers, LayerOptions, LockLayers, MoveLayer, New- GetPMLanguage
Layer, PasteRemembers, SelectLayer, ShowLayers, Gets the language version (used in menus and
and TargetLayer commands dialog boxes) of the current copy of PageMaker.
The GetLayerList, GetLayerFromID, GetLayerOp-
Reply: sLanguage
tions, and GetTargetLayer queries
 ADOBE PAGEMAKER 7.0 215
Queries

Language version, not dictionary. The GetPM- See Also:

Language query returns the language used in the The GetPolygonType, and GetPolygonVertices
menus and dialog boxes. It does not return the queries
name of the default dictionary used for spelling
The CreatePolygon, PolygonMiterLimit, Polygon-
and hyphenation. Type, and PolygonVertices commands

See also:
The GetDictionary and GetPMInfo queries. GetPolygonType
Gets the type of the selected polygon.
Reply: nType
GetPMState
Layout view only. The GetPolygonType query
Gets the current PageMaker state.
works only in layout view.
Reply : cState

See Also:
GetPolygonAttribs The GetPolygonMiterLimit, and GetPolygonVerti-
ces queries
Gets the polygon attributes of the currently
The CreatePolygon, PolygonMiterLimit, Polygon-
selected polygons, or the default attributes if no
Type, and PolygonVertices commands
polygons are selected.
Reply: nSides, nStarInset

No polygons selected. If no polygons are selected

GetPolygonVertices
and no publication is open, PageMaker returns the Gets the list of vertices for the selected polygon.
default attributes. If no polygons are selected and a Reply: Count, xLocation, yLocation, ...
publication is open, PageMaker returns the default
polygon attributes for the currently open publi- Each polygon will have a minimum of three points. For
each point:
cation.
xLocation x coordinate of the point

See also: yLocation y coordinate of the point

The Polygon and PolygonAttribs commands

Layout view only. The GetPolygonVertices
query works only in layout view.
GetPolygonMiterLimit
Gets the miter limit for irregular polygons. The See Also:
miter limit must be at least 1. The default value is The GetPolygonMiterLimit and GetPolygonType
1000 which keeps polygons from being clipped off queries
by the miter limit. The CreatePolygon, PolygonMiterLimit, Polygon-
Reply: nMiterLimit Type, and PolygonVertices commands

Layout view only. The GetPolygonMiterLimit

query works only in layout view.
 ADOBE PAGEMAKER 7.0 216
Queries

GetPPDFontLocation sPSFontName GetPrintCaps

Returns the location of the requested font as listed Returns the capabilities for the currently targeted
in the currently selected PPD file. printer and whether the current publication has
publications listed in the book list.
Parameter Values to enter
Reply: bManual, bCustom, bDuplex, bColor,
sPSFontName PostScript name of the font
bBinary, bBook

Reply: cLocation Custom paper size. In general, only imagesetters

support custom paper sizes.
See also:
The GetFontList query See also:
The GetBook, GetPaperSizes, GetPaperSources,
GetPrintColor, GetPrintDoc, GetPrintInk, Get-
GetPreferences PrintOptions, GetPrintOptionsPS, GetPrintPa-
perPS, GetPrintPPDs, GetPrintPS,
Gets miscellaneous preference settings for the GetPrintScreens, and GetPrintTo queries
publication.
Reply: nGreekBelow, cGuides, cGraphics,
bLoose, bKeeps, cSaveOption, bQuotes, GetPrintColor
bNumSnapTo, bAutoflow, bDisplayName, Returns the settings in the Print Color dialog box.
nKBitmap, nKLimit, xHorizNudge, yVert-
Reply: bMode, bColors, bConvert, bOption,
Nudge, cPSMemory
bNegative, bPreserveEPS, sName, nInRipSeps
Measurement units for scripts. PageMaker
Non-PostScript printers. When printing to a non-
returns coordinates using the publication default
PostScript printer, the Mirror and Negative
units, specified in the Preferences dialog box or
options are absent from the Print Color dialog box.
with the MeasureUnits command.
Non-PostScript printers cannot perform these
No publication open. If no publication is open, functions.
PageMaker gets the application default preference
settings.
See also:
Display PPD names. On the Macintosh, the
The GetPaperSizes, GetPaperSources, GetPrint-
Preferences dialog box does not include the Caps, GetPrintDoc, GetPrintInk, GetPrintOp-
Display PPD Names option. Instead, PageMaker tions, GetPrintOptionsPS, GetPrintPaperPS,
for the Macintosh always displays the PPD GetPrintPPDs, GetPrintPS, GetPrintScreens, and
filename, regardless of the value you send for GetPrintTo queries
bDisplayName in the Preferences command. The PrintColors command
Although the bDisplayName parameter does
nothing, the GetPreferences query still returns the
setting sent in the Preferences command. GetPrintDoc
Returns the settings in the Print dialog box.
See also:
Reply : nCopies, bCollate, bReverse, bProof,
The GetFontDrawing, GetMeasureUnits, and Get- sRange, bBlank cPages, bIndependence, bBook,
StoryEditPref queries bBookSpec, bOrientation, bSpreads, bIgnNon-
The GetPreferences command Print
 ADOBE PAGEMAKER 7.0 217
Queries

Ranges. The value of sRange can be a single range GetPrinterResol

(e.g., "1-10") or several ranges (e.g., "1-5, 8-10, 13-
Gets the target printer resolution to be used when
14") separated by commas.
resizing bitmap images using magic stretch.
(Magic stretch resizes a bitmap for optimal
See also: resolution, based on the target printer resolution
The GetPaperSizes, GetPaperSources, GetPrint- and the resolution of the bitmap. To magic-stretch
Caps, GetPrintColor, GetPrintInk, GetPrintOp- an image, hold the Macintosh Command key or
tions, GetPrintOptionsPS, GetPrintPaperPS, the Windows Ctrl key while resizing.)
GetPrintPPDs, GetPrintPS, GetPrintScreens, and
Reply: nDPI
GetPrintTo queries
The PrintDoc command
See also:
The PrinterResol command
GetPrinter
(Windows only) Gets the name of the currently
selected printer, driver, and port. If no printer is GetPrinterStyles
currently selected, gets the default names. Gets the number of currently defined printer styles
Reply: sPrinter, sDriver, sPort and their names.
Reply: nCount[, sPrinterStyle]...
See also: Parameter Reply values
The GetPaperSizes, GetPaperSources, GetPrint-
nCount Number of printer styles
Color, GetPrintDoc, GetPrinterResol, GetPrinter-
Styles, GetPrintFeature, GetPrintFeatureItems, For each printer style:
GetPrintFeatureTitles, GetPrintInk, GetPrintOp-
sPrinterStyle Name of printer style, in quotation marks
tions, GetPrintOptionsPS, GetPrintPaperPS, Get- (maximum of 31 characters)
PrintPPDs, GetPrintPS, GetPrintScreens, and
GetPrintTo queries
Queries to get settings of a printer style. To
determine the settings of a printer style, you must
GetPrinterList apply the style and then use the following queries:

Returns the number of printers listed in the Printer GetPrintColor

option in the Print Document dialog box, and lists GetPrintDoc —(range always set to All)
each printer name. (On the Macintosh, only one
printer is returned. In Windows, several may be GetPrintFeature
returned.) GetPrintFeatureTitles
Reply: nCount(, sName)... GetPrintOptions
GetPrintOptionsPS
See also:
GetPrintPaperPS
The GetPaperSizes, GetPaperSources, GetPrint-
Caps, GetPrintColor, GetPrintDoc, GetPrintInk, GetPrintTo
GetPrintOptions, GetPrintOptionsPS, GetPrint-
PaperPS, GetPrintScreens, and GetPrintTo queries
The PrintTo command
 ADOBE PAGEMAKER 7.0 218
Queries

Example. The following example queries for the GetPrintFeatureItems sTitle

names of all the printer styles and deletes the
Gets the number of options and their names from
printer style Laser Legal.
the specified pop-up menu in the Print Features
getpr interst yles--Reply : 4, "Laser Le gal", "Laser dialog box.
Le tter", "L in o Le g a l ", "L i n o Le tter "
Parameter Value
removep r i n terst y l e "L a ser l eg a l "
sTitle Title of the desired pop-up menu, in quo-
tation marks and exactly as it appears in
See also: Print Features dialog box (maximum of
40 characters)
The GetPrintColor, GetPrintDoc, GetPrinterList,
GetPrintFeature, GetPrintFeatureTitles, GetPrint-
Options, GetPrintOptionsPS, GetPrintPaperPS, Reply: nCount[, sOption]...
GetPrintPPDs, GetPrintPS, GetPrintScreens, and Features vary. Print features vary from printer to
GetPrintTo queries
printer and even from PPD to PPD. It is important
The AddPrinterStyle, PrintColors, PrintDoc, to query for the titles and options before you set
PrinterStyle, PrintOptions, PrintOptionsPS, the print features with the PrintFeature command.
PrintPaperPS, PrintTo, and RemovePrinterStyle
commands
See also:
The GetPrintFeature and GetPrintFeatureTitles
GetPrintFeature sTitle queries
Gets the currently selected option from the The PrintFeature command
specified pop-up menu in the Features print dialog
box.
GetPrintFeatureTitles
Parameter Value
Gets the number of pop-up menus and their titles
sTitle Title of pop-up menu, in quotation marks
for the currently selected PPD in the Features print
and exactly as it appears in Features print
dialog box (maximum of 40 characters) dialog box.
Reply: nCount[, sTitle]...
Reply: sOption
Features vary. Print features vary from printer to
printer and even from PPD to PPD. It is important
See also: to query for the titles and options before you set
The GetPrintFeatureTitles query the print features with the PrintFeature command.
The PrintFeature command
See also:
The GetPrintFeature and GetPrintFeatureItems
queries
The PrintFeature command
 ADOBE PAGEMAKER 7.0 219
Queries

GetPrintInk PrintTo queries

Returns the number of inks listed in the Print The PrintOptions command
Color dialog box, and the name, whether it is
selected for printing, the screen angle, and the
screen ruling for each ink listed.
GetPrintOptionsPS
Returns the settings in the PostScript Print
Reply: nCount(, sName, bPrintInk, sAngle,
Options dialog box.
sRuling)...
Reply: cGraphics, bMarks, bPageInfo,
Ink names returned. PageMaker returns inks in
bSendData, bDownload, bSymbol,
the order in which they appear in the Print Color
bErrHandler, cToDisk, bExtraBleed, bComm
dialog box: the four process colors first, then high-
fidelity inks (if any), followed by any remaining bSymbol and bComm are Macintosh-only.
inks, in alphabetic order. As in the scroll list, bSymbol and bComm only apply to the
PageMaker does not include tints or the colors Macintosh. These options do not appear in the
Black, Paper, and Registration. Print Options dialog box in PageMaker for
Windows, and PageMaker always returns a -2 for
Values returned. PageMaker returns values of
this parameter.
sName, bPrintInk, sAngle, and sRuling for each
ink.
See also:
See also: The GetPaperSizes, GetPaperSources, GetPrint-
Caps, GetPrintColor, GetPrintDoc, GetPrintInk,
The GetPaperSizes, GetPaperSources, GetPrint- GetPrintOptions, GetPrintPaperPS, GetPrintP-
Caps, GetPrintColor, GetPrintDoc, GetPrintOp- PDs, GetPrintPS, GetPrintScreens, and Get-
tions, GetPrintOptionsPS, GetPrintPaperPS, PrintTo queries
GetPrintPPDs, GetPrintPS, GetPrintScreens, and
GetPrintTo queries The PrintOptionsPS command
The PrintInk command
GetPrintPaperPS
GetPrintOptions Returns paper-related print options executed with
the Print command (for PostScript printers only).
Returns the settings in the Print Options dialog
box for a non-PostScript printer. Reply: sSize, sSource, yLength, xWidth,
yPaperFeed, xPaperMargin, bOrientation,
Reply: cScaleType, nVal, cDuplex, bMarks,
bCenter, cTiling, nOverlap, cScaleType, nVal,
bPageInfo, cTiling, xOverlap
cDuplex
Measurement units for scripts. PageMaker
Measurement units for scripts. PageMaker
returns coordinates using the publication default
returns coordinates using the publication default
units, specified in the Preferences dialog box or
units, specified in the Preferences dialog box or
with the MeasureUnits command.
with the MeasureUnits command.

See also:
The GetPaperSizes, GetPaperSources, GetPrint-
Caps, GetPrintColor, GetPrintDoc, GetPrintInk,
GetPrintOptionsPS, GetPrintPaperPS, GetPrintP-
PDs, GetPrintPS, GetPrintScreens, and Get-
 ADOBE PAGEMAKER 7.0 220
Queries

bCenter. PageMaker normally centers the page GetPrintPS

within the page boundaries (bCenter = 0). Since
Returns values that indicate whether the printer is
most printers have symmetrical imageable areas,
PostScript or non-PostScript.
this works fine. You need to use Center Page in
Print Area only when printing to a printer which Reply: bPostScript
has an asymmetrical imageable area (such as the
QMS ColorScript).
See also:
bOrientation. The bOrientation parameter The GetPaperSizes, GetPaperSources, GetPrint-
returns -2 unless the page is a custom page (sSize is Caps, GetPrintColor, GetPrintDoc, GetPrintInk,
set to Custom). GetPrintOptions, GetPrintOptionsPS, GetPrint-
PaperPS, GetPrintPPDs, GetPrintScreens, and
GetPrintTo queries
See also:
The GetPaperSizes, GetPaperSources, GetPrint-
Caps, GetPrintColor, GetPrintDoc, GetPrintInk, GetPrintScreens
GetPrintOptions, GetPrintOptionsPS, GetPrintP-
PDs, GetPrintPS, GetPrintScreens, and Get- Returns the number of optimal screens currently
PrintTo queries available for printing and their names.
The PrintPaperPS command Reply: nCount(, sName)...

Resend query for mode change. The content of

the Optimized Screen option varies according to
GetPrintPPDs
the printing mode (separations or composite). If
Returns the number of PPDs listed in the PPD you change the mode after sending this query,
option in the PostScript Print Document dialog resend the query to get an updated list of available
box, and gets the name of each. screens.
Reply: nCount(, sName)...

Preference setting affects sName reply (Windows See also:

only). If the Display PPD Names option is The GetPaperSizes, GetPaperSources, GetPrint-
checked in the More Preferences dialog box, Caps, GetPrintColor, GetPrintDoc, GetPrintInk,
PageMaker returns the PPD filenames (e.g., GetPrintOptions, GetPrintOptionsPS, GetPrint-
LWNTX_518.PPD). If the option is not checked, PaperPS, GetPrintPPDs, GetPrintPS, and Get-
PageMaker for Windows returns the printer PrintTo queries
"nicknames" (e.g., Apple LaserWriter II NTX The PrintInk command
v51.8).

See also:
GetPrintEPSPreviews
Gets the state for printing EPS previews instead of
The GetPaperSizes, GetPaperSources, GetPrint-
Caps, GetPrintColor, GetPrintDoc, GetPrintInk, a gray box when printing to a non-PostScript
GetPrintOptions, GetPrintOptionsPS, GetPrint- printer.
PaperPS, GetPrintPS, GetPrintScreens, and Get- Reply: bState
PrintTo queries
Layout and Story Editor views only. The
The PrintTo command
GetPrintEPSPreviews query works only in layout
and story editor views.
 ADOBE PAGEMAKER 7.0 221
Queries

See also: GetPrivateData sDeveloperID,

The Print, PrintColors, PrintInk, PrintDeviceInd- sPlugInID, cTargetClass, nTypeFlag,
pntColor, PrintScreenRGBs, and PrintTo com- nTargetID
mands
(Plug-ins and external scripts only) Gets the
The GetPrintColor, GetPrintInk, GetPrintScreen- handle to the buffer containing private data (not a
RGBs. and GetPrintTo queries private string) for the specified graphic, image,
page, master page, story, text block, or publication.
PageMaker retrieves only the private data
GetPrintScreenRGBs associated with the specified developer, plug-in,
Gets the state for printing screen or printer RGB and private ID.
values.
Type Parame- Values to enter
Reply: bState ters

Layout and Story Editor views only. The sDeveloperID Four-character string representing your
name or company name, in quotation
GetPrintScreenRGBs query works only in layout
marks (e.g., ADBE for Adobe)
and story editor views.
sPlugInID Four-character string representing plug-
in, in quotation marks (e.g., KYLN for Key-
See also: line plug-in)

The Print, PrintColors, PrintInk, PrintDeviceInd- cTargetClass classobject for imported graphics and
pntColor, PrintScreenRGBs, PrintEPSPreviews, images, and for PageMaker-drawn lines,
and PrintTo commands boxes, ovals, polygons, or text blocks

The GetPrintColor, GetPrintInk, GetPrintEPSPre- classstory for stories

views, and GetPrintTo queries classpub for publication (current publi-
cation only)

classpage for page

GetPrintTo classmaster for master page
Returns the PostScript printer type and PPD
nTypeFlag Identifier you defined to distinguish
specified in the Print Document dialog box. between types of private data for same
cTargetClass (-1 and -2 are not allowed).
Reply: sName, sPPD
nTargetID Internal PageMaker identifier for element
Parameter order in PrintTo command. The order
(graphic, image, text block, story, page,
of the parameters is reversed in the PrintTo or master page) to which private data is
command. associated

0 (zero) for publication (PageMaker gets

private data for current publication only)
See also:
The GetPaperSizes, GetPaperSources, GetPrint- Reply: nSize, bPlatform, hPrivateData
Caps, GetPrintColor, GetPrintDoc, GetPrintInk,
GetPrintOptions, GetPrintOptionsPS, GetPrint- Translation required: bPlatform. If the publi-
PaperPS, GetPrintPPDs, GetPrintPS, and Get- cation is transferred to a different platform (e.g.,
PrintScreens queries Windows to Macintosh), the plug-in or external
The PrintTo command script is responsible for translating the data to the
byte-order appropriate to the platform.
Errors. PageMaker returns an error if:
 ADOBE PAGEMAKER 7.0 222
Queries

• The specified element has no private data GetPrivateList sDeveloperID,

associated with the specified plug-in and sPlugInID, cTargetClass, nTypeFlag,
nTypeFlag (CQ_NOPDATA). nTargetID
• cTargetClass and nTargetID together do not Lists the type and size of private data and private
specify an existing element (graphic, image, text strings for the specified input criteria. Using -2 for
block, page, master page, story, or publication) parameter values, you can list information about
(CQ_INVALID_TARGET). private data (with increasing granularity) by
• nTypeFlag is -1 or -2 developer; by developer and plug-in; by developer,
(CQ_INVALID_CONTEXT). plug-in, and type of element; and so on.
Five parameters needed to identify data. Parameters Values to enter
PageMaker requires five parameters to identify
sDeveloperID Four-character string representing your
private data: name or company name, in quotation
marks (e.g., ADBE for Adobe)
• sDeveloperID and sPlugInID, to identify the
plug-in. dontcare or -2 to list all private data in pub-
lication
• cTargetClass and nTargetID, to identify the
sPlugInID Four-character string representing plug-in,
element being assigned the data. in quotation marks (e.g., KYLN for Keyline
• nTypeFlag, to distinguish between data types plug-in)

(you define this parameter). dontcare or -2 to list all private data in pub-
lication associated with specified sDevelo-
Free memory. PageMaker allocates a block of perID, or if sDeveloperID is set to dontcare
global memory for the private data. The plug-in or or -2
external script must free the block. cTargetClass classobject for imported graphics and
images, and for PageMaker-drawn lines,
Example. The following example retrieves the
boxes, ovals, polygons, or text blocks
private data associated with the developer ADBE,
classstory for stories
the plug-in KYLN, and the private ID 0, for the
object with ID 15. classpub for publication (current publica-
tion only)
g e t p r iv a te d a t a " A D B E " , " K Y L N " , c l a s s o b j e c t , 0 ,
classpage for page
15
classmaster for master page

dontcare or -2 to list all private data in pub-

See also: lication associated with specified sDevelo-
The GetPrivateList and GetPrivateString queries perID and sPlugInID, or if any previous
parameter is set to dontcare or -2
The DeletePrivateData, PrivateData, and Privat-
eString commands. nTypeFlag Identifier you defined to distinguish
between types of private data for same
cTargetClass (-1 is not allowed)

dontcare or -2 to list all private data in pub-

lication associated with specified sDevelo-
perID, sPlugInID, and cTargetClass, or if any
previous parameter is set to dontcare or -2
 ADOBE PAGEMAKER 7.0 223
Queries

Example. The following example retrieves infor-

Parameters Values to enter
mation about all the private data associated with
nTargetID Internal PageMaker identifier for element the developer ADBE and the plug-in KYLN.
(graphic, image, text block, story, page, or
master page) to which private data is asso- g e t p r iv a te l i s t " A D B E " , " K Y L N " , - 2 , - 2 , - 2
ciated
The following example lists information about all
0 (zero) for publication (PageMaker gets private data in the publication that is associated
private data for current publication only)
with ADBE.
dontcare or -2 to list all private data in pub-
lication associated with specified sDevelo- getpr ivate list "ADBE", dontcare, dontcare,
perID , sPlugInID, cTargetClass, and nType- dontcare, dontcare
Flag, or if any previous parameter is set to
dontcare or -2
See also:
Reply: nCount(, sDeveloperID, sPlugInID,
The GetPrivateData and GetPrivateString queries
cTargetClass, nTypeFlag, nTargetID, bPlatform,
The DeletePrivateData, PrivateData, and Privat-
nSize)...
eString commands
Plug-ins: Errors. PageMaker returns an error if:

• The specified element has no private data

associated with the specified plug-in and
GetPrivateString sDeveloperID,
nTypeFlag (CQ_NOPDATA). sPlugInID, cTargetClass, nTypeFlag,
nTargetID
• cTargetClass and nTargetID together do not
Gets the private string for the specified graphic,
specify an existing element (graphic, image, text
image, page, master page, story, text block, or the
block, page, master page, story, or publication)
current publication. PageMaker retrieves only the
(CQ_INVALID_TARGET).
private string associated with the specified
• nTypeFlag is -1 (CQ_INVALID_CONTEXT). developer, plug-in, and private ID.
• A parameter is -2, but a subsequent parameter
Parameters Values to enter
contains a value (CQ_NOPDATA).
sDeveloperID Four-character string representing your
Five parameters needed to identify data. name or your company name, in quota-
PageMaker requires five parameters to identify tion marks (e.g., ADBE for Adobe)
private data:
sPlugInID Four-character string representing plug-
• sDeveloperID and sPlugInID, to identify the in, in quotation marks (e.g., KYLN for Key-
line plug-in)
plug-in.
cTargetClass classobject for imported graphics and
• cTargetClass and nTargetID, to identify the images, and for PageMaker-drawn lines,
element being assigned the data. boxes, ovals, polygons, and text blocks

• nTypeFlag, to distinguish between data types classstory for stories

(you define this parameter). classpub for publication (current publi-
cation only)
dontcare or -2. If you set any parameter to
dontcare or -2, you must also set all subsequent classpage for page
parameters to dontcare or -2. For example, if you classmaster for master page
set cTargetClass to -2, you must set nTypeFlag and
nTypeFlag Identifier you defined to distinguish
nTargetID to -2. between types of private data for same
cTargetClass (-1 and -2 are not allowed).
 ADOBE PAGEMAKER 7.0 224
Queries

Parameters Values to enter GetPubName

nTargetID Internal PageMaker identifier for element Gets the name of the active publication, including
(graphic, image, text block, page, master its full path.
page, or story) to which private data is
associated Reply: fPubName
0 (zero) for publication (PageMaker gets Unnamed publication. Returns "Untitled - #" if
private string for current publication
only)
the publication has not been named (where "#" is
the number of the untitled publication).
Reply: bPlatform, sPrivateString

Plug-ins: Errors. PageMaker returns an error if:

GetPubWindowRect
• The specified element has no private string Gets the publication-window rectangle, in device
associated with the specified plug-in and coordinates and PageMaker (standard) coordi-
nTypeFlag (CQ_NOPDATA). nates, for the active publication.
• cTargetClass and nTargetID together do not Reply: xLeftDC, yTopDC, xRightDC,
specify an existing element (graphic, image, text yBottomDC, xLeft, yTop, xRight, yBottom
block, page, master page, story, or publication)
(CQ_INVALID_TARGET). Measurement units for scripts. PageMaker
returns PageMaker coordinates using the publi-
• nTypeFlag is -1 or -2
cation default units, specified in the Preferences
(CQ_INVALID_CONTEXT). dialog box or with the MeasureUnits command.
Five parameters needed to identify data.
PageMaker requires five parameters to identify
private data: GetPubWindows [bAllWindows]
• sDeveloperID and sPlugInID, to identify the Gets the number of publication and story windows
plug-in. currently open and their names.
• cTargetClass and nTargetID, to identify the Parameter Values
element being assigned the data.
bAllWindows false or 0 (zero) to return layout window
• nTypeFlag, to distinguish between data types names only (this is the default)
(you define this parameter). true or 1 to return layout and story win-
dow names
Example. The following example gets the private
string for an object with target ID 15 that is
Reply: nNum[, sWindowName]...
associated with the developer ADBE, the plug-in
KYLN, and the private ID 1. Story editor windows have full titles. PageMaker
g e t p r iv a te s t r i n g " A D B E " , " K Y L N " , c l a s s o b j e c t ,
returns the full title of story-editor windows (e.g.,
1, 15
"PubOne:It was a dark and s:1") and lists these first.
Windows only: main window listed. If you set
bAllWindows to true, PageMaker for Windows
See also:
returns the name of the main window (i.e., Adobe
The GetPrivateList and GetPrivateData queries PageMaker 7.0) along with the story and layout
The DeletePrivateData, PrivateData, and Privat- window names.
eString commands
 ADOBE PAGEMAKER 7.0 225
Queries

See also: Default returned with Pointer tool active. If the

The Window command pointer tool is active, PageMaker gets the default
settings.
dWeight ignored. The dWeight parameter is
GetRoundedCorners ignored when cLineStyle is -2.
Gets the corner style of the selected box (drawn in
PageMaker). See also:
Reply: cCornerStyle The GetRuleBelow and GetParaOptions queries
No box selected. If either the text tool or story The RuleAbove and LineStyle commands
editor is active, or if no box is selected or the
selected object is not a box drawn in PageMaker,
PageMaker gets the default corner setting. GetRuleBelow
Gets the state (on or off) and attributes of the Rule
Multiple settings. If multiple objects are selected
Below Paragraph settings applied to the selected
and they have different corner settings, PageMaker
text or to the paragraph containing the insertion
returns -2 for cCornerStyle.
point.
Reply: bOnOff, cLineStyle, sLineColor, cLine-
See also:
Width, xLeftIndent, xRightIndent, dWeight,
The Box and RoundedCorners commands
bOpaque, nLineTint
Measurement units for scripts. PageMaker
GetRuleAbove returns coordinates using the publication default
units, specified in the Preferences dialog box or
Gets the state (on or off) and attributes of the Rule
with the MeasureUnits command.
Above Paragraph settings applied to the selected
text or to the paragraph containing the insertion Defining or editing a style. If you are defining or
point. editing a style using the StyleBegin command,
PageMaker gets the rule attributes for that style
Reply: bOnOff, cLineStyle, sLineColor, cLine-
rather than for the selected text.
Width, xLeftIndent, xRightIndent, dWeight,
bOpaque, nLineTint Multiple settings. If multiple paragraphs are
selected and they have different attributes applied
Measurement units for scripts. PageMaker
to them, PageMaker returns -2 or an empty string
returns coordinates using the publication default
(depending upon the data type) for the parameters
units, specified in the Preferences dialog box or
with conflicting settings.
with the MeasureUnits command.
Pointer tool active. If the pointer tool is active,
Defining or editing a style. If you are defining or
PageMaker gets the default settings.
editing a style using the StyleBegin command,
PageMaker gets the rule attributes for that style dWeight ignored. The dWeight parameter is
rather than for the selected text. ignored when cLineStyle is -2.
Multiple settings. If multiple paragraphs are
selected and they have different attributes applied See also:
to them, PageMaker returns -2 or an empty string The GetRuleAbove, GetRuleOptions, and Get-
(depending upon the data type) for the parameters ParaOptions queries
with conflicting settings. The RuleBelow and LineStyle commands
 ADOBE PAGEMAKER 7.0 226
Queries

GetRuleOptions Reply: bStatus

Gets the settings in the Paragraph Rule Options Alerts always suppressed while running script or
dialog box that are applied to the selected text or to plug-in. PageMaker uses the save status to
the paragraph containing the insertion point. determine if it should display an alert before
closing a publication, thus protecting the user
Reply: nTopOffset, nBottomOffset, bAlign-
from losing changes. However, when running
ToGrid, nGridSize scripts and plug-ins, PageMaker alerts and dialog
Measurement units for scripts. PageMaker boxes are suppressed, regardless of the save status.
returns coordinates using the publication default
units, specified in the Preferences dialog box or See also:
with the MeasureUnits command.
The SaveStatusOff command
Defining or editing a style. If you are defining or
editing a style using the StyleBegin command,
PageMaker gets the offsets and leading grid for that GetScrollbars
style rather than for the selected text.
Gets the setting (on or off) of the Scrollbars.
Multiple settings. If multiple paragraphs are
Reply: bState
selected and they have different attributes applied
to them, PageMaker returns -2 for the parameters
with conflicting settings. See also:
Pointer tool active. If the pointer tool is active, The Scrollbars command
PageMaker gets the default settings.

GetSelectIDList
See also:
Gets the number of objects currently selected and
The GetRuleAbove, GetRuleBelow, and Get- lists each object ID, group ID, drawing number,
ParaOptions queries type, coordinates, and whether the object is linked
The RuleOptions command and transformed. (This query does not return
information about groups; use GetSelectIDListTop
instead.)
GetRulers
Reply: nNumofObj[, nObjectID, nMaskID,
Gets the current state (on or off) of the rulers. nGroupID, nDrawNumber, cTypeOfObject,
Reply: bState bTransformed, bLinked, xLeftOrStart,
yTopOrStart, xRightOrEnd, yBottomOrEnd,
xRightOrStart, yTopOrStart2, xLeftOrEnd,
See also:
yBotOrEnd2]...
The GetGuides, GetHorizGuides, GetLock-
Guides, GetSnapToGuides, GetSnapToRulers, Measurement units for scripts. PageMaker
GetVertGuides, and GetZeroLock queries returns coordinates using the publication default
The Rulers command units, specified in the Preferences dialog box or
with the MeasureUnits command.

GetSaveStatus
Gets the save status of the current publication.
 ADOBE PAGEMAKER 7.0 227
Queries

Coordinates for transformed objects. If the • The location of the weight of horizontal or
selected object was skewed, rotated, or reflected, vertical lines. Currently, no query returns this
the coordinate pairs (xLeftOrStart, yTopOrStart), information.
(xRightOrStart, yTopOrStart2), (xLeftOrEnd, Layout view only. The GetSelectIDList command
yBotOrEnd2), and (xRightOrEnd, yBotto- works only in layout view.
mOrEnd) correspond to the original left-top,
right-top, left-bottom, and right-bottom handles, Example. The following example creates a new
correspond to the original left-top and right- publication, draws and styles two boxes (of
bottom handles, but indicate their new locations. different sizes), skews the second box, and selects
all objects on the page. It queries for the number of
objects currently selected and each object ID,
drawing number, type, and coordinates. Notice
that although these two objects are a different size
and shape, the left-top and right-bottom handles
Coordinates for lines. PageMaker returns the overlap, resulting in the same return values. To get
corners of the bounding box for most objects, but more detailed information about transformed
returns the starting and end points for lines. The objects, use the GetTransform query.
first coordinate pair (xLeftOrStart, yTopOrStart)
corresponds to the starting point of the line. The new

second coordinate pair (xRightOrEnd, yBotto- b ox 0 , 0 , 3 , 1

mOrEnd) corresponds to the end point of the line. li n e s t yle on e p oi n t

The third and fourth coordinate pairs are irrel- fi l l s t y l e n o n e

evant because they duplicate the values of the first b ox 0 , 0 , 2 , 1

two coordinate pairs. linestyle none

fi l l s t y l e s o l i d
skew lefttop, -45
selectall
getselectidlist
- - ex p e c te d rep l y : 2 , 1 , 0 , 1 , 4 , 0 , 0 , 0 , 0 , 3 , 1 , 3 , 0 , 0 , 1 ,
2,0,2,4,1,0,0,0,3,1,2,0,1,1

Where the weight of a line lies in relation to the end See also:
points depends upon the type of line and whether The GetObjectIDList, GetObjectList, GetObject-
the user has flipped the weight of the line with the Loc, GetTransform, and GetLineStyle queries
pointer tool to the other side of the line (horizontal
and vertical lines only). The illustration above
shows the default locations: Horizontal lines hang GetSelectIDListTop
down from the end points; vertical lines hang to
Gets the number of top-level selected objects
the right of the end points; diagonal lines are
(groups and ungrouped objects only) on the
centered.
currently displayed pages and gets the object ID,
This query does not return fields that specify: group ID, drawing number, type, and coordinates
for each object and whether the object is linked
• The type of line (horizontal, vertical, or
and transformed. The query does not return infor-
diagonal). Instead, use the GetTransform query.
mation about objects within a selected group.
• The width of a diagonal line. Instead, use the
GetLineStyle query.
 ADOBE PAGEMAKER 7.0 228
Queries

Reply: nNumObjects[, nObjectID, nMaskID, Coordinates for lines. PageMaker returns the
nGroupID, nDrawNumber, cTypeOfObject, corners of the bounding box for most objects, but
bTransformed, bLinked, xLeftorStart, returns the starting and end points for lines. The
yTopOrStart, xRightOrEnd, yBottomOrEnd, first coordinate pair (xLeftOrStart, yTopOrStart)
xRightOrStart, yTopOrStart2, xLeftOrEnd, corresponds to the starting point of the line. The
yBotOrEnd2]... second coordinate pair (xRightOrEnd, yBotto-
mOrEnd) corresponds to the end point of the line.
Facing pages. In double-sided, facing-pages
The third and fourth coordinate pairs are irrel-
mode, PageMaker returns the object list for both
evant because they duplicate the values of the first
pages.
two coordinate pairs.
Measurement units for scripts. PageMaker
returns coordinates using the publication default
units, specified in the Preferences dialog box or
with the MeasureUnits command.
Coordinates for transformed objects. If the object
was skewed, rotated, or reflected, the coordinate
pairs (xLeftOrStart, yTopOrStart), (xRight-
OrStart, yTopOrStart2), (xLeftOrEnd, Where the weight of a line lies in relation to the end
yBotOrEnd2), and (xRightOrEnd, yBotto- points depends upon the type of line and whether
mOrEnd) correspond to the original left-top, the user has flipped the weight of the line with the
right-top, left-bottom, and right-bottom handles, pointer tool to the other side of the line (horizontal
but indicate their new locations. and vertical lines only). The illustration above
shows the default locations: Horizontal lines hang
down from the end points; vertical lines hang to
the right of the end points; diagonal lines are
centered.
Coordinates for transformed Group. If the group Example. The following example creates a new
was skewed, rotated, or reflected, the coordinate publication, draws and styles two boxes (of
pairs (xLeftOrStart, yTopOrStart), (xRight- different sizes), and skews the second box. It then
OrStart, yTopOrStart2), (xLeftOrEnd, selects both boxes and groups them. It queries for
yBotOrEnd2), and (xRightOrEnd, yBotto- the top-level object. In this case, only the group
mOrEnd) correspond to the group's current left- object is returned. The two boxes are not included
top, right-top, left-bottom, and right-bottom since they are part of the group.
handles. new
b ox 0 , 0 , 3 , 1
li n e s t yle on e p oi n t
fi l l s t y l e n o n e
b ox 0 , 0 , 2 , 1
linestyle none
fi l l s t y l e s o l i d
skew lefttop, -45
selectall
g rou p
g e t s e l e c t i d l i s t to p
- - ex p e c te d rep l y : 1 , 3 , 0 , 1 , 1 4 , 0 , 0 , 0 , 0 , 3 , 1 , 3 , 0 , 0 , 1
 ADOBE PAGEMAKER 7.0 229
Queries

See also: GetSelectList

The GetObjectList, GetObjectLoc, GetSelectList, Gets the number of objects currently selected and
GetSelectIDList, GetTransform, GetLineStyle, lists each object's drawing number, type, and
GetGroupList, and GetObjectIDListTop queries
coordinates.
Reply: nNumObjects[, nDrawNumber, cTypeO-
GetSelectInfo fObject, xLeftOrStart, yTopOrStart, xRightOrEnd,
yBottomOrEnd]...
Gets the coordinates of the bounding box that
encompasses the selected objects. Measurement units for scripts. PageMaker
returns coordinates using the publication default
units, specified in the Preferences dialog box or
with the MeasureUnits command.
Coordinates for transformed objects. If the
Reply: xLeft, yTop, xRight, yBottom selected object was skewed, rotated, or reflected,
Measurement units for scripts. PageMaker the coordinate pairs (xLeftOrStart, yTopOrStart)
returns coordinates using the publication default and (xRightOrEnd, yBottomOrEnd) correspond
units, specified in the Preferences dialog box or to the original left-top and right-bottom handles,
with the MeasureUnits command. but indicate their new locations.

No objects selected. PageMaker returns an error

if no objects are selected.
Example. This example creates a new publication,
draws a box, and queries for the coordinates of the Coordinates for lines. PageMaker returns the
bounding box. It rotates the box and again queries corners of the bounding box for most objects, but
for the coordinates of the bounding box. Finally, it returns the starting and end points for lines. The
draws another box, selects both, and queries for first coordinates (xLeftOrStart, yTopOrStart)
the coordinates of the bounding box that encom- correspond to the starting point of the line. The
passes both boxes. second coordinates (xRightOrEnd, yBotto-
new mOrEnd) correspond to the end point of the line.
b ox 0 , 0 , 1 , 1
getselectinfo
- - exp e c te d rep l y 0 , 0 , 1 , 1
rotate center 45
getselectinfo
- - ex p e c te d rep l y - 0 . 2 0 7 , - 0 . 2 0 7 , 1 . 2 0 7 , 1 . 2 0 7
b ox 7 , 7 , 8 , 8
selectall
getselectinfo
- - ex p e c te d rep l y - 0 . 2 0 7 , - 0 . 2 0 7 , 8 , 8

See also:
The GetObjectList, GetObjectLoc, GetTransform,
and GetSelectList queries
 ADOBE PAGEMAKER 7.0 230
Queries

Where the weight of a line lies in relation to the end See also:
points depends upon the type of line and whether The ShowErrorAlert command
the user has flipped the weight of the line with the
pointer tool to the other side of the line (horizontal
and vertical lines only). The illustration above GetSize
shows the default locations: Horizontal lines hang
Gets the point size applied to the selected text.
down from the end points; vertical lines hang to
the right of the end points; diagonal lines are Reply: dPointSize
centered.
Defining or editing a style. If you are defining or
This query does not return fields that specify: editing a style using the StyleBegin command,
PageMaker gets the point size for that style rather
• The type of line (horizontal, vertical, or
than for the selected text.
diagonal). Instead, use the GetTransform query.
No insertion point. If the text does not contain the
• The width of a diagonal line. Instead, use the
insertion point, PageMaker gets the default point
GetLineStyle query.
size.
• The location of the weight of horizontal or
No text selected. If the text contains the insertion
vertical lines. Currently, no query returns this
point but no text is selected, PageMaker returns the
information.
point size of the character preceding the insertion
point. If the insertion point is before the first
See also: character of the story, PageMaker returns the point
The GetObjectList, GetObjectIDList, GetObject- size of the first character.
Loc, GetSelectIDList, GetTransform, and GetLine-
Style queries
See also:
The Size command
GetShowErrorAlert
Gets the display state of error alerts, which are
GetSnapToGuides
normally suppressed when a plug-in or script is
running. Gets the current setting (on or off) of the Snap to
Guides command.
Reply: bState
Reply: bState
Caution: Always turn off error alerts. If you
enable the display of error alerts, always turn them
off before your plug-in or script finishes. See also:
Otherwise, PageMaker could display them while The GetGuides, GetHorizGuides, GetLock-
another plug-in or script is running. The ShowEr- Guides, GetRulers, GetSnapToRulers, GetVert-
rorAlert command has no menu equivalent; you Guides, and GetZeroLock queries
must turn off the error alerts using this command. The SnapToGuides command
Example. The following command line turns off
error alerts so they don't display when a plug-in or
script is running.
GetSnapToRulers
Gets the current setting (on or off) for the Snap to
shower ror aler t false
Rulers command.
Reply: bState
 ADOBE PAGEMAKER 7.0 231
Queries

See also: Story editor only. The GetSpellResult query

The GetGuides, GetHorizGuides, GetLock- works only in story editor.
Guides, GetRulers, GetSnapToGuides, GetSnap- Example. The following example creates a new
ToRulers, GetVertGuides, and GetZeroLock story, switches to story editor, begins search for
queries misspelled words, queries for the first misspelled
The SnapToRulers command word, continues spell-checking, and queries for
next misspelled word.
newstor y 6i, 4i --create new stor y
GetSpaceOptions
textenter "Hte tango beat capture d Ze lda's
Gets some of the attributes in the Paragraph hear t." --enter text
Spacing Attributes dialog box applied to the editstor y--sw itch to stor y editor
selected text or to the paragraph containing the s p e l l - - b e g i n s p e l l che c k u s i n g d e f a u l t s e t t i n g s
insertion point. The attributes it returns are: g e t s p e l l re s u l t - - q u e r y f o r m i s s p e l l e d word
• Pair Kerning state (on or off) - - ex p e c te d rep l y : " H te "
s p e l l - - co n t i nu e s p e l l che c k
• Point size above which pair kerning should be
g e t s p e l l re s u l t - - q u e r y f o r n ex t m i s s p e l l e d word
active
- - ex p e c te d res u l t : " Ze l d a "
• Leading method
• Autoleading percentage See also:
Reply: bAutoKerning, dPtThreshold, cLeading, The GetPMInfo, GetSpellResult, and GetSpell-
dAutoleading Window queries
Defining or editing a style. If you are defining or The AddWord, RemoveWord, Spell, and Spell-
editing a style using the StyleBegin command, Window commands
PageMaker gets the settings for that style rather
than for the selected text.
GetSpellWindow
Pointer tool active. If the pointer tool is active,
Gets the display status (open or closed) of the
PageMaker gets the default settings.
Spelling dialog box.
Multiple leading methods. If multiple paragraphs
Reply: bOpen
are selected and they have different settings applied
to them, PageMaker returns -2 for parameters with Story editor only. The GetSpellWindow query
conflicting settings. works only in story editor.
Example. The following example opens the
See also: Spelling dialog box and then queries for its status.
The GetWordSpace and GetLetterSpace queries editstor y
The SpaceOptions command s p e l lw i n d ow o p e n
g e t s p e l lw i n d ow
- - ex p e c te d rep l y : 1
GetSpellResult
Gets the misspelled word found by the last Spell See also:
command.
The GetPMInfo, GetSpellResult, and GetSpell-
Reply: sWord Window queries
The AddWord, RemoveWord, Spell, and Spell-
 ADOBE PAGEMAKER 7.0 232
Queries

Window commands • The full filename, if it is linked

• The number of characters in the story (both
printing and nonprinting)
GetStoryEditPref
• The number of text blocks that comprise the
Gets the story editor display preferences.
story
Reply: bDisplayPara, bDisplayStyle, dSize, sFont
• The page number of each text block
• The bounding rectangle of each text block
See also:
• The number of PageMaker characters in the text
The StoryEditPref command
block
Reply: nNumStories[, nStoryID, fFilename,
GetStoryID nNumChars, nNumTxtBlock[, nPageNumber,
xLeftTop, yLeftTop, xRightBottom, yRightBottom,
Gets the story ID of the selected text block.
nNumChars]...]...
Reply: nStoryID
Measurement units for scripts. PageMaker
Single text block only; no highlighted text. returns coordinates using the publication default
PageMaker returns an error if: units, specified in the Preferences dialog box or
with the MeasureUnits command.
• More than one text block is selected.
Coordinates for transformed text blocks. If the
• No text blocks are selected.
selected text block was skewed, rotated, or
• A text block plus any other object are selected. reflected, the coordinate pairs (xLeftTop,
• Text is highlighted. yLeftTop) and (xRightBottom, yRightBottom)
correspond to the original left-top and right-
• The text tool is active.
bottom handles, but indicate their new locations.
To get the story ID of highlighted text, use the
GetTextRun query.
Example. The following example selects the third
object drawn and queries for its story ID.
select 3 See also:
getstor y id
The GetLinkInfo, GetLinks, and GetStoryID, Get-
- - ex p e c te d rep l y : 1 StoryList, and GetStoryText queries

See also:
GetStoryList
The GetStoryIDList, GetStoryList, GetStoryText
and GetTextRun queries Gets the number of stories in the publication and,
for each story:
• The full filename if it is linked
GetStoryIDList
• The number of characters in the story (both
Returns the number of stories in the publication
printing and nonprinting)
and, for each story:
• The number of text blocks that comprise the
• The story's unique PageMaker identifier story
 ADOBE PAGEMAKER 7.0 233
Queries

• The page number of each text block Parameter Values to enter

• The bounding rectangle of each text block nFormat 0 to keep all nonprinting characters
• The number of characters in the text block 1 to delete all nonprinting characters
Reply: nNumStories[, fFilename, nNumChars, 2 to replace all nonprinting characters
nNumOfTxtBlock[, nPageNumber, xLeftTop, with spaces
yLeftTop, xRightBottom, yRightBottom, 3 to substitute all nonprinting ASCII char-
nNumChars]...]... acters as text export filter does (see
"Translation table" below).
Measurement units for scripts. PageMaker
returns coordinates using the publication default Reply: sText
units, specified in the Preferences dialog box or
Pointer versus text tool. If a text block is selected
with the MeasureUnits command.
using the pointer tool or the Select command,
Coordinates for transformed text block. If the PageMaker returns the whole story, even when the
selected text block was skewed, rotated, or text block contains only a portion of the story. If a
reflected, the coordinate pairs (xLeftTop, range of text has been highlighted using the text
yLeftTop) and (xRightBottom, yRightBottom) tool or the TextSelect command, PageMaker
correspond to the original left-top and right- returns only the selected text.
bottom handles, but indicate their new locations.
Selecting several lines. Be careful not to select too
much text; this query can return a large amount of
data. If your plug-in, rather than PageMaker,
allocates the reply buffer but doesn't make it large
enough, the query will fail.
See also: 64K query return limit for Windows. In
The GetLinkInfo, GetLinks, GetStoryID, GetSto- PageMaker for Windows, the return from a query
ryIDList, and GetStoryText queries is limited to 64K.
nFormat. nFormat is used only if nType is 0 (zero)
or 1 (one).
GetStoryText nType, nFormat
Gets the highlighted text (or entire story if text Windows only. PageMaker for Windows treats the
block is selected) and returns it in the specified following characters as nonprinting characters:
format. • All printer quotes (open, closed, double, single)
Parameter Values to enter • Em dash
nType 0 for raw text • En dash
1 for tagged text (paragraph style name • No-break slash
is added to beginning of each para-
graph) • No-break dash
2 for rich text format (RTF) Translation table. The following translation table
shows the hexadecimal value that PageMaker uses
to substitute nonprinting characters when
nFormat equals 3.
 ADOBE PAGEMAKER 7.0 234
Queries

See also: The queries required to obtain all of a style's

The GetStoryID, GetStoryIDList, and GetStoryL- attributes are:
ist queries GetAlignmentGetRuleAbove
GetBasedOnGetRuleBelow
GetStyle GetCaseGetRuleOptions
Gets the style applied to the selected text or to the
GetColorGetSpaceOptions
paragraph containing the insertion point. If
nothing is selected, gets the default style. GetDictionaryGetSize

Reply: sStyle GetFontGetTabs

Defining or editing a style. If you are defining or GetHyphenationGetTint
editing a style using the StyleBegin command,
GetIndentsGetTrack
PageMaker gets the name of that style rather than
the style for the selected text. GetLeadingGetTypePosition
Empty string. PageMaker returns an empty string GetLetterSpaceGetTypeOptions
for sStyle, if:
GetNextStyleGetTypeStyle
• More than one paragraph is selected and they
GetParaOptionsGetWidth
have different styles applied to them
• The style is set to No Style
GetParaSpaceGetWordSpace

Pointer and text tool. If the pointer tool is active,

PageMaker gets the default style for the publi- See also:
cation. If the text tool is active but no text is The GetStyleNames and GetStylePalette queries
selected, PageMaker gets the style for the The Style, StyleBegin, and StyleEnd commands
paragraph containing the insertion point.
Getting style attributes. Because PageMaker does
not include a query that returns a style definition, GetStyleNames
you must query for each attribute individually. To Gets the number of styles defined in the publi-
specify the name of the desired style, use the Style- cation and their names.
Begin and StyleEnd pair and place the queries
Reply: nNumOfStyles[, sStyle]...
between these commands. For example:
Getting style attributes. Because the scripting
stylebegin "para"
language does not include a query that returns a
ge tfont
style definition, you must query for each attribute
g e t s i ze
individually. To specify the name of the desired
getleading
style, use the StyleBegin and StyleEnd pair and
getalig nment
place the queries between these commands. For
getindents
example:
styleend
stylebegin "para"
As shown, you must close the style definition ge tfont
with the StyleEnd command (even though you g e t s i ze
are not actually defining or editing the style). getleading
getalig nment
 ADOBE PAGEMAKER 7.0 235
Queries

getindents GetSuppressAutosave
styleend
Gets the status (suppressed or activated) of the
automatic mini-save feature.
As shown, you must close the style definition
with the StyleEnd command (even though you Reply : bSuppress
are not actually defining or editing the style). When mini-saves occur. PageMaker performs a
The queries required to obtain all the attributes of mini-save if you have changed your publication
a style are: and you:

GetAlignmentGetRuleAbove • Print.

GetBasedOnGetRuleBelow • Copy, insert, or delete a page.

GetCaseGetRuleOptions • Switch between the story and layout views.

• Move to another page.
GetColorGetSpaceOptions
• Click the current page icon.
GetDictionaryGetSize
• Change page setup.
GetFontGetTabs
• Switch from the Find, Change, or Spelling dialog
GetHyphenationGetTint box back to a story.
GetIndentsGetTrack • Switch between stories in story editor.
GetLeadingGetTypePosition Caution: Always turn off SuppressAutosave when
plug-in or script finishes. Always turn off the
GetLetterSpaceGetTypeOptions SuppressAutosave command before returning
GetNextStyleGetTypeStyle control back to PageMaker. This command has no
menu equivalent, so you must use it again to
GetParaOptionsGetWidth reactive mini-saves. (The automatic mini-save
GetParaSpaceGetWordSpace feature is a safeguard and allows you to recover
previous work by using the Revert command or by
pressing the Option key while selecting File >
See also:
Revert.)
The GetStyle and GetStylePalette queries
Example. The following example queries for the
The Style, StyleBegin, and StyleEnd commands
status of mini-saves.
getsuppressautosave
GetStylePalette
Gets the state (on or off) of the Styles palette. See also:
Reply: bState The MiniSave and SuppressAutosave commands

See also:
The GetStyle and GetStyleNames queries
The StylePalette command
 ADOBE PAGEMAKER 7.0 236
Queries

GetSuppressPalDraw cPalette User-defined tabs only. The Indents/Tabs ruler

has predefined tab settings every 0.5 inch or 3 picas
Gets the update status of the specified palette.
(marked by small triangles), which are displaced
Parameter Values to enter by tab positions you specify. The GetTabs query
returns only user-defined tab positions, not the
cPalette stylepalette or 1 for the Style palette
predefined tab settings. If nCount is zero, the ruler
colorpalette or 2 for the Color palette
has no user-defined tab positions, but it still has
controlpalette or 3 for the Control Pal- the predefined positions every 0.5 inches.
ette
Multiple tab settings. If multiple paragraphs are
masterpagepalette or 4 for Master Page
palette selected and they have different tab settings,
PageMaker returns the tab settings for the first
Reply: bState
paragraph.
Story editor active, text tool not selected, or no
publication. If story editor is active, or if in layout
See also:
view but a tool other than the text tool is active,
The SuppressPalDraw command PageMaker gets the default tab settings of the
current publication. If no publication is open,
PageMaker gets the PageMaker application default
GetSuppressPrin obsolete query; see settings.
GetNonPrinting
To match the command name on the menu, this
See also:
query has been renamed to GetNonPrinting.
The GetIndents query
The Tabs command
GetTabs
Gets the number of user-defined tab positions in
the selected text and lists the position, kind, and
GetTargetLayer
leader string for each tab. Gets the name of the target layer in a publication.

Reply: nCount[, cKind, xPosition, sLeader]... Reply: sLayerName

Measurement units for scripts. PageMaker

returns coordinates using the publication default See Also:
units, specified in the Preferences dialog box or The GetLayerList, GetLayerOptions, and GetPas-
with the MeasureUnits command. teRemembers queries
Defining or editing a style. If you are defining or The AssignLayer, DeleteLayer, DeleteUnusedLay-
editing a style using the StyleBegin command, ers, LayerOptions, LockLayers, MoveLayer, New-
Layer, PasteRemembers, SelectLayer, ShowLayers,
PageMaker gets the tab settings for that style rather
and TargetLayer commands
than for the selected text.
 ADOBE PAGEMAKER 7.0 237
Queries

GetTextBound obsolete query; see GetTextLocation

GetTextLocation Gets the object ID of the text block containing the
The GetTextBounds command did not return all highlighted text, as well as the coordinates that
the coordinates of a selection nor were the coordi- define the boundaries of the highlighting.
nates correct if the text had been transformed. Use
GetTextLocation instead.

GetTextCursor
Returns the PageMaker internal ID for the story
containing the insertion point, and gets the
Reply: nObjectID, xAnchorBottom, yAnchor-
starting and ending position of the selected text (or
Bottom, xAnchorTop, yAnchorTop, xRightTop,
the location of the insertion point if no text is
yRightTop, xRightBottom, yRightBottom,
selected).
xRangeEndTop, yRangeEndTop, xRangeEnd-
Reply: nStoryID, nBegin, nEnd Bottom, yRangeEndBottom, xLeftBottom, yLeft-
No text selected. If no text is selected (but the text Bottom, xLeftTop, yLeftTop
contains an insertion point), then nBegin and Parameter Reply values
nEnd are the same. However, if the story is empty,
nObjectID Object ID of text block containing
nStoryID, nBegin, and nEnd are null. PageMaker highlighted text
does not recognize a story unless it contains at least
one character. xAnchorBottom x coordinate of AnchorBottom (see
illustration above)
Selection direction is irrelevant. The direction in
yAnchorBottom y coordinate of AnchorBottom (see
which the cursor was dragged to select text is irrel- illustration above)
evant. The value of nBegin is always smaller than
xAnchorTop x coordinate of AnchorTop (see illus-
or equal to nEnd.
tration above)
nonprinting characters included. The values for
yAnchorTop y coordinate of AnchorTop (see illus-
nBegin and nEnd include inline graphics and tration above)
nonprinting characters (such as index markers,
xRightTop x coordinate of right top edge of
tabs, and returns). selection

yRightTop y coordinate of right top edge of

See also: selection
The GetTextCursor query xRightBottom x coordinate of right bottom edge of
The TextSelect command selection

yRightBottom y coordinate of right bottom edge of

selection

xRangeEndTop x coordinate of RangeEndTop (see

illustration above)

yRangeEndTop y coordinate of RangeEndTop (see

illustration above)

xRangeEndBottom x coordinate of RangeEndBottom

(see illustration above)
 ADOBE PAGEMAKER 7.0 238
Queries

GetTextLocation replaces GetTextBounds . The

Parameter Reply values
GetTextBounds command is obsolete. It did not
yRangeEndBottom y coordinate of RangeEndBottom return all the coordinates of a selection nor were
(see illustration above)
the coordinates correct if the text had been trans-
xLeftBottom x coordinate of left bottom edge of formed.
selection

yLeftBottom y coordinate of left bottom edge of

See also:
selection
The GetTextCursor, GetSelectIDList, and GetOb-
xLeftTop x coordinate of left top edge of selec-
jectIDList queries
tion
The TextSelect, TextCursor, SetTextCursor, and
yLeftTop y coordinate of left top edge of selec- SelectID commands
tion

Measurement units for scripts. PageMaker

returns coordinates using the publication default
GetTextRun nRunStyle
units, specified in the Preferences dialog box or Returns the location of text changes and the reason
with the MeasureUnits command. for each change (e.g., text or paragraph attribute,
line break, tab ruler settings).
Double-clicked ranges. Regardless of the initial
position of the insertion point, when you select a Parameter Values
word by double-clicking, the anchor point is nRunStyle Indicates the criteria to use to determine
before the first character of the word. The ending a change in the text. Criteria are:
point is after the trailing space or, if the word is not 1 for change in text or paragraph
followed by a space, the range ends after the last attributes (e.g., font, size, space after
character of the word. paragraph, page break before para-
graph, inline graphic)
Triple-clicked ranges. When you select a
2 for line break (PageMaker line break,
paragraph by triple-clicking, the anchor point is soft or hard line breaks, unplaced text)
before the beginning of the first line of the
4 for change in tab ruler settings
paragraph (before any indents) and the range ends
at the beginning of the line below the paragraph.
Reply: nStoryID, nBegin, nEnd, nReason
Location of insertion point. You can use GetText-
nRunStyle and nReason additive. The values for
Location to get the location of the insertion point
nRunStyle and nReason are additive. For example,
when no text is selected. However, the story must
to get the location of a change in the text in either
contain at least one character. PageMaker does not
the tab ruler or text or paragraph attributes, specify
recognize an empty story.
3 for nRunStyle (1+2):
Plug-ins: Errors. PageMaker returns
g e t text r u n 3
CQ_INVALID_STATE when either:
In the same way, if the location marks a change of
• PageMaker is in story editor, text is not selected, more than one type, PageMaker sets nReason to
or the insertion point is not in a text block. the sum of those types.
• Highlighted text spans multiple text blocks. No changes: text selected. If PageMaker finds no
• Highlighted text is not on the current page changes in selected text, it returns the ending
(which can happen using a script or plug-in, but position of the selected text for nEnd and zero for
never while using PageMaker directly). nReason.
 ADOBE PAGEMAKER 7.0 239
Queries

No changes: no text selected. If no text is selected GetTextWrapPoly

and PageMaker finds no changes between the
Gets the number of points in the text-wrap
insertion point and the end of the story, it returns
polygon for the selected object and their coordi-
the end of the story for nEnd and zero for nReason.
nates.
Example. This example creates a new publication
Reply: nPoints[, xLocation, yLocation]...
and inserts two lines of text. It queries for the
location of the first line break. PageMaker returns Order of coordinates. PageMaker returns coordi-
the location after the question mark (the 35th nates in clockwise order, starting from the upper
character). left. First and last points do not repeat.
new Measurement units for scripts. PageMaker
newstor y 1,1 returns coordinates using the publication default
textenter "How does the gettext r un quer y wor k? units, specified in the Preferences dialog box or
Le t ' s s e e " with the MeasureUnits command.
textcursor -stor y
Zero returned for rectangular text wrap.
-- send quer y to locate first line break (2)
PageMaker does not recognize a rectangle as a text-
g e t text r u n 2
wrap polygon. If a rectangular text wrap has been
- - exp e c te d rep l y : 1 , 0 , 3 5 , 2
specified (that is, the second icon in the first line of
the Text Wrap dialog box is highlighted),
PageMaker returns a zero for this query.
GetTextWrap
Gets the settings of the text-wrap options applied
See also:
to the currently selected object.
The GetTextWrap query
Reply: cWrapOption, cTextFlow, xLeftSO,
The TextWrap and TextWrapPoly commands
yTopSO, xRightSO, yBottomSO, cLayerWrap
Standoffs. Standoffs are only meaningful when
cWrapOption is rectangular. GetTint
Multiple wrap attributes. If multiple objects are Gets the tint value applied to the highlighted text
selected and they have different wrap attributes or selected graphics or, if nothing is selected, gets
applied to them, PageMaker returns -2 for cWrap- the default tint value.
Option. In such cases, the standoff coordinates Reply: nTintValue
may not be valid.
Text tool active. If the text tool is active, See also:
PageMaker gets the default text-wrap settings.
The GetColor, GetColorInfo, GetColorNames,
Measurement units for scripts. PageMaker and GetColorPalette queries
returns measurements using the publication The Color, ColorPalette, DefineColor, and TintSe-
default units, specified in the Preferences dialog lection commands
box or with the MeasureUnits command.

See also: GetTOCIndexID

The GetTextWrapPoly query Gets the story ID of both the table of contents and
index stories in the current publication.
The TextWrap and TextWrapPoly commands
Reply: nTOCID, nIndexID
 ADOBE PAGEMAKER 7.0 240
Queries

Check book list. Large books are generally broken GetToolbox

into several publications. To locate the table of
Gets the setting (on or off) of the Tools palette.
contents and index, you may need to query the
main publication for the book list and then query Reply: bState
each publication listed for the table of contents and
index. Generally the first publication in a book list
See also:
contains the table of contents and the last publi-
cation contains the index. The Toolbox command

A publication can contain only one table of

contents and one index. However, each publi- GetTrack
cation in a book list may contain its own table of
Gets the Track setting applied to the selected text.
contents and index.
Reply: cTrackName
Not valid for PageMaker 5.0 or earlier. This query
works only with PageMaker 5.0a (or later) for the Defining or editing a style. If you are defining or
Macintosh and PageMaker 5.x (or later) for editing a style using the StyleBegin command,
Windows. Always check the return from PageMaker gets the tracking attributes for that
GetTOCIndexID. If GetTOCIndexID returns style rather than for the selected text.
RC_CQ_BAD_CMD, the PageMaker version is Multiple settings. If multiple characters are
earlier than 5.0a so PageMaker does not recognize selected and they have different tracking attributes,
this query. PageMaker returns -2 for cTrackName.
No insertion point. If the text does not contain the
See also: insertion point, PageMaker gets the default track
The GetBook query settings.
No text selected. If the text contains the insertion
point but no text is selected, PageMaker returns the
GetTool
track settings of the character preceding the
Gets the currently selected tool in the Tools palette. insertion point. If the insertion point is before the
Reply : cTool first character of the story, PageMaker returns the
track settings of the first character.
Layout view only. The GetTool query works only
in layout view.
See also:
Example. The following example selects the oval
The GetWordSpace and GetLetterSpace queries
tool in the Tool palette and queries for the active
tool. The Track command

to o l ov a l
gettool--reply : 3 GetTransform
Returns transformation information on a selected
See also: object.
The Tool command
 ADOBE PAGEMAKER 7.0 241
Queries

Reply: dRotateAngle, dSkewAngle, bReflect, Defining and editing a style. If you are defining or
xLeftTopOrig, yLeftTopOrig, xRightBotOrig, editing a style using the StyleBegin command,
yRightBotOrig, xLeftTop, yLeftTop, xRightTop, PageMaker gets the settings for the style, not the
yRightTop, xRightBottom, yRightBottom, xLeft- selected text.
Bottom, yLeftBottom
Multiple settings. If multiple characters are
Lines. PageMaker returns the angle of a line selected and they have different settings,
relative to the x axis, not to its original angle. For PageMaker returns -2 for parameters with
example, if you draw a 45-degree line and rotate it conflicting settings.
to 90 degrees, PageMaker returns 90 for
No insertion point. If the text does not contain the
dSkewAngle.
insertion point, PageMaker gets the default type
Measurement units for scripts. PageMaker options.
returns coordinates using the publication default
No text selected. If the text contains the insertion
units, specified in the Preferences dialog box or
point but no text is selected, PageMaker returns the
with the MeasureUnits command.
type options of the character preceding the
insertion point. If the insertion point is before the
See also: first character of the story, PageMaker returns the
The Reflect, Rotate, and Skew commands type options of the first character.

See also:
GetTrapSettings The GetTypePosition query
Gets the main settings that determine how The TypeOptions command
PageMaker traps overlapping elements in a publi-
cation (from the Trapping Preferences dialog box).
Reply: bEnable, xDefWidth, xBlackWidth, GetTypePosition
dStepLimit, dCentThresh, dTextLimit, Gets the text position (normal, superscript, or
bTrapOverImp subscript) applied to the selected text.
Measurement units for scripts. PageMaker Reply: cPosition
returns coordinates using the publication default
Defining or editing a style. If you are defining or
units, specified in the Preferences dialog box or
editing a style using the StyleBegin command,
with the MeasureUnits command.
PageMaker gets the position settings for that style
rather than for the selected text.
See also:
No insertion point. If the text does not contain the
The GetBlackAttributes query insertion point, PageMaker gets the default type
The BlackAttributes and TrapSettings commands position.
No text selected. If the text contains the insertion
GetTypeOptions point but no text is selected, PageMaker returns the
type position of the character preceding the
Gets the settings in the Type Preferences dialog box insertion point. If the insertion point is before the
for the selected text. first character of the story, PageMaker returns the
Reply: nSmallCapSize, nSuperSubSize, type position of the first character.
nSuperPos, nSubPos, dBaseline, bDirection
 ADOBE PAGEMAKER 7.0 242
Queries

Multiple settings. If multiple characters are Defining and editing a style. If you are defining or
selected and they have different settings, editing a style using the StyleBegin command,
PageMaker returns -2 for cPosition. PageMaker gets the type style for that style
definition rather than for the selected text.
See also: No insertion point. If the text does not contain the
The GetTypeOptions query insertion point, PageMaker gets the default type
style.
The Position command
No text selected. If the text contains the insertion
point but no text is selected, PageMaker returns the
GetTypeStyle type style of the character preceding the insertion
Gets the type style of the highlighted text. point. If the insertion point is before the first
character of the story, PageMaker returns the type
Reply: nMask, nApplied style of the first character.
nMask and nApplied. The text within a Finding and changing type styles. If you are
highlighted range often has a number of different using the GetTypeStyle query in conjunction with
type styles applied to it. This query returns a ChangeTypeAttr1, FindTypeAttr1,
mask/applied pair to indicate which type styles it GetChangeTypeAttr1, or GetFindTypeAttr1, note
can provide information about (those applied or that the GetTypeStyle query returns different
not applied uniformly across the selection) and values for the type styles. With the exception of
which of those styles are actually applied to the normal, all the GetTypeStyle values are twice the
text. The type styles not included in nMask are values used in the find and change commands and
styles that are applied to some, but not all, the queries. For example, bold is 2 for GetTypeStyle
characters. and 1 for ChangeTypeAttr1, FindTypeAttr1,
For example, if all of the selected text has the same GetChangeTypeAttr1, and GetFindTypeAttr1.
type styles applied to it (something other than Normal, however, is 1 in GetTypeStyle and 0 in the
Normal), nMask equals 254 (the total of all the other commands and queries.
settings except Normal). nApplied would indicate
which type styles were actually applied to the text. See also:
Using another example, if nMask equals 14 (the The GetChangeTypeAttr1 and GetFindTypeAttr1
sum of the Bold, Italic, and Underline values), then queries
the only styles PageMaker can provide information The ChangeTypeAttr1, FindTypeAttr1, and Type-
about are Bold, Italic, and Underline. Since the Style commands
mask values of Strikethru, Outline, Shadow, and
Reverse are not included in the sum, some of the
text may have these attributes applied to it, and GetVertGuides
some may not. Gets the number of vertical ruler guides and their
If nApplied for this same text equals 6 (the sum of positions.
the Bold and Italic values), all of the selected text Reply: nNumber[, xPosition]...
has Bold and Italic applied to it and none of the
text has Underline applied. Measurement units for scripts. PageMaker
returns coordinates using the publication default
units, specified in the Preferences dialog box or
with the MeasureUnits command.
 ADOBE PAGEMAKER 7.0 243
Queries

Order guides returned. PageMaker returns See also:

vertical guides in the order in which they were The SetWidth command
created.

See also: GetWordSpace

The GetGuides, GetHorizGuides, GetLock- Gets the Word Space setting applied to the
Guides, GetRulers, GetSnapToGuides, GetSnap- highlighted text or to the paragraph containing
ToRulers, and GetZeroLock queries the insertion point.
The GuideVert command
Reply: dWordMin, dWordDesired,
dWordMax

GetView Defining and editing styles. If you are defining

or editing a style using the StyleBegin command,
Gets the size of the current page display.
PageMaker gets the Word Space settings for that
Reply: nPageView style rather than for the selected text.
Multiple settings. If multiple paragraphs are
See also: selected and they have different spacing
The View command attributes, PageMaker returns -2 for parameters
with conflicting values.
Pointer tool active. If the pointer tool is active,
GetWidth PageMaker gets the default Word Space settings.
Gets the Horizontal Scale setting applied to the
highlighted text.
See also:
Reply: dWidth The GetLetterSpace and GetTrack queries
Defining and editing styles. If you are defining The WordSpace command
or editing a style using the StyleBegin command,
PageMaker gets the Horizontal Scale setting for
that style rather than for the selected text. GetZeroLock
Multiple settings. If multiple characters are Gets the current setting of the Zero Lock
selected and they have different widths applied command.
to them, PageMaker returns -2 for dWidth. Reply: bState
No insertion point. If the text does not contain
the insertion point, PageMaker gets the default See also:
Horizontal Scale setting.
The GetZeroPoint query
No text selected. If the text contains the The ZeroLock command
insertion point but no text is selected,
PageMaker returns the Horizontal Scale setting
of the character preceding the insertion point. If GetZeroPoint
the insertion point is before the first character of
Returns the position of the ruler zero point
the story, PageMaker returns the Horizontal
relative to the center of the pasteboard.
Scale setting of the first character.
Reply: xPosition, yPosition
 ADOBE PAGEMAKER 7.0 244
Queries

Center of the pasteboard. The position of the Measurement units for scripts. PageMaker
zero point is specified relative to the center of returns coordinates using the publication
the pasteboard, which is: default units, specified in the Preferences dialog
box or with the MeasureUnits command.
• For single-page spreads, the center of the
pasteboard will be on the left edge (for odd
pages) or the right edge (for even pages) of the See also:
page. The GetZeroLock query
• For facing pages, the vertical center will be The ZeroPoint and ZeroPointReset command
halfway down the page at the location where the
two pages meet.
Coordinates for the zero point are relative to the center of the
pasteboard.
 INDEX 245

Index
A Case 41 Coordinates, numeric 12
Abs function 16
Case control 19 Copy 53
Addition 35
Change 41 Cos function 16
AddPrinterStyle 35
ChangeAll 43 CreateIndex 53
AddWord 36
ChangeEnv 45 CreatePolygon 54
Adobe home page 34
ChangeNext 45 CreateTOC 54
Alerts 9
ChangeParaAttr 47 Crop 55
Alignment 36
ChangeTypeAttr1 47 Cut 56
America Online 34
ChangeTypeAttr2 49
AppendVertices 36 D
ChangeWindow 50
Apple events 24, 25 DDE 24, 26
Clear 50
Apple events, addressing 25 DefaultDir 57
Close 50
Apple events, commands and queries DefaultPrintClrSpace 56
CloseStory 51
26 Defaults 22
Color 51
Apple events, constants 25 Defaults, measurement 10, 11
ColorPalette 52
Apple events, replies 26 DefineColor 57
ColumnGuides 52
Arctan function 16 DefineInk 59
Command 6, 22
AssignLayer 37 DefineMasterPage 59
Commands, cancelling 9
AttachContent 37 Delete 60
Commands, modified 4
Autoflow 37 DeleteContent 61
Commands, new 4
DeleteHoriz 61
B Commands, syntax 7
DeleteLayer 61
BasedOn 38 Compuserve 34
DeleteMasterPage 62
BlackAttributes 38 Control 6
DeletePrivateData 62
Book 39 ControlPalette 53
DeleteRulerGuides 63
Box 39 Controls 19
DeleteUnusedLayers 63
Break control 19 Conventions, for scripting 21
DeleteVert 63
BreakLinks 40 Conventions, script language 4
Deselect 64
BringForward 40 ConvertEnhMetafile 53
Dialog boxes 9
BringToFront 40 Coordinates 11
Dictionary 64
Coordinates, by page elements 12
C DisplayNonPrinting 64
Coordinates, measurements 10
Cascade 41 DisplaySpecial 65
 INDEX 246

DisplayStyleNames 65 Function, using 16 GetFindParaAttr 189

DownLoadWebContent 117 Functions 16 GetFindTypeAttr1 190

DragSelect 65 GetFindTypeAttr2 191

G
DragSelectExtend 66 GetFindWindow 191
GetAdditions 181
GetFont 191
E GetAdditionsDir 181
GetFontDrawing 192
EditLayout 66 GetAlignment 181
GetFontList 192
EditOriginal 67 GetAutoflow 181
GetFrameContentPos 192
EditStory 67 GetBasedOn 181
GetFrameContentType 192
Else and ElseIf controls 19 GetBlackAttributes 181
GetFrameInset 193
Empty function 16 GetBook 182
GetGroupList 193
Error messages 9, 30 GetCase 182
GetGuides 194
ErrorChecking control 19 GetChangeParaAttr 182
GetHorizGuides 194
Error-checking routines 31 GetChangeTypeAttr1 183
GetHyperLinkPalette 194
Evaluation 6 GetChangeTypeAttr2 183
GetHyphenation 194
Exit 67 GetChangeWindow 184
GetImageFrame 195
Exp function 16 GetCMSOn 184
GetImportFilters 195
Export 67 GetColor 184
GetIndents 195
Expression 6 GetColorInfo 185
GetInkInfo 195
Expressions 15 GetColorNames 185
GetInkNames 196
GetColorPalette 185
F GetInkND 196
GetColumnGuides 185
False 7 GetIsFrame 196
GetControlPalette 186
FillAndLine 68 GetKernText 196
GetConvertStr 186
FillStyle 70 GetLastError 198
GetConvertTwips 186
Find 70 GetLastErrorStr 198
GetCropRect 187
FindNext 72 GetLayAdjOpts 197
GetDefaultDir 187
FindParaAttr 73 GetLayerFromID 197
GetDefaultPrintClrSpace 187
FindTypeAttr1 74 GetLayerList 197
GetDictionary 188
FindTypeAttr2 75 GetLayerOptions 197
GetDisplayNonPrinting 188
FindWindow 76 GetLayerPalette 197
GetDisplaySpecial 188
Font 76 GetLeading 198
GetDisplayStyleNames 188
FontDrawing 77 GetLetterSpace 198
GetExportFilters 189
FrameContentPos 77 GetLineBreak 199
GetFillAndLine 189
FrameInset 78 GetLineBreakLoc 199
GetFillStyle 189
Function 6 GetLineStyle 200
 INDEX 247

GetLinkInfo 200 GetParaSpace 214 GetPubName 224

GetLinkOptions 200 GetPasteRemembers 214 GetPubWindowRect 224

GetLinks 201 GetPickers 214 GetPubWindows 224

GetLock 201 GetPMInfo 214 GetRoundedCorners 225

GetLockGuides 201 GetPMLanguage 214 GetRuleAbove 225

GetMasterItems 201 GetPMState 215 GetRuleBelow 225

GetMasterPage 202 GetPolygonAttribs 215 GetRuleOptions 226

GetMasterPageInfo 202 GetPolygonMiterLimit 215 GetRulers 226

GetMasterPageList 202 GetPolygonType 215 GetSaveStatus 226

GetMasterPageName 203 GetPolygonVertices 215 GetScrollbars 226

GetMasterPagePalette 203 GetPPDFontLocation 216 GetSelectIDList 226

GetMeasureUnits 203 GetPreferences 216 GetSelectIDListTop 227

GetMultPasteOffset 203 GetPrintCaps 216 GetSelectInfo 229

GetNextFrame 204 GetPrintColor 216 GetSelectList 229

GetNextStyle 204 GetPrintDoc 216 GetShowErrorAlert 230

GetNoBreak 204 GetPrintEPSPreviews 220 GetSize 230

GetNonPrinting 204 GetPrinter 217 GetSnapToGuides 230

GetObjectIDList 205 GetPrinterList 217 GetSnapToRulers 230

GetObjectIDListTop 206 GetPrinterResol 217 GetSpaceOptions 231

GetObjectList 207 GetPrinterStyles 217 GetSpellResult 231

GetObjectLoc 208 GetPrintFeature 218 GetSpellWindow 231

GetPageHistory 213 GetPrintFeatureItems 218 GetStoryEditPref 232

GetPageID 209 GetPrintFeatureTitles 218 GetStoryID 232

GetPageImage 210 GetPrintInk 219 GetStoryIDList 232

GetPageMargins 210 GetPrintOptions 219 GetStoryList 232

GetPageNumber 211 GetPrintOptionsPS 219 GetStoryText 233

GetPageNumberByID 211 GetPrintPaperPS 219 GetStyle 234

GetPageNumbers 211 GetPrintPPDs 220 GetStyleNames 234

GetPageOptions 212 GetPrintPS 220 GetStylePalette 235

GetPageRect 212 GetPrintScreenRGBs 221 GetSuppressAutosave 235

GetPages 213 GetPrintScreens 220 GetSuppressPalDraw 236

GetPageSize 213 GetPrintTo 221 GetSuppressPrint 236

GetPaperSizes 213 GetPrivateData 221 GetTabs 236

GetPaperSources 213 GetPrivateList 222 GetTargetLayer 236

GetParaOptions 213 GetPrivateString 223 GetTextBounds 237

 INDEX 248

GetTextCursor 237 I Loop control 19

If control 19
GetTextLocation 237
ImageSaveAs 81 M
GetTextRun 238
ImageSaveForSep 83 ManualKerning 98
GetTextWrap 239
Import 84 Mask 98
GetTextWrapPoly 239
Indents 87 MasterGuides 98
GetTint 239
IndexAuto 87 MasterItems 99
GetTOCIndexID 239
IndexAutoName 87 MasterPage 99
GetTool 240
IndexFormat 88 MasterPagePalette 100
GetToolbox 240
InkND 88 Math operators 15
GetTrack 240
InsertPages 89 Max function 16
GetTransform 240
InvalidateRect 89 Measurements 10, 11
GetTrapSettings 241
Isnumber function 16 MeasureUnits 11, 100
GetTypeOptions 241
Message command 19
GetTypePosition 241
K Microsoft Excel 26
GetTypeStyle 242 Kern 91
Min function 16
GetVertGuides 242 KernText 91
MiniSave 101
GetView 243
Modified commands 4
GetWidth 243 L
Modified queries 4
Language, conventions 4
GetWordSpace 243
Move 101
Language, for scripts 5
GetZeroLock 243
MoveColumn 102
LayAdjOpts 92
GetZeroPoint 243
MoveLayer 103
LayerOptions 91
GoBack 78
MultiplePaste 103
LayerPalette 93
GoForward 78
MultPasteOffset 103
Leading 93
Goto and Label controls 19
Len function 16
Group 78 N
LetterSpace 94
GuideHoriz 79 New 104
Line 94
Guides 79 New commands 4
LineStyle 95
GuideVert 80 New queries 4
LinkFrames 96
NewLayer 104
H LinkOptions 96
NewStory 105
Help 3 List function 16
NewStorySized 106
Hypercard 25, 27 Lock 97
NextStyle 107
HyperJump 80 LockGuides 97
NoBreak 107
HyperLinkPalette 80 LockLayers 92
NonPrinting 107
Hyphenation 80 Log function 16
Not function 16
 INDEX 249

Nudge 108 PolygonVertices 119 RemovePrinterStyle 136

Position 120 RemoveStyle 136

O
Preferences 22, 120 RemoveUnusedColors 136
Open 108
Print 123 RemoveWord 137
OpenStory 108
PrintColor 124 RenameMasterPage 137
Operator 6
PrintDeviceIndpntColor 124 RenderClip 138
Operators 15
PrintDoc 125 Repeat Loop 6
Oval 109
PrintEPSPreviews 126 Repeat Until control 19

P PrinterResol 126 Replies, understanding 9

Page 109 PrinterStyle 126 Requirements, scripting 24

PageMargins 110 PrintFeature 126 Resize 138

PageNumbers 110 PrintInk 127 ResizePct 140

PageOptions 111 PrintOptions 127 RestoreColor 141

PageSize 111 PrintOptionsPS 128 ReversePolyVertices 141

Parameters 6, 15 PrintPaperPS 129 Revert 141

Parameters, query replies 9 PrintScreenRGBs 126 Rotate 142

Parameters, types 7 PrintTo 130 RoundedCorners 143

ParaOptions 112 PrivateData 131 RuleAbove 144

ParaSpace 113 PrivateString 132 RuleBelow 145

Paste 113 RuleOptions 147

Q
PasteLink 114 Rulers 148
Queries, modified 4
PasteRemembers 114 Rulers, coordinates 10
Queries, new 4
PasteSpecial 114
Queries, replies 9 S
Path function 16
Queries, syntax 7 Save 149
PickColor 115
Query 6 SaveAs 149
Place 116
Quit 133 SaveAsMasterPage 150
PlaceNext 116
Quote function 16 SaveStatusOff 150
PlaceSized 117
Scripting, rules 21
PMScript 8 R
Scripts 4, 23, 24, 25, 26, 27
PMTrace 30 Rand function 16
Scripts palette, adding scripts 23
Polygon 118 Redraw 133
Scripts palette, removing and
PolygonAttribs 118 Reflect 134 restoring scripts 24
PolygonJoin 118 Relink 135 Scripts palette, solving errors 31, 32
PolygonMiterLimit 119 RemoveColor 135 Scripts palette, using 23
PolygonType 119 RemovePages 135 Scripts, adding to palette 23
 INDEX 250

Scripts, external 26 SpellWindow 162 Toolbook 26

Scripts, language 5 Sqrt function 16 Toolbox 173

Scripts, removing from palette 24 StoryEditPref 162 ToUpper function 16

Scripts, sample 27, 28 Str function 16 Trace 30

Scripts, solving errors 31 String 7 Track 174

Scripts, stopping 32 Style 163 TrapSettings 174

Scripts, testing 30 StyleBegin 163 Troubleshooting 30

Scripts, tips 22 StyleEnd 164 True 7

Scroll 151 StylePalette 164 Trunc function 16

Scrollbars 151 Substr function 16 Try control 19

Select 151 Supercard 25, 27 TypeOptions 175

SelectAll 152 SuppressAutosave 165 TypeStyle 176

SelectExtend 152 SuppressPalDraw 165

U
SelectID 153 SuppressPI 166
Ungroup 176
SelectIDExtend 153 Switch control 19
Unlink 176
SelectLayer 153 Syntax 7
Unlist function 16
SendBackward 154
T Unmask 177
SendToBack 154
Tabs 166 Unquote function 16
SendToPage 154
TargetLayer 167 Unselect 177
SeparateContent 155
Technical support 34 UnselectID 177
SetTextCursor 155
Testing 30
SetWidth 156 V
TextCursor 168
ShowErrorAlert 157 Val function 16
TextEdit 168
ShowLayers 157 Variable 6
TextEnter 169
ShowPages 157 Variables 13, 15
TextSelect 170
Sin function 16 VBA, sample scripts 28
TextWrap 171
Size 158 View 177
TextWrapPoly 172
SizeBump 158 Visual Basic 26, 28
Tile 172
Skew 158 Visual Basic for Applications, sample
TintSelection 172 scripts 28
SnapToGuides 159
Tips, for scripting 22
SnapToRulers 160 W
Tips, scripting errors 31
solving errors 31 While control 19
ToggleFrame 173
SpaceOptions 160 Window 178
ToLower function 16
Special characters in functions 16 WordSpace 178
Tool 173
Spell 161 World Wide Web 34
 INDEX 251

Z
Zero point 11

ZeroLock 179

ZeroPoint 179

ZeroPointReset 179

Zstrip function 16