REQUIRED SUITE

 

open: Open a document

open reference -- reference

 

 Index

print: Print the specified object(s)

print reference -- list of objects to print

 

 Index

quit

quit

 

 Index

run

run

 Index

IRCLE SUITE (the ircle commands)

 

connect: open a connection

connect connection -- Connection

 

 Index

disconnect: close a connection

disconnect connection -- Connection

 

 Index

display: display/type/dump a string of text to a window (obsolete soon, use echo instead)

display string -- the message

[in window string] -- name of window

[with color integer] -- color number (0..15)

 

 Index

do: executes a command

do string -- the command string

[Result: integer] -- result code

 

 Index

echo: echo (display) a string in a window. the string wont get sent thru the selected connection

echo string -- the string to display

[in reference] -- the target object in which to echo the string (window, channel)

 

 Index

match: match one string to a string with wildcards ("*" and "?")

match list of string -- the string or list

with list of string -- the wildcard string or list

Result: list of integer -- list of matching item numbers

 

 Index

play: play a sound

play string -- sound name to play

[Result: string]

 

 Index

select: Select an object

select reference -- the object

 

 Index

speak: speak a text

speak string -- the text to speak

[voice string] -- the voice to use

[rate integer] -- the speech rate in words per minute

[pitch integer] -- the speech pitch

 

 Index

type: type something to a channel or connection input is parsed as if the user typed it himself.

type will send the string thru the selected connection

type string -- the (command)string to type

[in reference] -- the target reference (window, channel, connection)

 

 Index

 

 

CORE SUITE (core AppleEvent suite)

 

open: Open the specified object(s)

open reference -- list of objects to open

 

 Index

run: Run an application. Most applications will open an empty, untitled window.

run

 

 Index

reopen: Reactivate a running application. Some applications will open a new untitled window if no window is open.

reopen

 

 Index

print: Print the specified object(s)

print reference -- list of objects to print

 

 Index

quit: Quit an application

quit

[saving yes/no/ask] -- specifies whether to save currently open documents

 

 Index

close: Close an object

close reference -- the object to close

[saving yes/no/ask] -- specifies whether changes should be saved before closing

[saving in alias] -- the file in which to save the object

 

 Index

count: Return the number of elements of a particular class within an object

count reference -- the object whose elements are to be counted

each type class -- the class of the elements to be counted. Keyword 'each' is optional in AppleScript

Result: integer -- the number of elements

 

 Index

delete: Delete an object from its container. Note this does not work on script variables, only on elements of application classes.

delete reference -- the element to delete

 

 Index

duplicate: Duplicate one or more objects

duplicate reference -- the object(s) to duplicate

[to location reference] -- the new location for the object(s)

[with properties record] -- the initial values for properties of the new object that are to be different from the original

Result: reference -- to the duplicated object(s)

 

 Index

exists: Verify if an object exists

exists reference -- the object in question

Result: boolean -- true if it exists, false if not

 

 Index

b: create a new element

create

new type class -- the class of the new element

[at location reference] -- The location at which to insert the element

[with data anything] -- The initial data for the element

[with properties record] -- The initial data of the properties of the element

Result: ' ' -- to the new object(s)

 

 Index

move: Move object(s) to a new location

move reference -- the object(s) to move

to location reference -- the new location for the object(s)

Result: reference -- to the object(s) after they have been moved

 

 Index

save: Save an object

save reference -- the object to save

[in alias] -- the file in which to save the object

[as type class] -- the file type of the document in which to save the data

 

 Index

select: Make a selection

select reference -- the object to select

 

 Index

data size: Return the size in bytes of an object

data size reference -- the object whose data size is to be returned

[as type class] -- the data type for which the size is calculated

Result: integer -- the size of the object in bytes

 

 Index

suite info: (optional) Get information about event suite(s)

suite info type class -- the suite for which to return information

[in 'intl'] -- the human language and script system in which to return information

Result: list of type suite info -- a record containing the suites and their versions

 

 Index

event info: (optional) Get information about the Apple events in a suite

event info type class -- the event class of the Apple events for which to return information

[in 'intl'] -- the human language and script system in which to return information

Result: list of type event info -- a record containing the events and their parameters

 

 Index

class info: (optional) Get information about an object class

class info [type class] -- the object class about which information is requested

[in 'intl'] -- the human language and script system in which to return information

Result: type class info -- a record containing the object's properties and elements

 

 Index

get: Get the data for an object

get reference -- the object whose data is to be returned

[as list of type class] -- the desired types for the data, in order of preference

Result: anything -- The data from the object

 

 Index

set: Set an object's data

set reference -- the object to change

to anything -- the new value