System Events 1.2.1 Dictionary

Index

Standard Suite
- Classes:
  1. application
  2. color
  3. document
  4. item
  5. window
- Events:
  1. close
  2. count
  3. delete
  4. duplicate
  5. exists
  6. get
  7. make
  8. move
  9. open
  10. print
  11. quit
  12. save
  13. set
Text Suite
- Classes:
  1. attachment
  2. attribute run
  3. character
  4. paragraph
  5. text
  6. word
Disk-Folder-File Suite
- Classes:
- Events:
  1. delete
  2. move
  3. open
Folder Actions Suite
- Classes:
  1. folder action
  2. script
- Events:
Power Suite
- Events:
  1. log out
  2. restart
  3. shut down
  4. sleep
Processes Suite
- Classes:
  1. UI element
  2. action
  3. application process
  4. attribute
  5. browser
  6. busy indicator
  7. button
  8. checkbox
  9. color well
  10. column
  11. combo box
  12. desk accessory process
  13. drawer
  14. group
  15. grow area
  16. image
  17. incrementor
  18. list
  19. menu
  20. menu bar
  21. menu bar item
  22. menu button
  23. menu item
  24. outline
  25. pop up button
  26. process
  27. progress indicator
  28. radio button
  29. radio group
  30. relevance indicator
  31. row
  32. scroll area
  33. scroll bar
  34. sheet
  35. slider
  36. splitter
  37. splitter group
  38. static text
  39. tab group
  40. table
  41. text area
  42. text field
  43. tool bar
  44. value indicator
  45. window
- Events:
  1. click
  2. key code
  3. keystroke
  4. perform
  5. select
System Events Suite
- Classes:
  1. application
Accounts Suite
- Classes:
  1. user
Login Items Suite
- Classes:
  1. login item

Standard Suite: Common classes and commands for most applications.

Classes:

Class application: An application's top level scripting object.

Plural form:

applications

Elements:

window by name, by numeric index, before/after another element, as a range of elements, satisfying a test

document by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

version Unicode text [r/o] -- The version of the application.

frontmost boolean [r/o] -- Is this the frontmost (active) application?

name Unicode text [r/o] -- The name of the application.

Class color: A color.

Plural form:

colors

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

Class document: A document.

Plural form:

documents

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

modified boolean [r/o] -- Has the document been modified since the last save?

path Unicode text -- The document's path.

name Unicode text -- The document's name.

Class item: A scriptable object.

Plural form:

items

Properties:

class type class [r/o] -- The class of the object.

properties record -- All of the object's properties.

Class window: A window.

Plural form:

windows

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

zoomed boolean -- Whether the window is currently zoomed.

miniaturized boolean -- Whether the window is currently miniaturized.

name Unicode text -- The full title of the window.

floating boolean [r/o] -- Whether the window floats.

modal boolean [r/o] -- Whether the window is the application's current modal window.

miniaturizable boolean [r/o] -- Whether the window can be miniaturized.

visible boolean -- Whether the window is currently visible.

closeable boolean [r/o] -- Whether the window has a close box.

resizable boolean [r/o] -- Whether the window can be resized.

zoomable boolean [r/o] -- Whether the window can be zoomed.

id integer [r/o] -- The unique identifier of the window.

bounds bounding rectangle -- The bounding rectangle of the window.

titled boolean [r/o] -- Whether the window has a title bar.

index integer -- The index of the window in the back-to-front window ordering.

document document [r/o] -- The document whose contents are being displayed in the window.

Events:

close: Close an object.

close reference -- the object for the command

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

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

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

count reference -- the object for the command

[each type class] -- The class of objects to be counted.

Result: integer -- the reply for the command

delete: Delete an object.

delete reference -- the object for the command

duplicate: Copy object(s) and put the copies at a new location.

duplicate reference -- the object for the command

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

[with properties record] -- Properties to be set in the new duplicated object(s).

exists: Verify if an object exists.

exists reference -- the object for the command

Result: boolean -- the reply for the command

get: Get the data for an object.

get reference -- the object for the command

Result: anything -- the reply for the command

make: Make a new object.

make

[with properties record] -- The initial values for properties of the object.

new type class -- The class of the new object.

[with data anything] -- The initial data for the object.

[at location reference] -- The location at which to insert the object.

Result: reference -- the reply for the command

move: Move object(s) to a new location.

move reference -- the object for the command

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

open: Open an object.

open alias -- The file(s) to be opened.

print: Print an object.

print alias -- The file(s) or document(s) to be printed.

quit: Quit an application.

