DEXTUpload.NET
Class FileUpload
- サポートされる最小バージョン
- 5.0.0.0
- 最小サポート環境
- .NET Framework 4.0
- 説明
-
クライアントから転送されたマルチパートリクエストは「DEXTUpload.NET.FileUploadMonitorModule」HTTPモジュールで分析される。 分析された情報から生成されたコレクションオブジェクトは、Webページまたはハンドラで扱われるが、「FileUpload」クラスのオブジェクトは、作成時点で「DEXTUpload.NET.MultipartCollection」オブジェクトを受けアップロード処理を完了させることができる役割を担うものであり、 「FileUpload」クラスは、ファイルを転送する機能を有するものではなく、クライアントから送信されたファイルのデータを受け、最終目的地に保存することを目的とする。
注意)「FileUpload」クラスは、マルチパートデータを分析していないため、「DEXTUpload.NET.FileUploadMonitorModule」HTTPモジュールなく、自分自身のファイルのアップロードの全過程を処理することができない。
using (var dext = new FileUpload()) { //アップロードされたすべてのファイルを保存します。 dext.SaveAll(); }
- 形式
-
public class FileUpload : IDisposable
- コンストラクタ
-
FileUpload
-
「FileUpload 'クラスのオブジェクトを生成する際に、初期化処理を実行する。
-
形式
public FileUpload()
-
- 属性
-
IsDisposed
-
オブジェクトで管理されるリソースの終了かどうかを持って来る。
属性の値が「true」であれば、オブジェクトはもう使用できない状態であることを示す。
-
形式
public bool IsDisposed { get; }
Environment
-
コンポーネントのさまざまな設定値を含んでいる「DEXTUpload.NET.DXTEnvironment」オブジェクトを持って来る。
-
形式
public DXTEnvironment Environment { get; }
TempPath
-
一時ファイルを保存するディレクトリのパスを持って来る。
デフォルトでは、「DEXTUpload.NET.DXTEnvironment」オブジェクトに設定された「TempRepository」属性の値と一致する。
-
形式
public string TempPath { get; }
DefaultPath
-
ファイルを保存するデフォルトのディレクトリの場所を取得または設定します。
デフォルトでは、「DEXTUpload.NET.DXTEnvironment」オブジェクトに設定された「DefaultRepository」属性の値と一致する。
-
形式
public string DefaultPath { get; set; }
Collection
-
「DEXTUpload.NET.MultipartCollection」オブジェクトを持って来る。
「DEXTUpload.NET.MultipartCollection」クラスは、要求データを文字列とファイルに分類させて処理することができるよう作成されたコレクションである。
-
形式
public MultipartCollection Collection { get; }
WillRemoveWhenClosing
-
「FileUpload」オブジェクトが「Dispose」メソッドを呼び出して、リソースを解除するときは、残っている一時ファイルを削除するかどうかを取得または設定します。
デフォルトは「true」であるため、「Dispose」メソッドが呼び出されると、一時ファイルを削除する。
-
形式
public bool WillRemoveWhenClosing { get; set; }
StringCount
-
マルチパートリクエストで、文字列のフォーム要素の数を持って来る。
-
形式
public int StringCount { get; }
FileCount
-
マルチパートリクエストでファイルのフォーム要素の数を持って来る。
-
形式
public int FileCount { get; }
-
- メソッド
-
ContainsKey
- 指定されたフォームの名前(キー)を持っているかどうかを返します。
-
形式
public bool ContainsKey(string key)
-
パラメータ
名前 形式 説明 key System.String 存在するかどうかを確認するフォーム名(キー)である。 -
リターン
フォーム要素が存在する場合「true」、または「false」である。
ContainsStringKey
- 指定されたフォームの名前(キー)を持つ文字列のフォーム要素があるかを返す。
-
形式
public bool ContainsStringKey(string key)
-
パラメータ
名前 形式 説明 key System.String 存在するかどうかを確認するフォーム名(キー)である。 -
リターン
フォーム要素が存在する場合「true」、または「false」である。
ContainsFileKey
- 指定されたフォームの名前(キー)を持つファイルのフォーム要素があるかを返します。
-
形式
public bool ContainsFileKey(string key)
-
パラメータ
名前 形式 説明 key System.String 存在するかどうかを確認するフォーム名(キー)である。 -
リターン
フォーム要素が存在する場合「true」、または「false」である。
GetStringElement
-
指定したインデックスまたはフォーム名(キー)に対応する「DEXTUpload.NET.StringElement」オブジェクトを返します。
-
形式
public StringElement GetStringElement(int index) public StringElement GetStringElement(string key)
-
パラメータ
名前 形式 説明 index System.Int32 0から始まるインデックスです。 key System.String フォーム名(キー)である。 -
リターン
指定したインデックスまたはフォーム名(キー)に対応する「DEXTUpload.NET.StringElement」オブジェクトだ。
パラメータがフォームの名前(キー)である場合には、フォームの名前に対応する最初のオブジェクトが返される。
GetStringElements
-
指定されたフォームの名前(キー)に対応する文字列のフォームのリストを入れる「DEXTUpload.NET.StringElementList」オブジェクトを返します。
-
形式
public DEXTUpload.NET.StringElementList GetStringElements(string key)
-
パラメータ
名前 形式 説明 key System.String フォーム名(キー)である。 -
リターン
指定されたフォームの名前(キー)に対応する文字列のフォームのリストを入れる「DEXTUpload.NET.StringElementList」オブジェクトだ。
GetString
-
指定したインデックスまたはフォーム名(キー)に対応する文字列値を返します。
-
形式
public StringElement GetString(int index) public StringElement GetString(string key)
-
パラメータ
名前 形式 説明 index System.Int32 0から始まるインデックスです。 key System.String フォーム名(キー)である。 -
リターン
指定したインデックスまたはフォーム名(キー)に対応する文字列ガプダ。
パラメータがフォームの名前(キー)である場合には、フォーム名に対応する最初の値が返される。
GetFileElement
-
指定したインデックスまたはフォーム名(キー)に対応する「DEXTUpload.NET.FileElement」オブジェクトを返します。
-
形式
public FileElement GetFileElement(int index) public FileElement GetFileElement(string key)
-
パラメータ
名前 形式 説明 index System.Int32 0から始まるインデックスです。 key System.String フォーム名(キー)である。 -
リターン
指定したインデックスまたはフォーム名(キー)に対応する「DEXTUpload.NET.FileElement」オブジェクトだ。
パラメータがフォームの名前(キー)である場合には、フォームの名前に対応する最初のオブジェクトが返される。
GetFileElements
-
指定されたフォームの名前(キー)に対応するファイルのフォームのリストを入れる「DEXTUpload.NET.FileElementList」オブジェクトを返します。
-
形式
public DEXTUpload.NET.FileElementList GetFileElement(string key)
-
パラメータ
名前 形式 説明 key System.String フォーム名(キー)である。 -
リターン
指定されたフォームの名前(キー)に対応するファイルのフォームのリストを入れる「DEXTUpload.NET.FileElementList」オブジェクトだ。
GetFirstFileElement
-
最初の「DEXTUpload.NET.FileElement」オブジェクトを返します。
-
形式
public DEXTUpload.NET.FileElement GetFirstFileElement()
-
リターン
最初の「DEXTUpload.NET.FileElement」オブジェクトだ。
GetLastFileElement
-
最後「DEXTUpload.NET.FileElement」オブジェクトを返します。
-
形式
public DEXTUpload.NET.FileElement GetLastFileElement()
-
リターン
最後「DEXTUpload.NET.FileElement」オブジェクトだ。
GetSingleFileElement
-
一つの「DEXTUpload.NET.FileElement」オブジェクトを返します。
一つのファイルのみをアップロードする場合に使用する。
-
形式
public DEXTUpload.NET.FileElement GetSingleFileElement()
-
リターン
DEXTUpload.NET.FileElementオブジェクトだ。
Close
-
オブジェクトで使用したリソースを解除する。
「Dispose」メソッドと同じ機能を実行する。
-
形式
public void Close()
Dispose
-
オブジェクトで使用したリソースを解除する。
保護された「Dispose」メソッドは、クラスを継承したサブクラスでオーバーライドが可能である。
「WillRemoveWhenClosing」属性が「false」であれば、一時ファイルを削除しない。
-
形式
public void Dispose() protected virtual void Dispose(bool explicitDisposing)
-
パラメータ
名前 形式 説明 explicitDisposing System.Boolean 明示的に資源が解除された場合、「true」、または「false」である。
SaveAll
-
すべてのファイルを保存します。
空であるか、フィルタによって制限された項目は、保存していない。
注意)0バイトのファイルが保存されます。
-
形式
public IEnumerable<FileElement> SaveAll() public IEnumerable<FileElement> SaveAll(string directoryPath) public IEnumerable<FileElement> SaveAll(DirectoryInfo directory) public IEnumerable<FileElement> SaveAll(FileSaveOption option) public IEnumerable<FileElement> SaveAll(string directoryPath, FileSaveOption option) public IEnumerable<FileElement> SaveAll(DirectoryInfo directory, FileSaveOption option)
-
パラメータ
名前 形式 説明 directoryPath System.String 一時ファイルを格納するディレクトリのパス(ローカルオペレーティングシステムのパスまたはWebアプリケーションのサブパス)である。 directory System.IO.DirectoryInfo 一時ファイルを保存するディレクトリのパス情報を持つオブジェクトです。 option DEXTUpload.NET.FileSaveOption ファイルの保存オプションの情報を持つオブジェクトです。 -
リターン
保存操作が実行された「System.Collection.Generic.IEnumerable<FileElement>」オブジェクトを返します。