The FooDoo Lounge

System Events 1.1 Dictionary

Copyright © 1994-2002 Apple Computer, Inc. All rights reserved.

Index

  1. Standard Suite
  2. Text Suite
  3. Disk-Folder-File Suite
  4. Folder Actions Suite
  5. Power Suite
  6. Processes Suite
  7. System Events Suite
  8. Login Items Suite

Standard Suite: Common classes and commands for most applications.

Classes:

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

Plural form:

applications

Elements:

document 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, by ID

Properties:

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

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

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

version Unicode text [r/o] -- The version 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.

path Unicode text -- The document's path.

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

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.

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

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

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

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

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

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

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

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

zoomed boolean -- Whether the window is currently zoomed.

visible boolean -- Whether the window is currently visible.

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

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

miniaturized boolean -- Whether the window is currently miniaturized.

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

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 in Unicode text] -- The file in which to save the object.

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

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

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

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

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

[with properties record] -- The initial values for properties of 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 a list of alias -- list of objects

print: Print an object.

print a list of alias -- list of objects

quit: Quit an application.

quit reference -- the object for the command

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

save: Save an object.

save reference -- the object for the command

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

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

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:

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

character 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

word 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:

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

character 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

word 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.

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

color color -- The color of the first character.

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

Class character: This subdivides the text into characters.

Plural form:

characters

Elements:

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

character 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

word 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.

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

color color -- The color of the first character.

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

Class paragraph: This subdivides the text into paragraphs.

Plural form:

paragraphs

Elements:

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

character 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

word 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.

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

color color -- The color of the first character.

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

Class text: Rich (styled) text

Elements:

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

character 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

word 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.

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

color color -- The color of the first character.

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

Class word: This subdivides the text into words.

Plural form:

words

Elements:

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

character 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

word 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.

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

color color -- The color of the first character.

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

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

Classes:

Class application: The Disk-Folder-File Suite host program

Plural form:

applications

Elements:

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

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

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

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

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

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

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

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

folder action 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

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

Properties:

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

folder actions enabled boolean -- Are Folder Actions currently being processed?

properties anything -- every property of the Disk-Folder-File Suite host program

Class disk: A disk in the file system

Plural form:

disks

Elements:

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

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

item 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.

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

properties anything -- every property of the disk

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

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

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

ignore privileges boolean [r/o] -- Ignore permissions on this disk?

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

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

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

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

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

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

Class file: A file in the file system

Plural form:

files

Elements:

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

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

item 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.

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

size unsigned integer [r/o] -- the logical size of the file

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

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

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

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

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

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

properties anything -- every property of the file

stationery boolean -- Is the file a stationery pad?

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

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

Class folder: A folder in the file system

Plural form:

folders

Elements:

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

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

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

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

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

item 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.

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

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

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

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

properties anything -- every property of the folder

Class item: An item in the file system

Plural form:

items

Elements:

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

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

item 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.

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

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

modification date anything [r/o] -- the date on which the item was last modified

url Unicode text [r/o] -- the url of the item

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

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

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

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

visible boolean [r/o] -- Is the item visible?

properties anything -- every property of the item

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

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

Folder Actions Suite: Terms and Events for controlling Folder Actions

Classes:

Class application: The Folder Actions Suite host program

Plural form:

applications

Elements:

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

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

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

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

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

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

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

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

folder action 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

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

Properties:

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

folder actions enabled boolean -- Are Folder Actions currently being processed?

properties anything -- every property of the Folder Actions Suite host program

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.

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

name Unicode text [r/o] -- the name of the folder action, which is also the name of the folder

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

properties anything -- every property of the folder action

Class script: A script invoked by a folder action

Plural form:

scripts

Properties:

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

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

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

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

properties anything -- every property of the script

Events:

attach action to: Attach an action to a folder

attach action to reference -- the object for the command

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

Result: anything -- the reply for the command

attached scripts: List the actions attached to a folder

attached scripts reference -- the object for the command

