Dreamweaver API リファレンス

Dreamweaver3の頃は、日本語訳がなく、英語版のみ提供されていたので、勝手に翻訳して公開しています。現在のDreamweaverでは日本語訳が付いているので、今となっては役に立たないコンテンツです。ただ、共通ライブラリについては元からヘルプがないので、その部分は役に立つと思います。/Commonと/Classは/Configurations/Shared/MM/Scriptsフォルダ内にあるフォルダです。

このファイルは、Dreamweaver をインストールしたフォルダ内にある Configuration/Shared/MM/Scripts/Common フォルダに保存されています。ファイルには、現在編集しているページに関数情報を取得するための関数が記述されています。

  getAllObjectRefs ()
説明

dw.getObjectRefs()関数と同じ機能で、現在編集中のページに含まれる指定したタグをすべて検索し、そのタグのJavaScript の参照名の一覧を指定したブラウザの参照方式で取得します。現在のページがフレーム内にある場合は、フレームセット全体を検索し、JavaScript 参照名の一覧を取得します。

引数

browserType,{tag1}, {tag2},...{tagN}
browserType
関数が返す参照名の参照方式を指定します。指定方法は "NS 4.0" または "IE 4.0" のどちらかで、"NS 4.0" は Netscape Navigator 4.0、"IE 4.0" は Internet Explorer 4.0 方式となります。
{tag1}, {tag2},...{tagN}
取得するタグ名(たとえば "IMG"、"FORM"、"HR" など)を指定します。複数のタグを取得する場合には、引数を追加します。

戻り値

取得したJavaScript 参照名のリストを返します。

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


  getAllObjectTags ()
説明

dw.getObjectTags()関数と同じ機能で、指定したドキュメント中に含まれる指定したタグをすべて検索し、タグの内容の一覧を取得します。現在のページがフレーム内にある場合は、フレームセット全体を検索し、タグの内容の一覧を取得します。

引数

{tag1}, {tag2},...{tagN}
取得するタグ名(たとえば "IMG"、"FORM"、"HR" など)を指定します。複数のタグを取得する場合には、引数を追加します。

戻り値

取得したタグのHTMLの内容のリストを返します。

現在編集中のファイルから、IMG タグの内容を取得します。
var imgList = getAllObjectTags( "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">'


  getSelectedObj ()
説明

現在ページ中で選択しているオブジェクトを取得します。

引数

なし。

戻り値

現在選択されているオブジェクトを返します。

現在選択しているオブジェクトのタグの種類を調べます。
var theSelection = getSelectedObj();
alert( theSelection.tagName );


  createUniqueName ()
説明

他のタグの name 属性に重複しない名前を作成します。この関数を使えば、他のタグと重複しない name 属性を設定することが出来ます。

引数

tagName, tagString, arrToSearch
tagName
name 属性を取得したいタグ名(たとえば "IMG"、"FORM"、"HR" など)を指定します。
tagString
name 属性に設定したい名前を指定します。同じ名前が見つかった場合に、この名前の後に数字が追加されます。
arrToSearch
検索するタグの数を指定します。ページ中にタグの数が多い場合にこの引数を指定すると、この数以上のタグの重複チェックは行いません。

戻り値

他のタグのname 属性に重複しない名前を返します。

ページ中に含まれる FORM タグの name 属性に重複しない名前をもつ FORM タグを作成します。
var uniqueFormName = createUniqueName("FORM","form");
var addStr = '<form name="' + uniqueFormName + '">\n</form>';


  makeUniqueName ()
説明

createUniqueName() 関数とよく似ている機能ですが、name 属性の他に id 属性が重複しないようにタグの名前を作成します。

引数

tag, baseName
tag
name 属性を取得したいタグ名(たとえば "IMG"、"FORM"、"HR" など)を指定します。
baseName
name 属性に設定したい名前を指定します。同じ名前が見つかった場合に、この名前の後に数字が追加されます。

戻り値

他のタグのname 属性やid 属性に重複しない名前を返します。

ページ中に含まれる FORM タグの name 属性に重複しない名前をもつ FORM タグを作成します。
var uniqueFormName = makeUniqueName( "FORM","form" );
var addStr = '<form name="' + uniqueFormName + '">\n</form>';


  selectionInsideTag ()
説明

現在選択している範囲内に指定したタグが含まれているかどうか調べます。

引数

tagName
調べたいタグ名(たとえば "IMG"、"FORM"、"HR" など)を指定します。

戻り値

選択している範囲内に見つかった場合は true、見つからなかった場合は false を返します。

現在選択している範囲に IMG タグが見つからなかった場合に警告を表示します。
if( selectionInsideTag( "IMG" ) == false )
alert( "IMG タグが見つかりませんでした" );



TOP > Dreamweaver徹底活用 >