quit reference -- the object for the command

[saving yes/no/ask] -- Specifies whether changes should be saved before quitting.

save: Save an object.

save reference -- the object for the command

[as Unicode text] -- The file type in which to save the data.

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

set: Set an object's data.

set reference -- the object for the command

to anything -- The new value.

Text Suite: A set of basic classes for text processing.

Classes:

Class attachment: Represents an inline text attachment. This class is used mainly for make commands.

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> text [r/o] -- All of the properties of the superclass.

file name Unicode text -- The path to the file for the attachment

Class attribute run: This subdivides the text into chunks that all have the same attributes.

Plural form:

attribute runs

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class character: This subdivides the text into characters.

Plural form:

characters

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class paragraph: This subdivides the text into paragraphs.

Plural form:

paragraphs

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class text: Rich (styled) text

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class word: This subdivides the text into words.

Plural form:

words

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Disk-Folder-File Suite: Terms and Events for controlling Disks, Folders, and Files

Classes:

Class Classic domain object: The Classic domain in the file system

Plural form:

Classic domain objects

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> domain [r/o] -- All of the properties of the superclass.

control panels folder folder [r/o] -- The Control Panels folder

launcher items folder folder [r/o] -- The Launcher Items folder

control strip modules folder folder [r/o] -- The Control Strip Modules folder

extensions folder folder [r/o] -- The Extensions folder

desktop folder folder [r/o] -- The Classic Desktop folder

apple menu folder folder [r/o] -- The Apple Menu Items folder

fonts folder folder [r/o] -- The Fonts folder

shutdown folder folder [r/o] -- The Shutdown Items folder

startup items folder folder [r/o] -- The StartupItems folder

preferences folder folder [r/o] -- The Classic Preferences folder

system folder folder [r/o] -- The System folder

Class alias: An alias in the file system

Plural form:

aliases

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

item by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

file package by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

disk item by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

file by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

alias by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> disk item [r/o] -- All of the properties of the superclass.

version Unicode text [r/o] -- the version of the application bundle referenced by the alias (visible at the bottom of the "Get Info" window)

product version Unicode text [r/o] -- the version of the product (visible at the top of the "Get Info" window)

Class disk: A disk in the file system

Plural form:

disks

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

item by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

file package by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

disk item by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

file by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

alias by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> disk item [r/o] -- All of the properties of the superclass.

local volume boolean [r/o] -- Is the media a local volume (as opposed to a file server)?

format ProDOS format/UDF format/AppleShare format/UFS format/Apple Photo format/MS-DOS format/WebDAV format/audio format/NFS format/Mac OS format/unknown format/Mac OS Extended format/ISO 9660 format/High Sierra format/QuickTake format [r/o] -- the file system format of this disk

startup boolean [r/o] -- Is this disk the boot disk?

ignore privileges boolean -- Ignore permissions on this disk?

