beautypg.com

Parameters 3 – Apple AppleScript Finder Guide User Manual

Page 112

background image

C H A P T E R 3

Finder Commands

100

Using Command Definitions

For example, here’s the syntax statement for the Move command from page 124:

move

referenceToObject to referenceToContainer

¬

[ replacing ( conflicts | existing items ) ]

To use the Move command, you must replace the placeholders referenceToObject

and referenceToContainer with a reference to the object you want to move and a

reference to the container to which you want to move it, respectively. The

optional parameter in brackets indicates that you want the moved object to

replace any object in referenceToContainer that has the same name.

Parameters

3

Parameters are values that are included with a command. The “Parameters”

section of a command definition lists that command’s parameters and the

information you need to use them correctly.
Many commands include a direct parameter that specifies the object of the

action. The direct parameter immediately follows the command. In the Move

command syntax described in the previous section, the referenceToObject

parameter is the direct parameter.
If a command includes parameters other than the direct parameter, they

are identified by labels. Parameters that are identified by labels are called

labeled parameters.

In the Move command syntax, the to referenceToContainer

parameter is a labeled parameter with the label to, and the replacing
(conflicts | existing items)

parameter is a labeled parameter with

the label replacing.
Each parameter value you supply must belong to a particular class, which

is listed in its description in the command definition. For example, the

referenceToObject

and referenceToContainer parameters for the Move command

must both be references.
Parameters can be required or optional. Required parameters must be included

with the command; optional parameters need not be. Optional parameters

are enclosed in brackets in syntax descriptions. For optional parameters, the

description in the “Parameters” section specifies a default value that is used

if you don’t include the parameter.