DEXTUpload.NET Professional
menu toggleリファレンス > DEXTUpload.NET > DownloadOption

DEXTUpload.NET
Class DownloadOption

サポートされる最小バージョン
5.0.0.0
最小サポート環境
.NET Framework 4.0
説明

「DownloadOption」クラスは、「DEXTUpload.NET.FileDownload」「クラスの「Download」メソッドを使用してファイルのダウンロードを実行するときに必要な設定を含んでいる。

using (var dext = new FileDownload())
{
    // pdfファイルをインライン形式でダウンロードする。
    dext.Download("~/files/attach/target.pdf", new DownloadOption { 
        MimeType = "application/pdf", 
        IsInline = true
    });
}
形式
public class DownloadOption
コンストラクタ

DownloadOption

  • 「DownloadOption」クラスのオブジェクトを生成する際に、初期化処理を実行する。

  • 形式

    public DownloadOption()
    public DownloadOption(bool isInline, string mime, bool allowWeakRange, bool useClientCache, bool removeAfterDownloading)
    public DownloadOption(bool isInline, string mime, bool allowWeakRange, bool useClientCache, bool removeAfterDownloading, TimeSpan maxAge)
  • パラメータ

    名前 形式 説明
    isInline System.Boolean インライン形式でダウンロードするには、「true」である。
    mime System.String ダウンロードする対象のMIMEタイプ
    allowWeakRange System.Boolean 「Range」ヘッダのみを利用したPartial Contentダウンロードを許可するには、「true」である。
    useClientCache System.Boolean 応答キャッシュポリシーを使用するには、「true」である。
    removeAfterDownloading System.Boolean ダウンロード後、対象のファイルを削除するには、「true」である。
    maxAge (5.4.0.0バージョンからサポート) System.TimeSpan リクエスト資源の最大年齢
属性

IsInline

  • インライン形式でファイルをダウンロードするかを取得または設定します。

    インラインとは、応答データ(ダウンロードしたいファイルやデータ)の「Content-Disposition」応答ヘッダを「inline」に設定することをいう。「inline」に設定されると、応答データがブラウザが解釈可能な「Content-Type」を持つ場合は、ブラウザから直接開いたり、関連する機能が実行されることができる。

    デフォルトでは、「false」であり、「Content-Disposition」レスポンスヘッダは「attachment」である。

  • 形式

    public bool IsInline { get; set; }

MimeType

  • ダウンロードするファイルのMIMEタイプを取得または設定します。

    応答データは、「Content-Type」の応答ヘッダーにデータのMIMEタイプを設定する。ファイルを添付としてダウンロードする場合には、MIMEタイプに大きくこだわらないが、インライン形式で受信する場合には、ブラウザがデータに関する情報を知る必要があるため、「Content-Type」の応答ヘッダーにブラウザが認識できるようにMIMEタイプを設定してくれるとする。時折、いくつかのブラウザが「Content-Type」レスポンスヘッダに関係なく、データを開いたり実行しますが、は、通常モダンブラウザは「Content-Type」ヘッダを基準に処理する。

    デフォルトでは、「application/octet-stream」である。

  • 形式

    public string MimeType { get; set; }

AllowingWeakRange

  • 「Range」ヘッダのみを使用して、Partial Contentダウンロードするかどうかを取得または設定します。

    「ETag」のようなリクエストヘッダなし」Range」ヘッダだけでPartial Contentダウンロード要求を受け入れるときに使用する。Partial Contentダウンロードは、ストリームではなく、静的なファイルのダウンロードの場合のみ使用される。

    デフォルトでは、「false」である。

  • 形式

    public bool AllowingWeakRange { get; set; }

UseClientCache

  • 応答キャッシュポリシーを使用するかどうかを取得または設定します。

    応答キャッシュポリシーは、「ETag」、ファイルの変更日付、キャッシュの有効期限などを設定することをいい、応答キャッシュポリシーは、ストリームではなく、静的なファイルのダウンロードの場合に適用される。

    デフォルトでは、「false」である。

  • 形式

    public bool UseClientCache { get; set; }

RemoveAfterDownloading

  • ダウンロードした対象ファイルの削除するかどうかを取得または設定します。

    ストリームではなく、静的なファイルの場合、ダウンロードが完了すると、ターゲットを削除することができる。

    デフォルトでは、「false」である。

  • 形式

    public bool RemoveAfterDownloading { get; set; }

MaxAge (5.4.0.0バージョンからサポート)

  • リクエストリソースの最大年齢を取得または設定します。

    デフォルト値は1である。

  • 形式

    public TimeSpan MaxAge { get; set; }