GetDocumentInfo
Editor.GetDocumentInfo method
この「エディタ」インスタンスにロードされたドキュメントに関するメタデータを返します
public IDocumentInfo GetDocumentInfo(string password)
パラメータ | タイプ | 説明 |
---|---|---|
password | String | ドキュメントがパスワードで暗号化されている場合、ユーザーはドキュメントのパスワードを指定できます。 NULL または空の文字列の場合があります。これは、パスワードがない場合と同等です。パスワード保護機能を持たないドキュメント形式の場合、この引数は無視されます。ドキュメントが暗号化されていて、パスワードがこのパラメーターで指定されていないが、これを作成するときにロード オプションで以前に指定された場合Editor たとえば、使用されます。 |
戻り値
フォーマット固有の継承者IDocumentInfo
フォーマット固有のメタデータを含む検出されたフォーマットを示すインターフェイス、またはドキュメントがサポート可能であると認識されなかった場合、または破損している場合は NULL, 。
例外
例外 | 調子 |
---|---|
ObjectDisposedException | 「GetDocumentInfo」が呼び出されたときに Editor インスタンスがすでに破棄されている場合にスローされます |
PasswordRequiredException | 読み込まれたドキュメントがパスワードで保護されているが、パスワードがパラメーターで指定されていない場合にスローされます。password" |
IncorrectPasswordException | 読み込まれたドキュメントがパスワードで保護され、パスワードが指定されているが正しくない場合にスローされます |
InvalidOperationException | 未知の性質の予期しないエラーが発生したときにスローされます |
備考
GetDocumentInfo メソッドは、入力ドキュメントがどの形式であるか、パスワードで保護されているか、含まれているページ/ワークシート/スライドの数が不明な場合に役立ちます。 GetDocumentInfo によって返されるこのメタデータに基づいて、メイン処理パイプラインの読み込みおよび編集オプションを正しく調整できます。
GetDocumentInfo メソッドは常に完全なデータを返します。試用モードの影響を受けず、その使用によって消費されたバイトまたはクレジットが取り消されることはありません。
もっと詳しく知る
- コードでドキュメント固有のプロパティを取得する方法の詳細: GroupDocs.Editor を使用してドキュメント情報を取得する方法
関連項目
- interface IDocumentInfo
- class Editor
- 名前空間 GroupDocs.Editor
- 組み立て GroupDocs.Editor