Dreamweaver API リファレンス

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

  copy ()
対応バージョン

3.0

説明

指定したファイルをコピーします。

引数

originalURL, copyURL
originalURL
コピーするファイルを URL 形式で指定します。
copyURL
コピー先のファイルを URL 形式で指定します。

戻り値

ファイルのコピーに成功した場合には true、失敗した場合には false を返します。

menus.xml を menus.bak にコピーします。
var menufile = dw.getConfigurationPath() + "/menus/menus.xml";
var bakfile = dw.getConfigurationPath() + "/menus/menus.bak";
DWfile.copy( menufile, bakfile );


  createFolder ()
対応バージョン

2.0 以上

説明

フォルダを新規作成します。

引数

folderURL
新規に作成するフォルダ URL 形式で指定します。

戻り値

フォルダに作成に成功した場合は true、失敗した場合には false を返します。

現在のサイトに flash フォルダを作成します。
var flashFolder = dw.getSiteRoot() + "/flash";
DWfile.createFolder( flashFolder );


  exists ()
対応バージョン

2.0 以上

説明

指定したファイルが存在するか調べます。

引数

fileURL
チェックするファイルを URL 形式で指定します。

戻り値

ファイルが存在するときは true、存在しない場合は false を返します。

menus.xml を menus.bak にコピーする前に、menus.bak が存在するかどうか調べ存在する場合に警告を表示します。
var menufile = dw.getConfigurationPath() + "/menus/menus.xml";
var bakfile = dw.getConfigurationPath() + "/menus/menus.bak";
if( DWfile.exists( bakfile ) )
{
alert( "ファイルが上書きされます。" );
}
DWfile.copy( menufile, bakfile );


  getAttributes ()
対応バージョン

2.0 以上

説明

指定したファイルまたはフォルダの属性を取得します。

引数

fileURL
属性を取得するファイルまたはフォルダを URL 形式で指定します。

戻り値

属性値の結果の文字列を返します。ファイルまたはフォルダが存在しない場合は、 null を返します。
属性値は以下の文字を組み合わせた文字列が返されます。
R - 読み取り専用
D - ディレクトリ
H - 隠しファイルまたはフォルダ
S - システムファイルまたはシステムフォルダ

menus.xml を menus.bak にコピーする前に、menus.bak が読み取り属性が設定されている場合にはコピーしません。
var menufile = dw.getConfigurationPath() + "/menus/menus.xml";
var bakfile = dw.getConfigurationPath() + "/menus/menus.bak";
var str = DWfile.getAttributes( bakfile );
if( str == null || ( str.indexOf( "R" ) == -1 ) )
{
DWfile.copy( menufile, bakfile );
}


  getModificationDate ()
対応バージョン

2.0 以上

説明

指定したファイルが最後に修正された日時を取得します。

引数

fileURL
日時を取得したいファイル名を URL 形式で指定します。

戻り値

基準時刻からの経過時間を16進数の文字列で返します。Window 版とMacintosh 版では、基準時刻と経過時間の単位が異なります。Windows 版は、基準時刻は 1600 年 1 月 1 日からの 100ns 単位の経過時間、Macintosh 版では、1904年 1 月 1 日からの 秒単位の経過時間を返します。

二つのファイルの日時を調べ、コピーするファイルを変更します。
var file1 = "file:///D|/site/index.htm";
var file2 = "file:///D|/site2/index.htm";
var date1 = DWfile.getModificationDate( file1 );
var date2 = DWfile.getModificationDate( file2 );
if( data1 > date 2 )
{
DWfile.copy( file1, file2 );
}
else
{
DWfile.copy( file2, file1 );
}


  listFolder ()
対応バージョン

2.0 以上

説明

指定したフォルダ内にあるファイルまたはフォルダの文字列リストを取得します。

引数

folderURL, constraint
folderURL
リスト取得するフォルダを file:// URL 形式で指定します。また、ワイルドカードのファイルマスクを追加することが出来ます。試用できるワイルドカードは、「*」(1 つ以上の文字に一致)と「?」(1 つの文字に一致)です。
constraint
取得するリストの種類を指定します。ファイルだけを取得したい場合には "files"、フォルダだけを取得したい場合には、"directories" を指定します。この引数を指定しない場合は、ファイルとディレクトリの両方を返します。

戻り値

取得したファイルまたはフォルダの文字列リストを返します。

サイトのルートフォルダ内にある *.htm ファイルを表示します。
var list = DWfile.listFolder( dw.getSiteRoot() + "*.htm" );
alert( list );


  read ()
対応バージョン

2.0 以上

説明

指定したファイルの内容を取得します。

引数

fileURL
内容を取得するファイルを URL 形式で指定します。

戻り値

ファイルの内容の文字列を返し、ファイルの読み込みに失敗した場合には null を返します。

mydata.txt を読み込み、内容を表示します。
var dat = DWfile.read( "file:///D|/mydata.txt" );
if( dat != null )
alert( dat );


  remove ()
対応バージョン

3.0

説明

指定したファイルを削除します。
注意:
Windows 版では、指定したファイルが読み取り専用の場合に、確認のダイアログボックスが表示されます。

引数

fileURL
削除するファイルを URL 形式で指定します。

戻り値

削除に成功した場合は true、失敗した場合は fakse を返します。
サイトの /TMP 内にあるファイルをすべて削除します。
var folder = dw.getSiteRoot() + "TMP/";
var list = DWfile.listFolder( folder, "files" );
for( var i = 0; i < list.length; i++ )
{
DWfile.remove( folder + list[ i ] );
}


  write ()
対応バージョン

2.0 以上

説明

指定した内容をファイルに保存します。指定したファイルが存在しない場合には、ファイルを作成します。

引数

fileURL, text, mode
保存するファイルを URL 形式で指定します。
text
ファイルに保存する内容を指定します。
mode
追加書き込みする場合は "append" を指定し、上書きする場合は、この引数を指定しないようにします。

戻り値

ファイルの書き込みに成功した場合は true、失敗した場合は false を返します。

最初に mydata.txt に "xxx" を上書きし、その後 "aaa" を追加書き込みします。
var fileURL = "file:///D|/mydata.txt";
DWfile.write( fileURL, "xxx" );
DWfile.write( fileURL, "aaa", "append" );



TOP > Dreamweaver徹底活用 >