Command Reference

SectionCommand & Query Format
<mandatory> Angles enclose mandatory parameters.

[optional] Brackets enclose optional parameters.

(group) Parentheses group together parameters.

(group)... An ellipsis after a group indicates that you can repeat the group of parameters one or more times.

a | b Vertical bars separate alternative parameters from which you must choose a single parameter.

Commands are case insensitive.

SectionArguments and Variables:
Some commands require you to enter an argument to the command or to specify a variable to hold a result. Variables and arguments in the command descriptions are followed by a backslash and a letter to indicate their type:

/i Integer: Whole numbers, positive or negative.
i.e., -2, -1, 0, 1, 2, 3\

/d Decimal: Any number.
i.e., 1.25, -13.789

/s String: Text. You can break text into lines by typing \\n. i.e., "My text", "More than one\\nline."

/v Variable: Used to hold a single result.

/a Array: A stem variable used to hold multiple results.

SectionObject & Article ID Numbers
Many PageStream commands use the objectid and articleid parameters to specify which object or article is to be manipulated. ID numbers are assigned when an object or article is created. They are session-specific numbers are are not stored with the document.

Your scripts should store ID numbers when objects or articles are created or selected so that the script may modify them later. The ID numbers are not of use for anything other than scripts. Your script should get an ID number and use it as a handle for the object or article.

SectionDialog Box Commands
These commands are used to open dialog boxes from PageStream scripts. They require that PageStream be loaded.

SectionNew PageStream4.0 Command Parameters
These still need to be integrated into the command documentation.

ADDPOINT, CLOSEPATH, SELECTPOINT, CREATEPOINT, EDITPOINT, DELETEPOINT,
MOVEPOINT, NUDGEPOINT, SPLITPOINT work on TextObject TextFX Paths,
Drawing Masks, EPS Masks, and Picture Masks now.

...RULEABOVE | RULEBELOW] added to fill routines to set paragraph rules above
and below attributes using:
FILLED, STROKED, SETSTROKESTYLE, SETFPATTERNSTYLE, SETCOLORSTYLE,
SETSTROKECOUNT, SETSTROKE, SETSTROKEWEIGHT, SETSTROKEJOIN, SETSTROKEBEGIN,
SETSTROKEEND, SETSTROKECAP, SETSTROKEOFFSET, SETFILL, SETFPATTERN,
SETCOLORCOUNT, SETCOLOR, SETCOLORTINT, SETSCREEN

OBJECTID objectid] and added to object drawing and selecting commands for layers.

SectionCommand Index
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

SectionCommand Table of Contents
Bitmap
Color
Dialog Box
Document
Drawing
File
Object
Style
System
Text
Platform
Script

    Bitmap Commands
    Color Commands
    Dialog Box Commands
    Document Commands
    Drawing Commands
    Extension Commands
    File Commands
    Object Commands
    Style Commands
    System Commands
    Text Commands
    Platform Commands
    Script Commands
    Index of Commands

 

Command Reference  Index  url:PGScmd/Creference
  created:2006-03-31 14:53:35   last updated:2006-06-16 14:20:22
  Copyright © 1985-2017 GrasshopperLLC. All Rights Reserved.

User Contributed Comments For Command Reference
There are no user contributed comments for this page.