addarexxgadget
addarexxlist
addguides
addpoint
addtodrawing
align
allocarexxlist
allocarexxrequester
appendfontprefs
appendstyletags
applyattributes
Adds a control to an allocated dialog box.
addarexxgadget <dbox type left top width [height]> [LABEL name] [LABELPOS pos] [STRING text] [BORDER style] [CHECKED status] [LIST handle] [CURRENT value] [TOTAL value]
dbox/i The dialog box handle.
type/k The control type to add. Options: EXIT | STRING | MULTILINE | TEXT | CHECKBOX | POPUP | CYCLE | SCROLLIST | SLIDER.
left/i The left edge of the control.
top/i The top edge of the control.
width/i The width of the control.
height/i The height of multiline and scrollist controls. Minimum=36
LABEL/s The control's label.
LABELPOS/s The label position relative to the control.
Options: LEFT | RIGHT | ABOVE | ABOVELEFT | ABOVERIGHT | BELOW | BELOWLEFT | BELOWRIGHT | CENTER | CENTERLEFT | CENTERRIGHT | LEFTABOVE | LEFTBELOW | RIGHTABOVE | RIGHTBELOW.
Default=LEFT except for checkbox=RIGHT.
STRING/s The default text of a string, multiline or text control.
BORDER/k The border type of a text control.
Options: NONE | RAISED | RECESSED | SHINE | SHADOW|TEXT.
CHECKED/k The default state of a checkbox.
Options: TRUE|FALSE.
LIST/i The list handle for a popup, cycle or scrollist control.
CURRENT/i The default list item for a popup, cycle or scrollist, or the default slider position (decimal).
TOTAL/d The range of a slider.
Results:
The handle of the new control is returned to RESULT. The handle is required
in order to set options and get future results.
Notes:
The width and position of controls does not include the label. Position
is not applicable to exit buttons because the label is centered on the button.
The first exit control is always the default control, and the second is always the cancel (Esc) control.
String controls are editable text fields; multilines allow multiple lines of text. Text controls are non-editable text displays.
Precede the character to underscore as a keyboard shortcut in the label name. For example, "_Add" would make "A" the keyboard shortcut for an "Add" control.
There is a maximum number of each type of control which can be added to a dialog box. Exit 10, Multiline 5, Text 10, Checkbox 10, Popup 10, Cycle 5, Scrollist 5, Slider 5. Cycle controls are Amiga only.
Examples:
addarexxgadget dboxid exit 16 114 70 hidden false label 'Cancel' Cancel=RESULT addarexxgadget TestReq scrollist 16 8 90 72 hidden false Fonts=RESULT addarexxgadget iDBox cycle 124 52 200 hidden false label 'Choices' Choices=RESULT
Adds an item to an allocated list.
addarexxlist <handle/S item>
handle/i The list to which to add the item.
item/s The item to add.
Notes:
The first item added to a list is item 0, the second
is item 1...
There is no limit to the number of items in a list.
Examples:
addarexxlist choices 'First choice'
Adds guide(s) to a master page.
addguides [type] <AT position> [MPG name]
type/k The guide axis. Options: HORIZONTAL | VERTICAL.
AT/d The position(s) of the guide(s) to add.
MPG/s The master page name and side.
Examples:
addguides vertical at 2.5 mpg left addguides horizontal at 2.5 3.5
Adds a point to the current path.
addpoint <[MOVETO pointx pointy [join]] | [LINETO pointx pointy [join]] | [CURVETO curvex1 curvey1 curvex2 curvey2 pointx pointy [join]] | [CLOSEPATH]> [PAGE number | WINDOW name | OBJECTID number]
MOVETO/d The first point of a new path or subpath.
LINETO/d Draws a line to the point.
CURVETO/d Draws a bezier curve to the point.
CLOSEPATH Closes the open path.
join/k Specifies the join type: cornerjoin (default)|smoothjoin.
PAGE/s The page number. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Notes:
The join type will not modify the coordinates you enter. This parameter is used by PageStream when the user draws. You can use it manually, but it won't affect the coordinates until the user modifies a curve handle with the Reshape tool.
Examples:
addpoint lineto 5.1 6.25 addpoint moveto 1.6 7.3 addpoint arcto 0.5 7.3 1.2 1.65 25 93 addpoint closepath page 'project.doc~8'
Adds all selected objects to the bottom-most selected drawing.
addtodrawing [DOCUMENT name | WINDOW name]
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
addtodrawing 'Project.doc'
Aligns objects to each other, to the page or to a point.
align <[[horizontal] [vertical]] | [AT pointx pointy | AT pointx | AT pointy | OFPAGE]>
[DOCUMENT name | WINDOW name | OBJECTID number]
horizontal/k Aligns horizontally to a vertical axis.
Options: LEFT|CENTER|RIGHT.
vertical/k Aligns vertically to a horizontal axix.
Options: TOP|MIDDLE|BOTTOM.
AT/d Aligns to horizontal and/or vertical axes.
OFPAGE Aligns to the page.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
OBJECTID/i The number of the object to manipulate.
Examples:
align center at 5.5 document 'project.doc' align left top align at 5.5 6.5
Allocates a list for a list control (scrolling list, popup or cycle). Returns the list handle to RESULT.
allocarexxlist @{FG Fill}(no parameters)@{FG Text}
Results:
The handle (identification number) of the new list is returned to RESULT. The handle is required in order to add items to the list, or to set the list for a control.
Notes:
Lists are not part of dialog boxes, so they can be allocated before allocating a dialog box, and can be set to more than one control. After a dialog box has closed, you can continue using the list in other dialog boxes until you unallocate the list.
Warning:
You must always unallocate your list before exiting the script!
Examples:
allocarexxlist listnumber=RESULT allocarexxlist choices=RESULT
Allocates a new dialog box which can be opened from an ARexx script. Returns the dialog box handle to RESULT.
allocarexxrequester <name width height>
name/s The title of the dialog box.
width/i The width of the dialog box in pixels.
height/i The height of the dialog box in pixels.
Results:
The handle (identification number) of the new dialog box is returned to RESULT. The handle is required in order to add controls or use the dialog box.
Notes:
The width and height parameters do not take into account the dialog box borders and title bar; they are the inside measurements.
This command does not display the dialog box, but only allocates it. After allocating a dialog box, you can add controls to it and then display it. After you are done with a dialog box, you must unallocate the dialog box and any lists used in it.
Warnings:
You must always unallocate your dialog box before exiting the script!
Examples:
allocarexxrequester 'Test Dialog Box' 400 220 iTextBox=RESULT allocrequester 'Create Shadow' 300 119 ShadowReq=RESULT
This loads a font prefs file and appends the font paths to those added in the Font Preferences dialog box.
appendfontprefs <FILE filepath | DEFAULT>
FILE/s The filename and path of the fontprefs file to append.
DEFAULT Appends the PageStream3.fontprefs file.
Examples:
appendfontprefs file 'NewsletterFonts.fontprefs' appendfontprefs default
This loads a style tag file and appends its styles to a document's style tag list.
appendstyletags <FILE filepath | ASK> [type] [progress] [DOCUMENT name | WINDOW name | CHAPTER name]
FILE/s The filename and path of the styles file to load.
ASK Opens a file selector to select the file to load.
ALL Appends all styles in the file. Default.
type/k The type of styles to append.
Options: ALL|TEXT|PARAGRAPH|CHARACTER|OBJECT|COLOR. progress/k Toggle to display a progress meter.
Options: STATUS|NOSTATUS (DEFAULT).
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
CHAPTER/s The document/chapter name. Default=current.
Notes:
Styles are stored in IFF CTAG format, which is a subset of the IFF DOC format. You can load styles out of IFF DOC, IFF CTXT, IFF ILUS and IFF CTAG files.
Colors are stored as color style tags, so colors may be appended to the color palette with this command.
Examples:
appendstyletags file 'Work:Newsletter10' text appendstyletags ask
Applies picked up attributes to a paragraph or object.
applyattributes <AT pointx pointy [stack] | RANGE left top right bottom [stack]>
[PAGE number | MPG name | DOCUMENT name | WINDOW name]
AT/d Applies to the paragraph at this position.
RANGE/d Applies to all paragraphs in this range.
stack/k Specifies which text to apply to.
Options: FRONTMOST Selects in the frontmost article at the point. Default.
BACKMOST Selects in the backmost article at the point.
PAGE/s The page number. Default=current.
MPG/s The master page name and side.
DOCUMENT/s The document name. Default=current.
WINDOW/s The window name. Default=current.
Examples:
applyattributes at 1.25 3.3 backmost applyattributes range 1.25 3.3 1.75 5.25