aboutsummaryrefslogtreecommitdiff
path: root/files/zh-tw/web/api/file/index.html
blob: 0dce936ff8e1909fefde21be89792d1221717be7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
---
title: File
slug: Web/API/File
tags:
  - API
  - File API
  - Interface
  - Reference
  - Web
  - 介面
  - 參考
  - 檔案 API
  - 檔案API
  - 網路
translation_of: Web/API/File
---
<div>{{APIRef}}</div>

<p><strong><code>File</code></strong> 介面提供了檔案的資訊並且允許網頁中的 JavaScript 存取檔案的內容。</p>

<p><code>File</code> 物件通常是從使用者於 {{HTMLElement("input")}} 元素選擇之檔案所回傳的 {{domxref("FileList")}} 物件當中取得,也可以來自<a href="/zh-TW/docs/Web/Guide/HTML/Drag_and_drop">拖放操作</a>所產生的 {{domxref("DataTransfer")}} 物件之中,或是由 {{domxref("HTMLCanvasElement")}} 物件(元素物件)執行 <code>mozGetAsFile()</code> 方法後回傳。在 Gecko 引擎中,有專屬的程式碼能不需使用者操作即建立 <code>File</code> 物件來表示本地端的任一檔案(請參考 {{anch("Implementation notes")}} 以閱讀更多資訊)。</p>

<p><code>File</code> 物件是一種特殊的 {{domxref("Blob")}},且可被用在任何接受 Blob 物件的地方。特別是 {{domxref("FileReader")}}{{domxref("URL.createObjectURL()")}}{{domxref("ImageBitmapFactories.createImageBitmap()", "createImageBitmap()")}}{{domxref("XMLHttpRequest", "", "send()")}} 都能夠同樣接受 <code>Blob</code> 以及 <code>File</code></p>

<p>請參考<a href="/docs/Using_files_from_web_applications">在網頁應用程式中使用本地檔案</a>的更多細節與範例。</p>

<p>{{InheritanceDiagram}}</p>

<h2 id="建構式">建構式</h2>

<dl>
 <dt>{{domxref("File.File", "File()")}}</dt>
 <dd>回傳一個新建構的 <code>File</code> 物件。</dd>
</dl>

<h2 id="屬性">屬性</h2>

<dl>
 <dt>{{domxref("File.lastModified")}} {{readonlyinline}}</dt>
 <dd>回值檔案的最後修改時間,為 UNIX epoch 毫秒(自西元 1970 年一月 1 日零時至今)。</dd>
 <dt>{{domxref("File.lastModifiedDate")}} {{readonlyinline}} {{deprecated_inline}} {{gecko_minversion_inline("15.0")}}</dt>
 <dd><code>File</code> 物件所代表之檔案的最後修改日期(<code><a href="/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a></code>)。</dd>
 <dt>{{domxref("File.name")}} {{readonlyinline}}</dt>
 <dd><code>File</code> 物件所代表之檔案的名稱。</dd>
 <dt>{{domxref("File.size")}} {{readonlyinline}}</dt>
 <dd>回傳檔案大小。</dd>
 <dt>{{domxref("File.webkitRelativePath")}} {{readonlyinline}} {{non-standard_inline}}</dt>
 <dd>回傳相對於 {{domxref("File")}} 的網址位置。</dd>
 <dt>{{domxref("File.type")}} {{readonlyinline}}</dt>
 <dd>回傳檔案的 <a href="/docs/Web/HTTP/Basics_of_HTTP/MIME_types">MIME</a> 類型。</dd>
</dl>

<p><code>File</code> 實作了 {{domxref("Blob")}},因此它也有以下可用屬性:</p>

<dl>
 <dt>{{domxref("File.size")}} {{readonlyinline}}</dt>
 <dd>回傳檔案大小(單位為位元組)。</dd>
 <dt>{{domxref("File.type")}} {{readonlyinline}}</dt>
 <dd>回傳檔案的 <a href="/zh-TW/docs/Web/HTTP/Basics_of_HTTP/MIME_types">MIME </a>類型。</dd>
</dl>

<h2 id="方法">方法</h2>

<p><em><code>File</code> 介面沒有定義任何方法,但繼承了 {{domxref("Blob")}} 介面的方法:</em></p>

<dl>
 <dt>{{domxref("Blob.slice()", "Blob.slice([start[, end[, contentType]]])")}}</dt>
 <dd>
 <p>回傳新的 <code>Blob</code> 物件,包含 <code>Blob</code> 來源之指定位元組範圍的資料。</p>
 </dd>
</dl>

<h2 id="規範">規範</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">規範</th>
   <th scope="col">狀態</th>
   <th scope="col">備註</th>
  </tr>
  <tr>
   <td>{{SpecName('File API')}}</td>
   <td>{{Spec2('File API')}}</td>
   <td>初次定義</td>
  </tr>
 </tbody>
</table>

<h2 id="瀏覽器相容性">瀏覽器相容性</h2>

<div>


<p>{{Compat("api.File")}}</p>
</div>

<p> </p>

<h3 id="實作備註">實作備註</h3>

<ul>
 <li>In Gecko, you can use this API from within chrome code. See <a href="/en-US/docs/Extensions/Using_the_DOM_File_API_in_chrome_code">Using the DOM File API in chrome code</a> for details. To use it from chrome code, JSM and Bootstrap scope, you have to import it using <code><a href="/en-US/docs/Components.utils.importGlobalProperties">Cu.importGlobalProperties</a>(['File']);</code></li>
 <li>Starting from Gecko 6.0 {{geckoRelease("6.0")}}, privileged code (such as extensions) can pass an {{interface("nsIFile")}} object to the DOM <code>File</code> constructor to specify the file to reference.</li>
 <li>Starting from Gecko 8.0 {{geckoRelease("8.0")}}, you can use <code>new File</code> to create <code>File</code> objects from XPCOM component code instead of having to instantiate the {{interface("nsIDOMFile")}} object directly. The constructor takes, in contrast to {{domxref("Blob")}}, as second argument the filename. The filename can be any String.
  <pre class="syntaxbox">new File(
  Array parts,
  String filename,
  BlobPropertyBag properties
);</pre>
 </li>
 <li>The following non-standard properties and methods were removed in Gecko 7 {{geckoRelease("7.0")}}: {{domxref("File.fileName")}}, {{domxref("File.fileSize")}}, {{domxref("File.getAsBinary()")}}, {{domxref("File.getAsDataURL()")}}, {{domxref("File.getAsText()","File.getAsText(string encoding)")}} ({{bug("661876")}}). Standard properties {{domxref("File.name")}}, {{domxref("Blob.size")}}, and methods on {{domxref("FileReader")}} should be used instead.</li>
</ul>

<h2 id="參見">參見</h2>

<ul>
 <li><a href="/docs/Using_files_from_web_applications">在網頁應用程式中使用本地檔案</a></li>
 <li>{{domxref("FileReader")}}</li>
 <li><a href="/docs/Extensions/Using_the_DOM_File_API_in_chrome_code">Using the DOM File API in chrome code</a> (for privileged code running in Gecko, such as Firefox add-ons)</li>
</ul>