例として作成した次の 2 つのリファレンス項目は、"現実世界" のペットの犬 (dog) とサボテンの世話 (plant) を使って、『AppleScript リファレンス』の構成を説明しています。各例の後に、実際の項目がこれら例として作成した項目とどのように異なっているかを説明しています。
狼に非常によく似た哺乳動物。Class。
複数形
dogs
要素
ear (耳) 数値インデックス、条件によりアクセス。
eye (目) 数値インデックス、条件によりアクセス。
leg (脚部) 数値インデックス、条件によりアクセス。
nose (鼻)
paw (足) 数値インデックス、条件によりアクセス。
tail (尾)
tongue (舌)
tooth (歯) 数値インデックス、条件によりアクセス。
属性
age (年齢)、breed (種類)、color (色)、favorite toy (好みの玩具)、housebroken (従順性)、last vacination (最後の予防接種)、name (名前)、neutered (去勢)、sex (性別)、size (体長)
解説
このクラスは、侵入者を撃退するのに役立ちます。その上、しばしば親愛の情を示します。family (家庭) クラスおよび K9 corps (軍用犬部隊) クラス両方の要素となります。
dog の各 paw 要素には、数個の claw (爪) および toe (指) 要素が含まれます。
train (訓練) コマンドを使って、dogs に芸を仕込むことができます。この操作はエラーを返しますので、try (試みる) ブロック内にコマンドを配置してください。
dog の ear、eye、eyebrow (眉毛)、leg、paw、および tooth 要素は、すべて数値インデックスによってアクセスされますが、nose、tail、および tongue 要素はその限りではありません。各 dog には、これらの要素が 1 つずつしか含まれていないからです。
例
set the last vaccination of dog "Sparky" ¬
of household "Someone" to "September 5, 1999"
メモ クラスおよび属性の項目は、非常によく似ていますが、クラスではなく属性の項目である場合は、「複数形」、「要素」、または「属性」のセクションを含むのではなく、どのクラスがそれを属性として持っているかを示すセクションを先頭に含みます。たとえば、selected text クラスには、application の属性であることを示す「所属する属性」セクションが含まれます (リファレンス項目参照)。
属性の値が数えられる場合、属性のデータ タイプは項目内では示されません。たとえば、ここであげた dog の例でいうと、breed 属性では通常のデータ タイプではなく、Boxer、Chow、Husky、German Shepherd などの設定可能な値が使用されることになります。属性が、標準のデータ タイプではなく数えられる値を使用する場合、項目には「設定可能な値」セクションが含まれます。
指定された植物を、生育可能な土地に植えます。Command。
構文
plant Reference [in Location Reference using Reference]
結果
Boolean
解説
最初のパラメータ Reference は、潅木、高木、つる植物など、土地に植える植物を指定します。省略可能な in パラメータは植える場所を指定し、省略可能な using パラメータはシャベルなどの穴を埋める道具を指定します。
結果は、作業の成功または失敗を示す Boolean です。true の値は、植物が正常に植えられたことを示します。
例
plant cactus 23 in desert "Mojave" ¬
using shovel 1 of backpack "Someone's Backpack"
メモ コマンドから返される値が通常と異なる場合、コマンドのリファレンス項目には、「例」セクションの後に、コマンドが返す値を示す「例の結果」セクションが含まれます。
次に示す項目は、特に示さない限り、クラスまたは属性ではなく、すべてコマンドです。
Internet Explorer をアクティブにし、指定されている場合は個別のウィンドウを表示します。
構文
Activate [Integer]
結果
Integer
解説
単独のパラメータ Integer は、Internet Explorer がアクティブになったときに表示されるウィンドウの ID を指定します。-1 の値を使って、アクティブ ウィンドウを指定できます。ListWindows コマンドを使って、開いているウィンドウの ID のリストを取得することもできます。
結果 Integer は、Internet Explorer がアクティブになった後の、アクティブ ウィンドウのウィンドウ ID を示します。
例
tell application "Internet Explorer"
Activate
OpenURL "http://www.microsoft.com/"
end tell
Internet Explorer アプリケーションそのもの。Class。
属性
selected text
解説
application クラスは、このクラスの selected text 属性のため以外にはほとんど使用しません。Internet Explorer の今後のリリースで、使用方法が変更される可能性があります。
Internet Explorer のすべてのウィンドウを閉じます。
構文
CloseAllWindows
結果
Boolean
解説
このコマンドはパラメータを持ちません。ただし、その結果の Boolean は、CloseAllWindows の操作が成功したかどうかを示します。true の値は、すべてのウィンドウが閉じられたことを示します。
このコマンドの戻り値を決定する必要がない場合、あとの「例」は、次のように省略することができます。
CloseAllWindows
例
set AllClosed to CloseAllWindows
ウィンドウの ID またはタイトルで指定されたウィンドウを閉じます。
構文
CloseWindow [ID Integer] [Title String]
結果
Boolean
解説
省略可能な ID パラメータは、閉じるウィンドウの ID を指定します。ID は ListWindows などのコマンドで取得できます。-1 の値を使って、アクティブ ウィンドウを指定できます。パラメータを省略すると、現在アクティブな Internet Explorer ウィンドウが閉じられます。
省略可能な Title パラメータは、閉じるウィンドウのタイトルを指定します。ID とタイトルの両方を指定しなかった場合は、アクティブ ウィンドウが閉じられます。
結果の Boolean は、CloseWindow の操作が成功したかどうかを示します。true の値は、指定したウィンドウが閉じられたことを示します。
このコマンドの戻り値を決定する必要がない場合、あとの「例」は、次のように省略することができます。
CloseWindow ID -1
例
--Close active window
set FrontClosed to CloseWindow ID -1
JavaScript のコマンドを実行します。
構文
do script String [window Integer]
結果
String
解説
String パラメータは、実行する JavaScript のテキストを含みます。省略可能な window パラメータは、スクリプトを実行するウィンドウの ID を指定します。ListWindows コマンドを使って、ウィンドウ ID のリストを取得することができます。
必要な操作を行う AppleScript コマンドが Internet Explorer の用語説明にないときは、JavaScript が役に立ちます。AppleScript を使って、プログラムに基づいて JavaScript を生成することができます。AppleScript コード内の個別に構築したブロックから、JavaScript の式を系統的に構築することができます。
JavaScript の中には、Internet Explorer で少なくとも 1 つの Web ページが開いていなければ実行できないものもあります。
OpenURL コマンドを使って、複数行の JavaScript を実行することもできます。
例
--Count the number of links in the active window
set NumberOfLinks to do script "document.links.length"
--Find the URL of the active window
set CurrentURL to do script "document.location"
Internet Explorer ウィンドウの HTML ソースを取得します。
構文
GetSource [Integer]
結果
String
解説
省略可能な Integer パラメータは、ソースを取得するウィンドウのインデックスを指定します。パラメータを省略すると、現在アクティブな Internet Explorer ウィンドウが指定されます。
ListWindows コマンドを使って、ウィンドウ ID のリストを取得することができます。
例
set PageSource to GetSource
URL を開き、指定に従ってそのデータをディスクに保存します。
構文
GetURL String [to File Specification]
解説
省略可能な to パラメータは、データの保存先のファイルを指定します。このパラメータを省略すると、ブラウザはデータを保存しません。
例
GetURL theLink to file "Mac OS X:Users:Shared:example.html"
指定したウィンドウの URL とタイトルを、ウィンドウ情報レコードとして返します。
構文
GetWindowInfo Integer
結果
一覧
解説
このコマンドの唯一のパラメータ Integer は、URL とタイトルが必要なウィンドウの ID を指定します。ListWindows コマンドを使って、ウィンドウ ID のリストを取得することができます。ウィンドウ ID に -1 を使うと、アクティブ ウィンドウが指定されます。
このコマンドの結果はウィンドウ情報レコードです。これには、指定したウィンドウの URL とタイトルが含まれます。
次の例の結果は、GetWindowInfo コマンドを使った結果の典型的なウィンドウ情報レコードを示します。ウィンドウ情報レコードの先頭の項目は常にウィンドウの URL で、2番目の項目はタイトルになります。
例
--Get the window info of the frontmost window
set activeWindowID to item 1 of (ListWindows)
set activeWindowInfo to (GetWindowInfo activeWindowID)
--Get the URL of the active window
set MainURL to first item of (GetWindowInfo -1)
例の結果
開いているウィンドウすべてのリストを、ウィンドウ ID のリストとして取得します。リストの先頭の項目がアクティブ ウィンドウの ID で、そのほかのすべてのウィンドウ ID がその後に順番に続きます。
構文
ListWindows
結果
一覧
例
set activeWindowID to item 1 of (ListWindows)
set activeWindowInfo to GetWindowInfo activeWindowID
Internet Explorer でドキュメントを開きます。
構文
open List of Alias
例
open {alias "Mac OS X:Users:Shared:ex1.html", ¬
alias "Mac OS X:Users:Shared:ex2.html"}
ブックマーク ファイルを開きます。
構文
open bookmark Alias
解説
Alias パラメータには、ブックマーク ファイルへのエイリアスを指定する必要があります。Internet Explorer のお気に入りファイル、Netscape のブックマーク ファイル、または他の種類のリンクを含む HTML ファイルなどを指定することができます。
指定したブックマーク ファイルが使用できない場合は、Internet Explorer が現在のブックマーク ファイルを更新し、開かれたファイル内にあるリンクをお気に入りファイルに追加します。
リンクを含む HTML ファイルが読み込まれることもありますが、そのようなページはすべて適切ではありません。リンクが説明的な名前を持っているようなページが最適に動作します。
例
open bookmark alias "Mac OS X:Users:Shared:MyBookmarks.html"
Web から URL を取得します。
構文
OpenURL String [to File Specification] [toWindow Integer] [Flags Integer] [FormData Anything] [MIMEType String]
解説
省略可能な to パラメータは、ダウンロードしたデータの保存先のファイルを指定します。一方、省略可能な toWindow パラメータは、URL を開くウィンドウを指定します。toWindow に -1 の値を使用すると、ブラウザはアクティブ ウィンドウにその URL を開きます。0 の値を使用すると、新しいウィンドウに開きます。
省略可能な Flags パラメータの有効な値は 1 (URL を開いている間、ドキュメント キャッシュを無視する)、2 (URL を開いている間、イメージ キャッシュを無視する)、および 4 (バックグラウンド モードで動作する) です。これらのフラッグ値は、値を合計してまとめて追加することができます。たとえば、3 の値は、ドキュメント キャッシュとイメージ キャッシュの両方を無視します。
省略可能な MIMEType パラメータは、FormData パラメータに指定されたフォーム データの MIME タイプを指定します。
次の例 1 は、OpenURL コマンドを使って、セミコロンで区切られた複数行の JavaScript コードからなる JavaScript を実行する方法を示します (do script コマンドも参照してください)。JavaScript の中には、Internet Explorer で少なくとも 1 つの Web ページが開いていなければ実行できないものもあります。
例
OpenURL ("javascript:window.moveTo((screen.width/2)+10,40);
window.resizeTo((screen.width/2)-15,(screen.height-50))")
OpenURL (theLink) to OutputFile
基本となる URL 相対 URL を組み合わせて、完全に制限された URL を作成します。
構文
ParseAnchor String withURL String
結果
String
解説
最初のパラメータは、http://www.microsoft.com のような基本となる URL を表します。2 番目のパラメータは mac/ie/ のような相対 URL を表します。この場合の結果は、完全に制限された URL http://www.microsoft.com/mac/ie/ (Mactopia のWeb サイト) になります。
例
set theURL to ParseAnchor "http://www.microsoft.com" withURL "mac/ie/"
ファイルを印刷します。
構文
print List of Alias
例
print {alias "Mac OS X:Users:Shared:ex1.html", ¬
alias "Mac OS X:Users:Shared:ex2.html"}
ブラウザ ウィンドウのコンテンツを印刷します。
構文
PrintBrowserWindow [Integer]
解説
省略可能な Integer パラメータは、印刷するウィンドウのインデックスを指定します。パラメータを省略すると、現在アクティブな Internet Explorer ウィンドウが指定されます。
例
with timeout of 180 seconds
PrintBrowserWindow
end timeout
Internet Explorer を終了します。
構文
quit
例
tell application "Internet Explorer"
quit
end tell
Internet Explorer を実行します。
構文
run
例
tell application "Internet Explorer"
run
end tell
現在選択されているテキストです。読み込み専用の String。
所属する属性
application
解説
selected text 属性には、アクティブな Internet Explorer ウィンドウで現在選択されているテキストが含まれます。
例
copy selected text to TheSelectedText
指定されたウィンドウの、指定された MIME タイプのデータを含む、指定されたファイルを表示します。
構文
ShowFile Alias [Mime Type String] [Window Identifier Integer] [URL String]
解説
最初のパラメータは、表示するファイルを示すエイリアスです。
省略可能な Mime Type パラメータは、表示されるファイルのデータに対する MIME タイプを指定します。
省略可能な Window Identifier パラメータは、ファイルを開くためのウィンドウの ID を指定します。ListWindows コマンドを使って、ウィンドウ ID のリストを取得することができます。
省略可能な URL パラメータは、ドキュメントが何らかの理由でファイル エイリアスから読み込まれなかった場合に、そのドキュメントを再読み込みするための URL を指定します。
例
ShowFile alias "example.html"