LEADTOOLS Leadtools.Documents(Leadtools.Documentsアセンブリ)

フレームを表示

GetAnnotationsメソッド(DocumentPage)






元々ページになければ空のLEADTOOLSアノテーションコンテナを作成して返す場合はTrue。そうでない場合ページがオリジナルのコンテナを持っていないならば、nullを返す場合はFalse.
このページのアノテーションコンテナを取得します。
構文
public AnnContainer GetAnnotations( 
   bool createEmpty
)
'Declaration
 
Public Function GetAnnotations( _
   ByVal createEmpty As Boolean _
) As AnnContainer
'Usage
 
Dim instance As DocumentPage
Dim createEmpty As Boolean
Dim value As AnnContainer
 
value = instance.GetAnnotations(createEmpty)
public AnnContainer getAnnotations(boolean createEmpty)
            
public:
AnnContainer^ GetAnnotations( 
   bool createEmpty
) 

パラメーター

createEmpty
元々ページになければ空のLEADTOOLSアノテーションコンテナを作成して返す場合はTrue。そうでない場合ページがオリジナルのコンテナを持っていないならば、nullを返す場合はFalse.

戻り値

利用可能な場合は、このページのアノテーションコンテナ。またはNull。
解説

GetAnnotationsは、このページのアノテーションコンテナを取得するのに用いられます。すべてのドキュメントタイプは、このメソッドをサポートします。

SetAnnotationsは、ページのアノテーションコンテナを置換するのに用いられます。IsAnnotationsModifiedは、ユーザーがこのページのアノテーションコンテナを置換したことを示すフラグとして使われます。

このメソッドは以下のように機能します(「項目」は、アノテーションコンテナです):

  1. 項目がキャッシュで見つけられるならば、それはすぐに返されます。ドキュメントがキャッシュシステムを用いて作成されるならば、これは利用できます。そして、Document.CacheOptionsDocumentCacheOptions.PageAnnotationsを格納します。AnnCodecsは、キャッシュで見つけられるデータからAnnContainerオブジェクトをロードするのに用いられます。

  2. これがソース文書ファイル内のオリジナルページである場合(値OriginalPageNumberは-1でない)、アノテーションはコンテナで、オリジナル文書からロードされます。詳細な情報のための下記を参照してください。

  3. これがソース文書ファイル内のオリジナルページでない場合(値OriginalPageNumberは1でない)、値createEmptyに応じて新しいAnnContainerオブジェクトが、ページサイズや解像度に基づいて作成されます。またはNullが使用されます。

  4. このドキュメントがキャッシュシステム(Document.HasCachetrueです)を使うならば、それが返される前に、AnnContainerオブジェクトはキャッシュに保存されます。次にこのメソッドが呼び出される時に、コンテナはファイルからそれをロードするか、新しいインスタンスを作成することなく直接キャッシュから返されます。

SetAnnotationsが以前にコンテナパラメーターのために無効なオブジェクトで呼び出されていた場合、このメソッドもnullを返すのでご注意ください。

全ての場合において、返されたAnnContainerオブジェクトはこのドキュメントにより用いられません、それが使われたあと、ユーザーはそれを削除する役割を果たします。

ドキュメントのオリジナルのアノテーションは、2つのやり方のいずれかで取得します。

どちらの場合も、オリジナルの文書またはアノテーションファイルに、このページのアノテーションコンテナがない場合、createEmptyを使ってnullを返すか、ページ用に空のコンテナを作成します。

1回の呼び出しで、1ページ以上のページに対してアノテーションコンテナオブジェクトの配列を取得または設定するためにDocumentAnnotations.GetAnnotationsとDocumentAnnotations.SetAnnotationsを使用できる点にご注意ください。

LEADTOOLSドキュメントビューワは、このメソッドを使用してこのページ用にアノテーションコンテナを取得します。

アノテーションオプションが変換の間、使われるとき、LEADTOOLSドキュメントコンバータはページのためにアノテーションコンテナを得るためにこのメソッドを使います。

詳細については、「LEADTOOLSドキュメントライブラリを使用したロード」を参照してください。

必要条件

ターゲットプラットホーム

参照

参照

DocumentPageクラス
DocumentPageメンバ

   Leadtools.Documentsは、DocumentまたはMedicalツールキットのライセンスと、解除キーが必要です。詳細は、以下を参照してください。LEADTOOLSツールキット機能