Dreamweaver API リファレンス

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

  open ()
説明

指定したファイルの関連付けられているデザインノートを開きます。デザインノートが存在しない場合には、デザインノートを作成します。

引数

filePath, bForceCreate
filePath
デザインノートを取得するファイルを URL 形式で指定します。
bForceCreate
サイトの定義で、デザインノートが使用できない場合や、指定したファイルがどのサイトにも属さないファイルである場合にデザインノートを作成するかどうかを指定します。デザインノートを作成する場合は true、作成しない場合は false を指定します。この引数を指定しない場合は、デザインノートを作成しません。

戻り値

デザインノートのハンドルを返します。受け取ったハンドルを使って、デザインノートの処理を行います。デザインノートが開けなかったり、作成できない場合には 0 を返します。

index.htm のデザインノートを開き、開けなかった場合に警告を表示します。
var hNote = MMNotes.open( "file:///D|/site/index.htm" );
if( hNote == 0 )
alert( "デザインノートを開くことができませんでした" );


  close ()
説明

指定したデザインノートを閉じ、内容を保存します。デザインノートの内容が空の場合は、デザインノートを削除します。

引数

fileHandle
MMNotes.open() 関数の戻り値であるハンドルを指定します。

戻り値

なし。

open() 関数で開いたデザインノートを閉じます。
var hNote = MMNotes.open( "file:///D|/site/index.htm" );
if( hNote == 0 )
alert( "デザインノートを開くことができませんでした" );
else
MMNotes.close( hNote );


  set ()
説明

デザインノートに、キーを追加します。すでにキーが存在する場合は内容を更新します。

引数

fileHandle, keyName, valueString
fileHandle
MMNotes.open() 関数の戻り値であるハンドルを指定します。
keyName
追加するキーの名前を指定します。
valueString
キーに設定する値を指定します。

戻り値

キーの追加・更新に成功した場合は true、失敗した場合は false を返します。

デザインノートを開き、"fw_source" のキーにファイル名を追加します。
var hNote = MMNotes.open( "file:///D|/site/title.gif" );
if( hNote == 0 )
alert( "デザインノートを開くことができませんでした" );
MMNotes.set( hNote, "fw_source", "file:///D|/site/png/title.gif" );


  remove ()
説明

デザインノートから、キーを削除します。

引数

fileHandle, keyName
fileHandle
MMNotes.open() 関数の戻り値であるハンドルを指定します。
keyName
削除するキーの名前を指定します。

戻り値

キーの削除に成功した場合は true、失敗した場合は false を返します。

デザインノートを開き、"last_date" のキーを削除します。
var hNote = MMNotes.open( "file:///D|/site/index.htm" );
if( hNote == 0 )
alert( "デザインノートを開くことができませんでした" );
MMNotes.remove( hNote, "last_date" );


  get ()
説明

デザインノートから指定したキーの値を取得します。

引数

fileHandle, keyName
fileHandle
MMNotes.open() 関数の戻り値であるハンドルを指定します。
keyName
値を取得するするキーの名前を指定します。

戻り値

キーの値を返します。

デザインノートを開き、"fw_source" のキーを表示します。
var hNote = MMNotes.open( "file:///D|/site/title.gif" );
if( hNote == 0 )
alert( "デザインノートを開くことができませんでした" );
var keyValue = MMNotes.get( hNote, "fw_source" );
alert( "fw_source:" + keyValue );


  getKeyCount ()
説明

デザインノートに保存されているキーの数を取得します。

引数

fileHandle
MMNotes.open() 関数の戻り値であるハンドルを指定します。

戻り値

キーの数を返します。

デザインノートを開き、キーの数を表示します。
var hNote = MMNotes.open( "file:///D|/site/index.htm" );
if( hNote == 0 )
alert( "デザインノートを開くことができませんでした" );
var keyNum = MMNotes.getKeyCount( hNote );
alert( "キーの数:" + keyNum );


  getKeys ()
説明

デザインノートに保存されているキーの一覧をリストで取得します。

引数

fileHandle
MMNotes.open() 関数の戻り値であるハンドルを指定します。

戻り値

キーの一覧が格納された文字列のリストを返します。

デザインノートを開き、キーの一覧を取得します。
var hNote = MMNotes.open( "file:///D|/site/title.gif" );
if( hNote == 0 )
alert( "デザインノートを開くことができませんでした" );
var str = "";
var list = MMNotes.getKeys( hNote );
for( var i = 0; i < list.length; i++ )
str += list[ i ] + " : " + MMNotes.get( hNote, list[ i ] ) + "\n";
alert( str );


  getSiteRootForFile ()
説明

デザインノートのサイトルートフォルダをOS 標準の形式で取得します。

引数

fileURL
サイトルートフォルダを取得するデザインノートのパスを URL 形式で指定します。

戻り値

サイトルートフォルダを OS 標準の形式で返します。デザインノートがサイト外や保存されていない場合は、空の文字列を返します。

指定したデザインノートのサイトルートフォルダを表示します。結果は "D:/game3rd/" と表示されます。
alert( MMNotes.getSiteRootForFile( "file:///D|/game3rd/title/minititle.gif" ) );


  getVersionNum ()
説明

デザインノートライブラリのバージョン番号を取得します。

引数

なし。

戻り値

バージョン番号を文字列で返します。

デザインノートライブラリのバージョン番号を表示します。
alert( MMNotes.getVersionNum() );


  getVersionName ()
説明

デザインノートライブラリのバージョン名を取得します。バージョン名は、共有ライブラリを実装したアプリケーション名が表示されるようになっています。Dreamweaver も Fireworks も同じバージョンのライブラリを使っているため、"Dreamweaver" を返すようになっています。

引数

なし。

戻り値

デザインノートライブラリのバージョン名を文字列で返します。

デザインノートライブラリのバージョン名を表示します。
alert( MMNotes.getVersionName() );


  filePathToLocalURL ()
説明

OS 標準形式のパスを URL 形式に変換します。

引数

drivePath
変換する OS 標準形式のパスを指定します。

戻り値

変換された URL 形式のパスを返します。

OS 標準形式のパスを URL 形式に変換後のパスを表示します。結果は "file:///c|sites/webdev/index.htm" と表示されます。
alert( MMNotes.filePathToLocalURL('C:/sites/webdev/index.htm') );


  localURLToFilePath ()
説明

URL 形式のパスを OS 標準形式に変換します。

引数

fileURL
変換する URL 形式のパスを指定します。

戻り値

変換された OS 標準形式のパスを返します。

URL 形式のパスを OS 標準形式に変換後のパスを表示します。結果は "MacintoshHD:images:moon.gif" と表示されます。
alert( MMNotes.localURLToFilePath( 'file:///MacintoshHD/images/moon.gif' ) );



TOP > Dreamweaver徹底活用 >