DEXTUpload.NET
Class FileDownload
- サポートされる最小バージョン
- 5.0.0.0
- 最小サポート環境
- .NET Framework 4.0
- 説明
-
クライアントの要求からファイル形式の応答をサポートするクラスです。
「FileDownload」クラスは、HTTP環境でファイルをダウンロードすることができるように、応答データファイルを記録する機能を持っている。 このクラスは、物理的なファイルをダウンロードしたり、メモリ上に存在するストリームデータをファイル形式でダウンロードする機能を提供する。「FileDownload」オブジェクトを使用して物理ファイルをダウンロードした場合、「If-None-Match」ヘッダ、「If-Range」ヘッダのようなリクエストヘッダの処理が可能なように「ETag」ヘッダが自動的に設定される。そして「DEXTUpload.NET.DownloadOption」クラスの「AllowingWeakRange」属性を使用すると、Entity Tag値をチェックせずに「Range」ヘッダだけでPartial Contentダウンロードを実行することもできる。 (Partial Contentダウンロードとは、ファイルのデータの一部だけを応答データとして返すものである。)
using (var dext = new FileDownload()) { dext.Download(new FileInfo("ダウンロード先のファイルのパス")); }
「Download」メソッドが呼び出さしてダウンロードを行う場合は、この後のコードで応答オブジェクトに加えて、データを記録してはいけず、「Download」メソッドは、ただ一度だけ呼び出すことができます。
- 形式
-
public class FileDownload : BaseComponent, IDisposable
- コンストラクタ
-
FileDownload
-
「FileDownload」クラスのオブジェクトを生成する際に、初期化処理を実行する。
-
形式
public FileDownload() public FileDownload(HttpContext context)
-
パラメータ
名前 形式 説明 context System.Web.HttpContext HTTPリクエストに関連する情報を含んでいるオブジェクトである。
-
- 属性
-
IsDisposed
-
オブジェクトで管理されるリソースの終了かどうかを持って来る。
属性の値が「true」であれば、オブジェクトはもう使用できない状態であることをいう。
-
形式
public bool IsDisposed { get; }
-
- メソッド
-
Close
-
オブジェクトで使用したリソースを解除する。
「Dispose」メソッドと同じ機能を実行する。
-
形式
public void Close()
Dispose
-
オブジェクトで使用したリソースを解除する。
保護された「Dispose」メソッドは、クラスを継承したサブクラスでオーバーライドが可能である。
-
形式
public void Dispose() protected virtual void Dispose(bool explicitDisposing)
-
パラメータ
名前 形式 説明 explicitDisposing System.Boolean 明示的に資源が解除された場合、「true」、または「false」である。
Download
- 物理ファイルあるいはメモリ上のストリームデータをダウンロードする。
-
形式
public void Download(string filePath) public void Download(string filePath, DownloadOption option) public void Download(string filePath, string fileName) public void Download(string filePath, string fileName, DownloadOption option) public void Download(FileInfo file) public void Download(FileInfo file, DownloadOption option) public void Download(FileInfo file, string fileName) public void Download(FileInfo file, string fileName, DownloadOption option) public void Download(Stream stream, string fileName) public void Download(Stream stream, string fileName, DownloadOption option)
-
パラメータ
名前 形式 説明 filePath System.String ダウンロードするファイルのパス(ローカルオペレーティングシステムのパスまたはWebアプリケーションのサブパス)である。 fileName System.String クライアントから認識するファイル名を指定します。 option DEXTUpload.NET.DownloadOption ファイルのダウンロードオプションの情報を持つオブジェクトです。 file System.IO.FileInfo ダウンロードするファイルのパスを表すオブジェクトである。 stream System.IO.Stream ダウンロードするデータを得ることができるオブジェクトである。
-