Dreamweaver API リファレンス

ファイルやフォルダの読み書きや状態・名前の管理を行う File クラスを初期化します。

theUrl, theDocUrl
theUrl
File クラスで管理するファイルまたはフォルダを URL 形式で指定します。
theDocUrl
theUrl が相対パスの場合に基準とするパスを URL 形式で指定します。この引数は、省略することができます。

なし。

File クラスを初期化します。
var file = new File( "file:///d|/site/index.htm" );

ファイル名を取得します。

なし。

ファイル名を返します。

ファイル名を表示します。
var file = new File( "index.htm", "file:///d|/site/info/" );
alert( file.toString() );

ファイル名からパスの指定を除いた部分を取得します。

なし。

ファイル名からパスの指定を除いた部分を返します。

ファイル名からパスの指定を除いた部分を表示します。
var file = new File( "file:///d|/site/index.htm" );
alert( file.getName() );

拡張子を除いたファイル名を取得します。

なし。

拡張子を除いたファイル名を返します。

拡張子を除いたファイル名を表示します。
var file = new File( "file:///d|/site/index.htm" );
alert( file.getSimpleName() );

ファイルの拡張子を取得します。

なし。

ファイルの拡張子を返します。

ファイルの拡張子を表示します。
var file = new File( "file:///d|/site/index.htm" );
alert( file.getExtension() );

ファイル名で取得します。

なし。

ファイル名を返します。

ファイル名を表示します。
var file = new File( "../index.htm", "file:///d|/site/info/" );
alert( file.getPath() );

File クラスで管理するファイルまたはフォルダを変更します。

theUrl, theDocUrl
theUrl
File クラスで管理するファイルを URL 形式で指定します。
theDocUrl
theUrl が相対パスの場合に基準とするパスを URL 形式で指定します。この引数は、省略することができます。

なし。

File クラスで管理するファイルを変更します。
var file = new File( "file:///d|/site/index.htm" );
file.setPath( "file:///d|/site/main.htm" );

ファイル名の指定が絶対パスであるかどうか調べます。

なし。

絶対パスの場合は true、絶対パスでない場合は false を返します。

ファイル名を絶対パスで取得します。

なし。

ファイル名を絶対パスで返します。

ファイル名を絶対パスで表示します。
var file = new File( "../index.htm", "file:///d|/site/info/" );
alert( file.getAbsolutePath() );

ファイルの１つ上のディレクトリを取得します。

なし。

ファイルの１つ上のディレクトリを返します。ディレクトリの取得に失敗した場合は空の文字列を返します。

ファイルの１つ上のディレクトリを表示します。
var file = new File( "../index.htm", "file:///d|/site/info/" );
alert( file.getParent() );

ファイル名の１つ上のディレクトリを絶対パスで取得します。

なし。

ファイルの１つ上のディレクトリを絶対パスで返します。ディレクトリの取得に失敗した場合は空の文字列を返します。

ファイルの１つ上のディレクトリを絶対パスで表示します。
var file = new File( "../index.htm", "file:///d|/site/info/" );
alert( file.getAbsoluteParent() );

ファイルが存在するかどうか調べます。

なし。

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

ファイルが存在するかどうか調べます。
var file = new File( "../index.htm", "file:///d|/site/info/" );
if( file.exists() )
alert( "ファイルは存在します" );

ファイルの属性を調べます。

なし。

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

ファイルの属性を調べます。
var file = new File( "../index.htm", "file:///d|/site/info/" );
var str = file.getAttributes();
if( str.indexOf( "R" ) == -1 )
{
alert( "読み取り属性が設定されています" );
}

ファイルが読み込み可能かどうか調べます。

なし。

ファイルが読み込める場合は true、読み込めない場合は false を返します。

ファイルが読み込める場合にファイルの読み込みを行います。
var file = new File( "readme.txt" );
if( file.canRead() )
{
var dat = DWfile.read( file.getAbsolutePath() );
}

ファイルが書き込み可能かどうか調べます。

なし。

ファイルが書き込める場合は true、書き込めない場合は false を返します。

ファイルが書き込める場合にファイルの書き込みを行います。
var file = new File( "readme.txt" );
if( file.canWrite() )
{
DWfile.read( file.getAbsolutePath(), dat );
}

File クラスで管理している属性が、ファイルかどうか調べます。

なし。

ファイルである場合は true、ファイルでない場合は false を返します。

ファイルかどうか調べます。
var file = new File( "readme.txt" );
if( file.isFile() )
alert( "ファイルです" );

なし。

フォルダである場合は true、フォルダでない場合は false を返します。

フォルダかどうか調べます。
var file = new File( "index" );
if( file.isFile() )
alert( "フォルダです" );

フォルダ内にあるファイルの一覧を取得します。

filterFunction
見つかったファイルを引数に実行する関数を指定します。見つかったファイルに対して、作業したい場合に指定します。この引数は省略することが出来ます。

フォルダ内にあるファイルの一覧のリストを返します。

サイトルートフォルダにあるファイルの一覧を取得します。
var folder = new File( dw.getSiteRoot() );
var list = folder.listFolder();
alert( list );

フォルダを作成します。

なし。

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

d:/mysite のフォルダを作成します。
var folder = new File( "file:///d|/mysite" );
if( folder.createFolder() == false )
alert( "フォルダの作成に失敗にしました" );

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

なし。

ファイルの内容を返します。

CSV ファイルを読み込み、１行ずつ処理します。
var file = new File( "test.csv" );
var data = file.getContents();
var newline = (navigator.platform != "Win32") ? "\x0D" : "\x0D\x0A";
lines = dw.getTokens( data, newline );
for( i = 0; i < lines.length; i++ )
{
var column = dw.getTokens( lines[ i ], "," );

}

ファイルに指定した内容を書き込みます。

theContents, append
theContents
ファイルに書き込む内容を指定します。
append
追加書き込みする場合は "append" を指定し、上書きする場合は、この引数を指定しないようにします。

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

"result.txt" に書き込みを行います。
var file = new File( "result.txt" );
file.setContents( "test" );

ファイルをコピーします。デザインノートも一緒にコピーすることも出来ます。

theCopyName, noMetafile
theCopyName
コピー先のファイル名を指定します。相対パスで指定した場合は、現在開いているページの URL を基準とします。
noMetafile
コピー元のファイルに関連付けられているデザインノートも一緒にコピーする場合は true、コピーしない場合は false を指定します。

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

"title.gif" を "title2.gif" にコピーします。
var file = new File( "title.gif" );
file.copy( "title2.gif", true );

ファイルを削除します。

なし。

削除に成功した場合は true、失敗した場合は fakse を返します。

"index.htm" を削除します。
var file = new File( "index.htm" );
file.remove();