Result: anything -- the reply for the command

do folder action: Event the Finder sends to the Folder Actions FBA

do folder action reference -- the object for the command

[with window size bounding rectangle] -- the new window size for the folder action message to process

[with item list anything] -- a list of items for the folder action message to process

folder action code items added/items removed/window closed/window moved/window opened -- the folder action message to process

Result: anything -- the reply for the command

edit action of: Edit as action of a folder

edit action of reference -- the object for the command

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

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

Result: anything -- the reply for the command

remove action from: Remove a folder action from a folder

remove action from reference -- the object for the command

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

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

Result: anything -- the reply for the command

Power Suite: Terms and Events for controlling System power

Classes:

Class application: The System Events application

Plural form:

applications

Elements:

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

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

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

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

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

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

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

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

folder action 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

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

Properties:

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

folder actions enabled boolean -- Are Folder Actions currently being processed?

properties anything -- every property of the System Events application

Events:

restart: Restart the computer

restart reference -- the object for the command

shut down: Shut Down the computer

shut down reference -- the object for the command

sleep: Put the computer to sleep

sleep reference -- the object for the command

Processes Suite: Terms and Events for controlling Processes

Classes:

Class application: The Processes Suite host program

Plural form:

applications

Elements:

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

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

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

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

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

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

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

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

folder action 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

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

Properties:

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

folder actions enabled boolean -- Are Folder Actions currently being processed?

properties anything -- every property of the Processes Suite host program

Class application process: A process launched from an application file

Plural form:

application processes

Properties:

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

application file anything [r/o] -- a reference to the application file from which this process was launched

Class desk accessory process: A process launched from an desk accessory file

Plural form:

desk accessory processes

Properties:

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

desk accessory file anything [r/o] -- a reference to the desk accessory file from which this process was launched

Class process: A process running on this computer

Plural form:

processes

Properties:

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

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

has scripting terminology boolean [r/o] -- Does the process have a scripting terminology, i.e., can it be scripted?

file anything [r/o] -- the file from which the process was launched

accepts high level events boolean [r/o] -- Is the process high-level event aware (accepts open application, open document, print document, and quit)?

partition space used unsigned integer [r/o] -- the number of bytes currently used in the process' partition

classic boolean [r/o] -- Is the process running in the Classic environment?

file type Unicode text [r/o] -- the OSType of the file type of the process

visible boolean [r/o] -- Is the process' layer visible?

total partition size unsigned integer [r/o] -- the size of the partition with which the process was launched

frontmost boolean [r/o] -- Is the process the frontmost process

accepts remote events boolean [r/o] -- Does the process accept remote events?

properties anything -- every property of the process

creator type Unicode text [r/o] -- the OSType of the creator of the process (the signature)

System Events Suite: Terms and Events for controlling the System Events application

Classes:

Class application: The System Events application

Plural form:

applications

Elements:

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

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

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

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

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

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

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

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

folder action 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

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

Properties:

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

folder actions enabled boolean -- Are Folder Actions currently being processed?

properties anything -- every property of the System Events application

Events:

do script: Execute an OSA script.

do script reference -- the object for the command

Login Items Suite: Terms and Events for controlling the Login Items application

Classes:

Class application: the Login Items Suite host program

Plural form:

applications

Elements:

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

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

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

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

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

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

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

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

folder action 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

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

Properties:

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

folder actions enabled boolean -- Are Folder Actions currently being processed?

properties anything -- every property of the Login Items Suite host program

Class login item: an item to be launched or opened at login

Plural form:

login items

Properties:

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

name Unicode text [r/o] -- the name of the Login Item

kind Unicode text [r/o] -- the file type of the Login Item

path Unicode text [r/o] -- the file system path to the Login Item

hidden boolean -- Is the Login Item hidden when launched?

 

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/SystemEvents_110_asDict..html
|| created: 11-Aug-03, 2:48 PM; updated: 11-Aug-03, 2:47 PM
|| size: 118663 bytes