DEXTUpload.NET
Interface IFileManagement
- サポートされる最小バージョン
- 5.0.0.0
- 最小サポート環境
- .NET Framework 4.0
- 説明
-
「IFileManagement」インタフェースを実装したクラスは、一時ファイルを扱うためのさまざまな機能を提供しなければならない。
「IFileManagement」実装クラスは、一時ファイルの基本的な情報に加えて、一時ファイルを特定の場所に保存するためのさまざまなメソッドを提供する。
実装クラ
- 形式
-
public interface IFileManagement
- 属性
-
IsEmpty
-
空のファイルであるかどうかを持って来る。
空のファイルとは、要素は存在するが、実際のファイル情報がない場合である。「true」が返された場合、FileName」属性の値が空の文字列であり、「FileLength」属性の値が-1でなければならない。
-
形式
bool IsEmpty { get; }
IsEligibleFile
-
内容を持っているファイルであるかどうかを持って来る。
ファイルが存在しなければならず、ファイルのサイズが0よりも大きくなければならない。
注意)コンポーネントは、0バイトのファイルのアップロードを可能にする。コンポーネントは、0バイトのファイルの場合にも、「IsEligibleFile」属性の値は、「false」になる。
-
形式
bool IsEligibleFile { get; }
MimeType
-
ファイルのMIMEタイプの値を持って来る。
「MimeType」属性は、マルチパートデータの各フォーム要素ごとに持っている「Content-Type」の値を返します。 この値は、クライアントがターゲットファイルに対して、自分たちだけの方法で分析して、送信値で、間違った値に設定することができる。 したがって、「MimeType」は、ファイルのMIMEタイプの参考資料としてのみ使用する。
-
形式
string MimeType { get; }
FullName
-
完全なファイル名を持って来る。
「Content-Disposition」ヘッダ上に記録された全ファイルの名前を意味する。たとえばInternet Explorerの場合は、インターネットオプションの設定に基づいて、クライアントのパスがファイルの名前に含めることができる。
-
形式
string FullName { get; }
FileName
-
ファイルの名前を持って来る。
クライアントのパスは含まれていない、「FileNameWithoutExt '+' FileExtension」属性の組み合わせで作られた名前である。
-
形式
string FileName { get; }
FileNameWithoutExt
-
拡張子を除いたファイルの名前の部分を持って来る。
-
形式
string FileNameWithoutExt { get; }
FileExtension
-
ファイルの拡張子部分を持って来る。
"."を含む指定されたパスの拡張子を返しますが、ファイル名に拡張子がない場合は、空の文字列を返します。
-
形式
string FileExtension { get; }
FileLength
-
ファイルのサイズ(byte)を持って来る。
もしファイルの制限対象であり、フィルタリング方式が「DEXTUpload.NET.FilterAction.Flushing」であれば、0が返される。空のファイルは、0以外の-1である。
-
形式
long FileLength { get; }
OriginalFileLength
-
ファイルの元のサイズ(byte)を持って来る。
ファイルは、フィルタリングされたとき、フィルタリング方式が「DEXTUpload.NET.FilterAction.Flusing」であれば、ファイルのサイズが0になる。
「OriginalFileLength」属性の値は、フィルタ処理によるファイルのサイズの変化に関係なく、元のクライアントから送信されたファイルのサイズを返します。空のファイルは、0以外の-1である。
-
形式
long OriginalFileLength { get; }
IsFiltered
-
ファイルが制限対象にフィルタリングされたを持って来る。
-
形式
bool IsFiltered { get; }
IsImage
-
ファイルが画像ファイルであるかを持って来る。
すべての画像ファイルの種類を認識するのではなく、.NET Frameworkの「System.Drawing.Image」クラスが読める形式のみである。
-
形式
bool IsImage { get; }
ImageFormat
-
ファイルが画像ファイルであれば、「System.Drawing.Imaging.ImageFormat」の形式を持って来る。
-
形式
ImageFormat ImageFormat { get; }
ImageWidth
-
ファイルが画像ファイルであれば、イメージの幅の長さを持って来る。
イメージファイルがない場合は-1が返される。
-
形式
int ImageWidth { get; }
ImageHeight
-
画像ファイルであれば、イメージの高さを持って来る。
イメージファイルがない場合は-1が返される。
-
形式
int ImageHeight { get; }
TempFilePath
-
一時ファイルのパスを持って来る。
-
形式
string TempFilePath { get; }
LastSavedFilePath
-
「Save、SaveAs」メソッドを使用して、最後に保存されたパスの値を持って来る。
-
形式
string LastSavedFilePath { get; }
LastSavedFileName
-
「Save、SaveAs」メソッドを使用して、最後に保存されたファイル名を持って来る。
-
形式
string LastSavedFileName { get; }
IsKeeping
-
ファイルを個別に保存せずに一時ファイルをそのまま使用しているかどうかを持って来る。
一時ファイルを「Save、SaveAs」メソッドを使用して保存せずに、そのまま使用しようと「Keep」メソッドを呼び出すと、「IsKeep」属性の値は「true」を返します。 「Keep」メソッドが呼び出されると、「LastSavedFilePath」属性の値は、一時ファイルのパスとなり、「LastSavedFileName」属性の値は、テンポラリファイル名に変更される。
-
形式
bool IsKeeping { get; }
-
- メソッド
-
SaveAs
- 一時ファイルを別の名前で保存し、保存されたファイルのパスを返します。
-
形式
string SaveAs(string targetPath) string SaveAs(FileInfo target) string SaveAs(string targetPath, FileSaveOption option) string SaveAs(FileInfo target, FileSaveOption option)
-
パラメータ
名前 形式 説明 targetPath System.String 一時ファイルを保存するファイルのパス(ローカルオペレーティングシステムのパスまたはWebアプリケーションのサブパス)である。 target System.IO.FileInfo 一時ファイルを保存するパス情報を持つオブジェクトです。 option DEXTUpload.NET.FileSaveOption ファイルの保存オプションの情報を持つオブジェクトです。 -
リターン
保存されたファイルのローカル・オペレーティング・システムのパスを返す。
Save
- 一時ファイルを保存したり、保存されたファイルのパスを返します。
-
形式
string Save() string Save(FileSaveOption option) string Save(string directoryPath) string Save(DirectoryInfo directory) string Save(string directoryPath, FileSaveOption option) string Save(DirectoryInfo directory, FileSaveOption option) string Save(ObfuscationOption obfuscationOption) string Save(ObfuscationOption obfuscationOption, FileSaveOption option) string Save(string directoryPath, ObfuscationOption obfuscationOption) string Save(DirectoryInfo directory, ObfuscationOption obfuscationOption) string Save(string directoryPath, ObfuscationOption obfuscationOption, FileSaveOption option) string Save(DirectoryInfo directory, ObfuscationOption obfuscationOption, FileSaveOption option)
-
パラメータ
名前 形式 説明 directoryPath System.String 一時ファイルを格納するディレクトリのパス(ローカルオペレーティングシステムのパスまたはWebアプリケーションのサブパス)である。 directory System.IO.DirectoryInfo 一時ファイルを保存するディレクトリのパス情報を持つオブジェクトです。 obfuscationOption DEXTUpload.NET.ObfuscationOtpion ファイル名難読化オプションの情報を持つオブジェクトです。 option DEXTUpload.NET.FileSaveOption ファイルの保存オプションの情報を持つオブジェクトです。 -
リターン
保存されたファイルのローカル・オペレーティング・システムのパスを返す。.
Keep
-
一時ファイルを保持し、そのパスを返します。
一時ファイルを「Save、SaveAs」メソッドを使用して保存せずに、一時ファイルのまま使用しようとしたときに「Keep」メソッドを使用する。
「Keep」メソッドが呼び出されると、「LastSavedFilePath」属性の値は、一時ファイルのパスで、「LastSavedFileName」属性の値は、テンポラリファイル名に変更され、「IsKeep」属性の値が「true」になる。
「Keep」メソッドは、一時ファイルをそのまま維持し、「FileUpload.Dispose」メソッド、 「UseDEXTAttribute」属性を使用しても、一時ファイルが削除されない。しかし、クリーナーを使用する場合、ターゲットが削除さに注意しなければならない。 詳細については、「一時ファイルのクリーン操作ガイド」を参照している。
-
形式
string Keep()
-
リターン
一時ファイルのローカル・オペレーティング・システムのパスを返す。
DeleteTempFile
-
一時ファイルを削除する。
もし「IsKeep」属性が「true」であれば、メソッドを呼び出しても、一時ファイルが削除されない。
-
形式
bool DeleteTempFile()
-
リターン
一時ファイルのローカル・オペレーティング・システムのパスを返す。
ReadText (5.2.0.0バージョンからサポート)
-
テキストファイル形式でファイルを読んで、その内容を返します。
ファイルを読むとき、文字セットが省略されると、UTF-8文字セットにファイルを読み、「Save、SaveAs」メソッドが呼び出される前に、一時ファイルでは、呼び出された後は、保存されたファイルから内容を読む。
-
形式
string ReadText() string ReadText(System.Text.Encoding encoding)
-
パラメータ
名前 形式 説明 encoding System.Text.Encoding 文字エンコーディングである。省略した場合、UTF-8文字セットに読む。 -
リターン
ファイルの内容を返します。