Dreamweaver API リファレンス

2.0 以上

引数で指定したファイルの DOM オブジェクトを返します。DOM オブジェクトを利用して、ファイルを編集することが出来ます。Dreamweaver で一番よく使う関数です。

sourceDoc
"document"、"parent"、"parent.frames[数字]"、"parent.frames['フレーム名']"、または URL 形式( file:///〜 )でファイル名を指定します。
"document"
現在編集しているファイルを指定する場合に使用します。
"parent"
現在編集しているドキュメントがフレーム内のファイルの場合に、そのフレームセットのファイルを指定する場合に使用します。
"parent.frames[ 数字 ]" および "parent.frames['フレーム名']"
現在編集しているドキュメントがフレーム内のファイルの場合に、現在編集しているファイル以外のフレームセット内のファイルを指定する場合に使用します。
注意：
１．
引数が document を使用する場合には、この関数の呼び出し元が applyBehavior()、deleteBehavior()、objectTag()、もしくはコマンドまたはプロパティインスペクタ内の関数である必要があります。 それ以外では、取得することは出来ません。
２．
引数が相対 URL の場合、この関数を呼び出した拡張ファイルを基準 URL とします。
３．
Dreamweaver 3 では sourceDoc を指定しない場合、"document" を使用します。

指定したファイルの DOM オブジェクトを返します。

現在編集中のファイルの背景色を黒に変更します。
var theDOM = dw.getDocumentDOM( "document" );
theDOM.body.bgcolor = "#000000";

2.0 以上

ファイルを新規作成します。作成したファイルをドキュメントウィンドウで開き、ウィンドウをアクティブにします。
注意：
この関数は、メニュー、または、コマンド、プロパティインスペクタファイル内でのみ呼び出すことができます。ビヘイビアやオブジェクトがこの関数を呼び出そうとすると、Dreamweaver はエラーメッセージを表示します。

bOpenInSameWindow
この引数には、新規ドキュメントを現在のウィンドウで開くかどうかを示すブール値を指定します。引数を指定しない場合は、別の新しいウィンドウを開きます。また、Macintosh 版でこの関数を呼び出す場合は、常に別のウィンドウが開きます。

新規作成されたファイルの DOM オブジェクト。dw.getDocumentDOM() の戻り値と同じです。

新規にウィンドウを作成し、そのファイルの背景色を黒に変更します。
var theDOM = dw.createDocument();
theDOM.body.bgcolor = "#000000";

2.0 以上

指定したファイルをドキュメントウィンドウで開き、そのウィンドウをアクティブにします。指定したファイルがすでに開いている場合は、その開いているウィンドウをアクティブにし前面に表示します。
注意：
ビヘイビアやオブジェクトファイルからこの関数を呼び出すと、エラーが発生します。

fileName
開くファイルを URL 形式で指定します。相対 URL を指定した場合、この関数を呼び出した拡張ファイルを基準 URL とします。

指定したファイルの DOM オブジェクト。dw.getDocumentDOM() の戻り値と同じです。

index.htmを開き、背景色を黒に変更します。
var theDOM = dw.openDocument( "file:///d|/site/index.htm" );
theDOM.body.bgcolor = "#000000";

2.0 以上

指定したファイルを保存します。

documentObject,fileURL
documentObject
保存するDOM オブジェクトを指定します。
fileURL
ファイルの保存先をURL 形式で指定します。Dreamweaver 2 では、２番目の引数は必須ですが、Dreamweaver 3 では、すでに一度保存したことのある DOM オブジェクトであれば、省略することが出来ます。ファイルを相対 URL で指定した場合には、この関数を呼び出した拡張ファイルを基準 URL とします。

保存に成功した場合は true、失敗した場合は false を返します。

現在編集中のファイルを保存します。
var theDOM = dw.getDocumentDOM( "document" );
dw.saveDocument( theDOM, "file:///d|/site/index.htm" );

3.0

指定したウィンドウを閉じます。

documentObject
閉じたいドキュメントの DOM オブジェクトを指定します。

なし

現在の編集中のウィンドウを閉じます。
var theDOM = dw.getDocumentDOM( "document" );
dw.closeDocument( theDOM );

2.0 以上

DOM オブジェクトをメモリから開放します。dreamweaver.getObjectTags()、dreamweaver.getObjectRefs()、dreamweaver.getDocumentPath()、または dreamweaver.getDocumentDOM() が参照した DOM オブジェクトは、その関数を呼び出したスクリプトが実行を終了した際に自動的に解放されますが、スクリプト内で開くドキュメントの数が多い場合に、スクリプトが終了する前にこの関数を使ってDOM オブジェクトを解放し、メモリ不足を防ぐことが出来ます。。
注意:
この関数で効果があるのは、URL指定して取得した DOM オブジェクトに対して効果があります。現在編集中のファイルのメモリを開放することは出来ません。また、拡張ファイルは起動時にメモリへロードされ、Dreamweaver を終了するまで解放されません。

documentObject
メモリから開放したい DOM オブジェクトを指定します。

なし

openDocument() 関数で取得した DOM オブジェクトを開放します。
var theDOM = dw.openDocument( "file:///d|/site/index.htm" );
dw.releaseDocument( theDOM );

2.0 以上

Configuration フォルダのパスを URL 形式で取得します。 この関数は、Dreamweaver をインストールしたフォルダにある Configuration フォルダに保存されている拡張ファイルに参照する場合に便利です。

なし。

Configuration フォルダのパスの文字列

Configuration フォルダ内にある Image.htm のDOM オブジェクトを取得します。
var imgPath = dw.getConfigurationPath() + "/Objects/Common/Image.htm"
var imgDOM = dw.getDocumentDOM( imgPath );

1.2 以降

指定したファイルのパスを URL 形式で取得します。

sourceDoc
"document"、"parent"、"parent.frames[数字]"、"parent.frames['フレーム名']"を指定します。
"document"
現在編集しているファイルを指定する場合に使用します。
"parent"
現在編集しているドキュメントがフレーム内のファイルの場合に、そのフレームセットのファイルを指定する場合に使用します。
"parent.frames[ 数字 ]" および "parent.frames['フレーム名']"
現在編集しているドキュメントがフレーム内のファイルの場合に、現在編集しているファイル以外のフレームセット内のファイルを指定する場合に使用します。
注意：
引数が document を使用する場合には、この関数の呼び出し元が applyBehavior()、deleteBehavior()、objectTag()、もしくはコマンドまたはプロパティインスペクタ内の関数である必要があります。 それ以外では、取得することは出来ません。

ファイルのURL 形式のパスを返します。保存されていないファイルの場合は、空の文字列を返します。

下のコードは同じ結果を返します。
１．
var path = dw.getDocumentPath( "document" );
２．
var theDOM = dw.getDocumentDOM( "document" );
var path = theDOM.URL;

1.2 以上

現在編集中のファイルが含まれているサイトのルートフォルダをURL 形式で取得します。

なし。

サイトのルートフォルダのパスをURL 形式の文字列で返します。編集中のファイルが保存されていない場合は、空の文字列を返します。

ルートフォルダにある index.htm の DOM オブジェクトを取得します。
var index = dw.getSiteRoot() + "index.htm";
var theDOM = dw.getDocumentDOM( index );

2.0 以上

指定した相対パスを、絶対パスに変更します。相対パスから絶対パスを変更するには、基準URL を指定します。

relURL, docPath, siteRoot
relURL
変換したい相対パスを指定します。
docPath
基準とするドキュメントのパスをURL 形式で指定します。relURL が ルートフォルダからの相対URL の場合には、空の文字列を指定します。
siteRoot
サイトのルートフォルダのパスをURL 形式で指定します。relURL が ドキュメントからの相対URL の場合には、空の文字列を指定します。

絶対パスに変換されたURL 形式の文字列を返します。

ドキュメントからの相対パスである画像のパスを絶対パスに変更します。
var imgPath = "image/title.gif";
var docPath = dw.getDocumentPath( "document" );
var imgFullPath = dw.relativeToAbsoluteURL( imgPath, docPath, "" );

2.0 以上

ブラウザで指定した URL を開きます。 ヘルプファイルを開く場合に使用されている関数です。

fileName,browserName
fileName
ブラウザで開くファイル名を絶対 URL で指定します。
browserName
Dreamweaver 3 から追加された引数で、ファイルを開きたいブラウザ名を指定します。ブラウザ名には、環境設定で定義されているブラウザの名前を指定します。指定しない場合は、プライマリブラウザが使用されます。

なし。

次の関数は、dw.browseDocument() を使ってブラウザで HotWired のホームページを開きます。
function goToHotwired()
{
dw.browseDocument('http://www.hotwired.com/');
}
Dreamweaver 3 では下のように、指定したブラウザで開くことができます。
function goToHotwired()
{
var prevBrowsers = dw.getBrowserList();
var theBrowser = "";
for( var i = 1; i < prevBrowsers.length; i+=2 )
{
if( prevBrowsers[ i ].indexOf( 'Iexplore.exe' ) != -1 )
{
theBrowser = prevBrowsers[i];
break;
}
}
dw.browseDocument( 'http://www.hotwired.com/',theBrowser );
}

1.0 以上

ファイルを選択するダイアログを表示します。

openSelectOrSave,titleBarLabel,bShowPreviewPane,bSupressSiteRootWarnings
openSelectOrSave
ダイアログボックスのタイプを指定します。"open"、"select"、"save" を指定し、"open" はファイルを開くダイアログ、"select" はファイル選択ダイアログ、"save" はファイル保存ダイアログになります。
titleBarLabel
Dreamweaver 2 から追加された引数です。ダイアログボックスのタイトルバーに表示するラベルを指定します。この引数を指定しない場合は、OS の初期設定のラベルが表示されます。
bShowPreviewPane
Dreamweaver 2 から追加された引数です。ダイアログボックスに画像のプレビューパネルを表示するかどうかを指定します。表示する場合は true、表示しない場合は falseを設定します。true に設定した場合には、ダイアログボックスでは、画像ファイル以外のファイルを表示されないようになります。この引数を指定しない場合は、プレビューパネルは表示されません。
bSupressSiteRootWarnings
Dreamweaver 3 から追加された引数です。これには選択されたファイルがサイトルートの外にあるという警告を非表示にするかどうか指定します。警告を非表示にする場合には true、表示する場合は false を設定します。この引数を指定しない場合は、警告が表示されます。

選択したファイルのパスを URL 形式の文字列で返します。 ダイアログをキャンセルした場合は空の文字列を返します。

ファイル選択ダイアログを表示し、選択したファイルの DOM オブジェクトを取得します。
var filePath = dw.browseForFileURL( "select", "ファイルを選択", false, false );
var theDOM = dw.getDocumentDOM( filePath );

3.0

フォルダの選択ダイアログを表示します。

titleBarLabel,directoryToStartIn
titleBarLabel
ダイアログボックスのタイトルバーに表示するラベルを指定します。titleBarLabel を指定しない場合は、"Choose Folder" をラベルに表示します。
directoryToStartIn
フォルダ選択ダイアログの初期フォルダのパスを URL 形式で指定します。

フォルダのパスを URL形式の文字列で返します。ダイアログをキャンセルした場合は空の文字列を返します。

サイトルートを初期フォルダとして、フォルダ選択ダイアログを表示します。
dw.browseForFolderURL( "フォルダを選択", dw.getSiteRoot() );

1.0

指定したドキュメント中に含まれる指定したタグをすべて検索し、JavaScript の参照名の一覧を指定したブラウザの参照方式で取得します。

NSorIE, sourceDoc, {tag1}, {tag2},...{tagN}
NSorIE
関数が返す参照名の参照方式を指定します。指定方法は "NS 4.0" または "IE 4.0" のどちらかで、"NS 4.0" は Netscape Navigator 4.0、"IE 4.0" は Internet Explorer 4.0 方式となります。
sourceDoc
"document"、"parent"、"parent.frames[数字]"、"parent.frames['フレーム名']"を指定します。
"document"
現在編集しているファイルを指定する場合に使用します。
"parent"
現在編集しているドキュメントがフレーム内のファイルの場合に、そのフレームセットのファイルを指定する場合に使用します。
"parent.frames[ 数字 ]" および "parent.frames['フレーム名']"
現在編集しているドキュメントがフレーム内のファイルの場合に、現在編集しているファイル以外のフレームセット内のファイルを指定する場合に使用します。
{tag1}, {tag2},...{tagN}
取得するタグ名（たとえば "IMG"、"FORM"、"HR" など）を指定します。複数のタグを取得する場合には、引数を追加します。

取得したJavaScript 参照名のリストを返します。
注意：
１．
ブラウザの参照方式によって、取得できるタグの種類が違います。
Internet Explorer
A、AREA、APPLET、EMBED、DIV、SPAN、INPUT、SELECT、OPTION、TEXTAREA、OBJECT、および IMG タグ
Netscape Navigator
A、AREA、APPLET、EMBED、LAYER、ILAYER、SELECT、OPTION、TEXTAREA、OBJECT、および IMG タグ、そして絶対位置指定された DIV および SPAN タグで、絶対位置指定されていない DIV と SPAN タグは "cannot reference <tag>" という参照名を返します。
２．
取得するタグに name 属性も id 属性もない場合は、"unnamed <tag>" という参照名を返します。ブラウザが名前による参照方法をサポートしない場合、Dreamweaver はインデックスを使ってオブジェクトに参照します。
３．
名前のないフォームやレイヤーに含まれていても、取得するタグに、name 属性が設定されている場合は、参照名を取得することができません。

現在のページ中に含まれるIMG タグの参照名のリストを返します。
var imgList = dw.getObjectRefs("NS 4.0", "document", "IMG");
imgListの内容
"document.bullet"
"document.layers['headerLayer'].document.header"
"document.photoLayer.document.headshot"

1.0以上

指定したドキュメント中に含まれる指定したタグをすべて検索し、タグの内容の一覧を取得します。

sourceDoc, {tag1}, {tag2},...{tagN}
sourceDoc
"document"、"parent"、"parent.frames[数字]"、"parent.frames['フレーム名']"を指定します。
"document"
現在編集しているファイルを指定する場合に使用します。
"parent"
現在編集しているドキュメントがフレーム内のファイルの場合に、そのフレームセットのファイルを指定する場合に使用します。
"parent.frames[ 数字 ]" および "parent.frames['フレーム名']"
現在編集しているドキュメントがフレーム内のファイルの場合に、現在編集しているファイル以外のフレームセット内のファイルを指定する場合に使用します。
{tag1}, {tag2},...{tagN}
取得するタグ名（たとえば "IMG"、"FORM"、"HR" など）を指定します。複数のタグを取得する場合には、引数を追加します。

取得したタグのHTMLの内容のリストを返します。
注意:
１．
取得したい引数に LAYER を指定した場合、LAYER タグと ILAYER タグおよび、すべての絶対位置指定された DIV タグと SPAN ラグの内容を返します。
２．
取得したい引数に INPUT を指定した場合、すべてのINPUT タグの内容を返しますが、特定のテキストフィールドやリストボックスなど内容を取得したい場合には、タグ名の指定に INPUT/TYPE と指定します。TYPE は button、text、radio、checkbox、password、textarea、select、hidden、reset、または submit のいずれかを指定します。

現在編集中のファイルから、IMG タグの内容を取得します。
var imgList = dw.getObjectTags( "document", "IMG" );
imgList の内容
'<IMG SRC="/images/dot.gif" WIDTH="10" HEIGHT="10" NAME="bullet">'
'<IMG SRC="header.gif" WIDTH="400" HEIGHT="32" NAME="header">'
'<IMG SRC="971208_nj.jpg" WIDTH="119" HEIGHT="119" NAME="headshot">'

1.0 以上

指定した文字列を区切り文字で、複数の文字列に分割します。

searchString, separatorCharacters
searchString
分割する文字列を指定します。
separatorCharacters
区切り文字を指定します。文字を複数設定する場合には、文字列で指定します。空白を設定すると、タブなどのすべてのホワイトスペースが区切り文字として処理されます。

分割した文字列のリストを返します。

文字列 'foo("my arg1", 34)' を '(),' で分割します。
var strList = dw.getTokens('foo("my arg1", 34)', '(),');
strList の内容
'foo '
'"my arg 1" '
'34'

3.0

指定したコマンドファイルを実行します。この関数を使えば、オブジェクトやインスペクタなどの拡張ファイルからコマンドを呼び出すことができます。

注意：
この関数は、オブジェクトの objectTag()関数内、コマンド、プロパティインスペクタまたはメニューからしか呼び出すことは出来ません。

commandFile, {commandArg1}, {commandArg2},...{commandArgN}
commandFile
Dreamweaver のインストールしたフォルダ内にある Configuration/Commands フォルダ内に保存されている コマンドファイルを指定します。
{commandArg1}, {commandArg2},...{commandArgN}
2 番目以降の引数は、コマンドファイルに引数として渡されます。コマンドファイルは、recieveArgument 関数で受け取ります。

なし

コマンドの「ソースフォーマットの適用」を実行します。
dw.runCommand( "Apply Source Formatting.htm" );

3.0

指定した文字列を "~" を%7E、" " を%20のように、URL エンコーディングします。

urlString
URL エンコーディングする文字列を指定します。

URL エンコーディングした後の文字列を返します。

"http://www.game3rd.com/~tomohiro/home site.htm" を URL エンコーディングし、alert で表示します。
var str = "http://www.game3rd.com/~tomohiro/home site.htm";
alert( dw.doURLEncoding( str ) );

3.0

この関数を呼び出すスクリプトの実行が終了した後、Dreamweaver を終了します。

なし。

なし。

ダイアログを表示し、「OK」ボタンを押すと Dreamweaver を終了します。
if( confirm( "終了しますか？" ) )
dw.quitApplication();

3.0

DOM オブジェクト内で、選択している オブジェクトを取得します。

なし。

現在選択している HTML、テキスト、またコメントオブジェクトを返します。

現在選択しているオブジェクトのタグの種類を調べます。
var theDOM = dw.getDocumentDOM( "document" );
var node = theDOM.getSelectedNode();
alert( node.tagName );

3.0

DOM オブジェクト内で、現在選択している範囲を HTML ソースでの位置を取得します。

bAllowMultiple
この引数には、複数のテーブルセル、イメージマップホットスポット、またはレイヤーが現在選択されている場合にこの関数が複数の選択位置を返すかどうか指定します。選択位置を複数返したい場合は true を指定し、複数の選択位置を返す必要がない場合は false を指定します。引数を指定しない場合は、複数の選択位置を返しません。

選択範囲の位置をリストで返します。最初のリスト値には選択範囲の開始位置、２番目のリスト値には、選択範囲の終了位置が返されます。この二つの値が同じ場合は、選択されていない状態を示します。複数の選択範囲を返す場合には、開始位置と終了位置がペアとなり、複数の選択範囲のリストが返されます。

現在の選択範囲内にあるテキストを表示します。
var theDOM = dw.getDocumentDOM( "document" );
var selArray = theDOM.getSelection();
var outerHTML = theDOM.documentElement.outerHTML;
alert( outerHTML.substring( selArray[ 0 ], selArray[ 1 ] ) );

3.0

DOM オブジェクト中に含まれる HTML、テキスト、コメント等のオブジェクトのHTMLソースでの位置を取得します。

node
ソースの位置を取得する DOM オブジェクト中に含まれているオブジェクトを指定します。

オブジェクトの位置をリストで返します。最初のリスト値には選択範囲の開始位置、２番目のリスト値には、選択範囲の終了位置が返されます。

現在のドキュメント内に含まれる最初のイメージオブジェクトのソースを表示します。
var theDOM = dw.getDocumentDOM( "document" );
var theImg = theDOM.images[0];
var selArray = theDOM.nodeToOffsets(theImg);
var outerHTML = theDOM.documentElement.outerHTML;
alert( outerHTML.substring( selArray[ 0 ], selArray[ 1 ] ) );

3.0

HTML ソース中の範囲を指定し、その範囲に対応した HTML、テキスト、コメント等のオブジェクトを取得します。

offsetBegin, offsetEnd
offsetBegin
オブジェクトを取得するHTML ソースでの開始位置を指定します。
offsetEnd
オブジェクトを取得するHTML ソースでの終了位置を指定します。

指定した範囲に対応した HTML、テキスト、コメント等のオブジェクトを返します。

現在選択しているオブジェクトのタグの種類を調べます。
var theDOM = dw.getDocumentDOM( "document" );
var selArray = theDOM.getSelection();
var theSelection = theDOM.offsetsToNode( selArray[ 0 ], selArray[ 1 ] );
alert( theSelection.tagName );

3.0

指定したオブジェクトを、現在の選択範囲に設定します。

node,bSelectInside,bJumpToNode
node
選択範囲に設定するオブジェクトを指定します。
bSelectInside
node で指定したオブジェクトの innerHTML を選択範囲とするかどうかを指定します。選択範囲とする場合は true、選択範囲としない場合は false を指定します。この引数を指定しない場合は、innerHTML を選択範囲としません。
bJumpToNode
選択範囲に変更した部分をドキュメントウィンドウ上に表示されるように、ドキュメントウィンドウをスクロールさせるかどうか指定します。スクロールさせる場合は true を指定し、スクロールさせない場合は false を指定します。この引数を指定しない場合は、スクロールさせません。

なし。

現在のドキュメント内に含まれる最初のイメージオブジェクトを選択範囲に変更します。
var theDOM = dw.getDocumentDOM( "document" );
var theImg = theDOM.images[0];
theDOM.setSelectedNode( theImg );

3.0

指定したHTMLソースの範囲を、現在の選択範囲に設定します。

offsetBegin, offsetEnd

offsetBegin
選択範囲に設定するHTML ソースでの開始位置を指定します。
offsetEnd
選択範囲に設定するHTML ソースでの終了位置を指定します。
注意：
指定する選択範囲の位置がタグの内部の含まれている場合は、タグが正しく収まるように選択範囲の位置を拡張します。例えば、offsetBegin と offsetEnd によって指定する範囲が <IMG SRC="myImage.gif"> のうち SRC="myImage.gif" という部分だけである場合には、IMG タグ全体が含まれるように選択範囲を拡張します。

なし。

最初から100バイト目までの位置を選択範囲に設定します。
var theDOM = dw.getDocumentDOM( "document" );
theDOM.setSelection( 0, 100 );