ejectable boolean [r/o] -- Can the media be ejected (floppies, CD's, and so on)?

capacity double integer [r/o] -- the total number of bytes (free or used) on the disk

free space double integer [r/o] -- the number of free bytes left on the disk

Class disk item: An item stored in the file system

Plural form:

disk items

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

package folder boolean [r/o] -- Is the disk item a package?

volume Unicode text [r/o] -- the volume on which the disk item resides

creation date anything [r/o] -- the date on which the disk item was created

visible boolean -- Is the disk item visible?

path Unicode text [r/o] -- the file system path of the disk item

container disk item [r/o] -- the folder or disk which has this disk item as an element

modification date anything -- the date on which the disk item was last modified

POSIX path Unicode text [r/o] -- the POSIX file system path of the disk item

URL Unicode text [r/o] -- the URL of the disk item

displayed name Unicode text [r/o] -- the name of the disk item as displayed in the User Interface

physical size double integer [r/o] -- the actual space used by the disk item on disk

size double integer [r/o] -- the logical size of the disk item

name Unicode text -- the name of the disk item

id Unicode text [r/o] -- the unique ID of the disk item

name extension Unicode text [r/o] -- the extension portion of the name

busy status boolean [r/o] -- Is the disk item busy?

Class domain: A domain in the file system

Plural form:

domains

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

scripts folder folder [r/o] -- The Scripts folder

applications folder folder [r/o] -- The Applications folder

fonts folder folder [r/o] -- The Fonts folder

scripting additions folder folder [r/o] -- The Scripting Additions folder

utilities folder folder [r/o] -- The Utilities folder

preferences folder folder [r/o] -- The Preferences folder

speakable items folder folder [r/o] -- The Speakable Items folder

name Unicode text [r/o] -- the name of the domain

id Unicode text [r/o] -- the unique identifier of the domain

Folder Action scripts folder folder [r/o] -- The Folder Action Scripts folder

desktop pictures folder folder [r/o] -- The Desktop Pictures folder

Class file: A file in the file system

Plural form:

files

Properties:

<Inheritance> disk item [r/o] -- All of the properties of the superclass.

creator type Unicode text -- the OSType identifying the application that created the file

product version Unicode text [r/o] -- the version of the product (visible at the top of the "Get Info" window)

stationery boolean -- Is the file a stationery pad?

version Unicode text [r/o] -- the version of the file (visible at the bottom of the "Get Info" window)

file type Unicode text -- the OSType identifying the type of data contained in the file

Class file package: A file package in the file system

Plural form:

file packages

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

item by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

file package by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

disk item by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

file by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

alias by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> file [r/o] -- All of the properties of the superclass.

Class folder: A folder in the file system

Plural form:

folders

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

item by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

file package by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

disk item by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

file by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

alias by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> disk item [r/o] -- All of the properties of the superclass.

Class item: An item stored in the file system

Plural form:

items

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

name Unicode text -- the name of the item

id Unicode text [r/o] -- the unique ID of the item

Class local domain object: The local domain in the file system

Plural form:

local domain objects

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> domain [r/o] -- All of the properties of the superclass.

Class network domain object: The network domain in the file system

Plural form:

network domain objects

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> domain [r/o] -- All of the properties of the superclass.

Class system domain object: The system domain in the file system

Plural form:

system domain objects

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> domain [r/o] -- All of the properties of the superclass.

Class user domain object: The user domain in the file system

Plural form:

user domain objects

Elements:

folder by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> domain [r/o] -- All of the properties of the superclass.

music folder folder [r/o] -- The user's Music folder

favorites folder folder [r/o] -- The user's Favorites folder

movies folder folder [r/o] -- The user's Movies folder

public folder folder [r/o] -- The user's Public folder

pictures folder folder [r/o] -- The user's Pictures folder

desktop folder folder [r/o] -- The user's Desktop folder

sites folder folder [r/o] -- The user's Sites folder

documents folder folder [r/o] -- The user's Documents folder

temporary items folder folder [r/o] -- The Temporary Items folder

home folder folder [r/o] -- The user's Home folder

Events:

delete: Delete an object.

delete reference -- the object for the command

move: Move disk item(s) to a new location.

move disk item -- The disk item(s) to be moved.

to location reference -- The new location for the disk item(s).

Result: item -- the reply for the command

open: Open disk item(s) with the appropriate application.

open file -- The disk item(s) to be opened.

Result: file -- the reply for the command

Folder Actions Suite: Terms and Events for controlling Folder Actions

Classes:

Class folder action: An action attached to a folder in the file system

Plural form:

folder actions

Elements:

script by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

enabled boolean -- Is the folder action enabled?

name Unicode text -- the name of the folder action, which is also the name of the folder

path anything [r/o] -- the path to the folder to which the folder action applies

volume Unicode text [r/o] -- the volume on which the folder action resides

Class script: A script invoked by a folder action

Plural form:

scripts

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

enabled boolean -- Is the script enabled?

name Unicode text [r/o] -- the name of the script

path Unicode text [r/o] -- the file system path of the disk

POSIX path Unicode text [r/o] -- the POSIX file system path of the disk

Events:

attach action to: Attach an action to a folder

attach action to folder -- The folder to which the action is to be attached.

using Unicode text -- a file containing the script to attach

Result: folder action -- the reply for the command

attached scripts: List the actions attached to a folder

attached scripts folder -- The folder for which the attached scripts are to be listed.

Result: list -- the reply for the command

edit action of: Edit an action of a folder

edit action of folder -- The folder for which the action is to be edited.

[using action number integer] -- the index number of the action to edit...

[using action name Unicode text] -- ...or the name of the action to edit

Result: file -- the reply for the command

remove action from: Remove a folder action from a folder

remove action from folder -- The folder from which the action is to be removed.

[using action number integer] -- the index number of the action to remove...

[using action name Unicode text] -- ...or the name of the action to remove

Result: folder action -- the reply for the command

Power Suite: Terms and Events for controlling System power

Events:

log out: Log out the current user

log out

restart: Restart the computer

restart

shut down: Shut Down the computer

shut down

sleep: Put the computer to sleep

sleep

Processes Suite: Terms and Events for controlling Processes

Classes:

Class UI element: A piece of the user interface of a process

Plural form:

UI elements

Elements:

splitter by name, by numeric index, before/after another element, as a range of elements, satisfying a test

menu button by name, by numeric index, before/after another element, as a range of elements, satisfying a test

browser by name, by numeric index, before/after another element, as a range of elements, satisfying a test

radio group by name, by numeric index, before/after another element, as a range of elements, satisfying a test

relevance indicator by name, by numeric index, before/after another element, as a range of elements, satisfying a test

busy indicator by name, by numeric index, before/after another element, as a range of elements, satisfying a test

progress indicator by name, by numeric index, before/after another element, as a range of elements, satisfying a test

UI element by name, by numeric index, before/after another element, as a range of elements, satisfying a test

column by name, by numeric index, before/after another element, as a range of elements, satisfying a test

outline by name, by numeric index, before/after another element, as a range of elements, satisfying a test

menu bar item by name, by numeric index, before/after another element, as a range of elements, satisfying a test

text field by name, by numeric index, before/after another element, as a range of elements, satisfying a test

menu bar by name, by numeric index, before/after another element, as a range of elements, satisfying a test

combo box by name, by numeric index, before/after another element, as a range of elements, satisfying a test

tool bar by name, by numeric index, before/after another element, as a range of elements, satisfying a test

tab group by name, by numeric index, before/after another element, as a range of elements, satisfying a test

checkbox by name, by numeric index, before/after another element, as a range of elements, satisfying a test

menu by name, by numeric index, before/after another element, as a range of elements, satisfying a test

drawer by name, by numeric index, before/after another element, as a range of elements, satisfying a test

sheet by name, by numeric index, before/after another element, as a range of elements, satisfying a test

radio button by name, by numeric index, before/after another element, as a range of elements, satisfying a test

pop up button by name, by numeric index, before/after another element, as a range of elements, satisfying a test

attribute by name, by numeric index, before/after another element, as a range of elements, satisfying a test

value indicator by name, by numeric index, before/after another element, as a range of elements, satisfying a test

incrementor by name, by numeric index, before/after another element, as a range of elements, satisfying a test

splitter group by name, by numeric index, before/after another element, as a range of elements, satisfying a test

static text by name, by numeric index, before/after another element, as a range of elements, satisfying a test

table by name, by numeric index, before/after another element, as a range of elements, satisfying a test

slider by name, by numeric index, before/after another element, as a range of elements, satisfying a test

action by name, by numeric index, before/after another element, as a range of elements, satisfying a test

button by name, by numeric index, before/after another element, as a range of elements, satisfying a test

window by name, by numeric index, before/after another element, as a range of elements, satisfying a test

grow area by name, by numeric index, before/after another element, as a range of elements, satisfying a test

scroll bar by name, by numeric index, before/after another element, as a range of elements, satisfying a test

row by name, by numeric index, before/after another element, as a range of elements, satisfying a test

scroll area by name, by numeric index, before/after another element, as a range of elements, satisfying a test

text area by name, by numeric index, before/after another element, as a range of elements, satisfying a test

group by name, by numeric index, before/after another element, as a range of elements, satisfying a test

menu item by name, by numeric index, before/after another element, as a range of elements, satisfying a test

list by name, by numeric index, before/after another element, as a range of elements, satisfying a test

image by name, by numeric index, before/after another element, as a range of elements, satisfying a test

color well by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

subrole Unicode text [r/o] -- an encoded description of the UI element and its capabilities

selected boolean -- Is the UI element selected?

title Unicode text -- the title of the UI element as it appears on the screen

enabled boolean -- Is the UI element enabled? ( Does it accept clicks? )

description Unicode text [r/o] -- a more complete description of the UI element and its capabilities

size list -- the size of the UI element

help Unicode text [r/o] -- an encoded description of the UI element and its capabilities

minimum value integer -- the minimum value that the UI element can take on

class type class [r/o] -- the class of the UI Element, which identifies it function

role Unicode text [r/o] -- an encoded description of the UI element and its capabilities

value integer -- the current value of the UI element

name Unicode text [r/o] -- the name of the UI Element, which identifies it within its container

maximum value integer -- the maximum value that the UI element can take on

focused boolean -- Is the focus on this UI element?

position list -- the position of the UI element

orientation Unicode text -- the orientation of the UI element

Class action: An action that can be performed on the UI element

Plural form:

actions

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

name Unicode text [r/o] -- the name of the action

description Unicode text [r/o] -- what the action does

Class application process: A process launched from an application file

Plural form:

application processes