Visit Mozilla.org

nsIDOMFile

出典: MDC


この記事は Firefox 3 の新機能について述べています

nsIDOMFile インターフェイスは、フォーム上で input の type "file" を使ってサブミットされたファイルからデータを読み出します。これはオフラインで web アプリケーションを使っているユーザがフォームにサブミットした時に保存されるファイルを参照可能にし、そしてそのデータは読み込む事ができ、またインターネット接続が再開された時にアップロードが可能となります。

註: このインターフェイスの全てのメソッドはエラーが発生すると nsIDOMFileException という例外を発生させます。

目次

nsIDOMFilecontent/base/public/nsIDOMFile.idl で定義されています。これは scriptable非凍結です。 (Mozilla 1.9から更新されていません)

Inherits from: nsISupports

[編集] Method overview

DOMString getAsBinary();
DOMString getAsDataURL();
DOMString getAsText(in DOMString encoding);

[編集] Attributes

Attribute Type Description
fileName DOMString nsIDOMFile オブジェクトから参照されるファイルの名前を含む読み込み専用の属性
fileSize unsigned long long 参照されたファイルのbyteのサイズ

[編集] Methods

[編集] getAsBinary()

ファイル上のデータの生のバイナリフォーマットを含む DOMString を 返します。

 DOMString getAsBinary();
[編集] 引数

無し。

[編集] 返り値

ファイル上の生のバイナリを含む DOMString

[編集] getAsDataURL()

参照されたファイルのコンテンツをdata: URL でエンコードした DOMStringを返します。

 DOMString getAsDataURL();
[編集] Parameters

無し

[編集] Return value

data: URL としてエンコードされたファイルのデータを含む DOMString

[編集] getAsText()

与えられたエンコーディングを用いたテキストとして判断されたファイルのデータを DOMString として含んだファイルを返します。

 DOMString getAsText(
   in DOMString encoding
 );
[編集] Parameters
encoding
指定したエンコードの文字列を利用して返り値のデータとします。もし、文字列が空であれば、UTF-8 が代りに使われます。
[編集] Return value

特定の エンコーディング で解釈されたテキストとしてファイルのデータを含むDOMString

[編集] See also

nsIDOMFileList, nsIDOMFileException