GrapeCity.Documents.Pdf.Annotations.AnnotationBase

AnnotationBase クラス

すべての PDF 注釈タイプの抽象基本クラス。

継承

AnnotationBase

実装

IOwnedObject

IContentItem

IPdfDict

名前空間: GrapeCity.Documents.Pdf.Annotations

アセンブリ: DS.Documents.Pdf.dll

構文

public abstract class AnnotationBase : PdfDictWrapper, IOwnedObject, IContentItem, IPdfDict

Public MustInherit Class AnnotationBase
    Inherits PdfDictWrapper
    Implements IOwnedObject, IContentItem, IPdfDict

プロパティ

名前	説明
AppearanceState	注釈の外観状態を取得または設定します。これにより、外観のサブ辞書から適切な外観のストリームが選択されます。このプロパティを変更した場合、GcPdfはAppearanceStreamsで外観のコンテンツストリームを自動的に生成しないことに注意してください。詳細については、PDF 仕様を参照してください。
AppearanceStreams	この注釈の外観ストリームを定義するための AppearanceStreams オブジェクトを取得します。
AssociatedFiles	この　AnnotationBase　に関連付けられた埋め込みファイルのリストを取得します。
Contents	注釈に表示するテキストを取得または設定します。または、この注釈タイプがテキストを表示しない場合は、代わりに人が読める形式で注釈のコンテンツの説明を取得または設定します。どちらの場合も、このテキストは、障がいがあるユーザーのためのアクセシビリティサポートなどの目的で、ドキュメントのコンテンツを抽出する場合に便利です。
Doc	この注釈を所有する GcPdfDocument を取得します。
Flags	注釈のさまざまな特性を指定するフラグを取得または設定します。
HasAssociatedFiles	AssociatedFiles コレクションが空でないかどうかを示す値を取得します。
Layer	この注釈が属するレイヤーを指定するオブジェクトを取得または設定します。これは、OptionalContentGroupまたはOptionalContentMembershipのいずれかです。
Locked	ユーザーが注釈を削除できるかどうか、またはそのプロパティ（位置やサイズなど）を変更できるかどうかを示す値を取得または設定します。ただし、このフラグを設定しても、注釈のコンテンツ（フォームフィールドの値など）の変更は制限されません。
LockedContents	ユーザーが注釈のコンテンツを変更できるかどうかを示す値を取得または設定します。このフラグを設定しても、注釈の削除または他の注釈プロパティ（位置、サイズなど）の変更は制限されません。
ModifiedDate	注釈が修正された日時を取得または設定します。
Name	注釈名を取得または設定します。これは、ページ内のすべての注釈の中で特定の注釈を識別するためのテキスト文字列です。
Page	この注釈を含む Page を取得または設定します。注釈は複数のページから参照される可能性があることに注意してください。その場合、このプロパティは Pages コレクションの最初の要素を返します。このプロパティを設定すると、次のようになります: 新しい値が null の場合、この注釈はすべてのページから削除されます。それ以外の場合、この注釈は指定されたページに排他的に割り当てられます。
Pages	この注釈を参照するページのリストを取得します。
PdfRect	PDF ユーザー空間座標のページの注釈の位置とサイズを定義する四角形を取得または設定します。正の X 軸は水平に右に伸び、正の Y 軸は垂直に上に伸び、通常は原点がページの左下隅にあります。
Rect	ページの注釈の位置とサイズを定義する四角形を取得または設定します。点の座標は、ページのメディアボックスの左上隅を基準とし、Y (垂直) 座標は上から下に増加します。メモ：注釈が複数のページに関連付けられる場合、それらのページの最初のメディアボックスを使用して四角形の位置が計算されます。
UserData	現在の注釈に関連付けられた任意のデータを取得または設定します。このデータはランタイムのみであり、PDFに保持されないことに注意してください。

メソッド

名前	説明
CreateAppearanceContentStream()	注釈の外観ストリームを定義するために使用できるFormXObjectのインスタンスを作成します。このメソッドが呼び出されるとき、注釈はすでにドキュメントに追加されている必要があることに注意してください。追加されていない場合、例外が発生します。
DisableAppearanceGeneration()	ドキュメントを保存するときに、この注釈の外観ストリームの生成を無効にします。注釈の外観に影響するプロパティ (Rect など) が変更されると、外観ストリームが再生成されることに注意してください。したがって、このメソッドは通常、すべてのアノテーションのプロパティを初期化した後に呼び出されます。
RemoveAppearance()	現在の注釈に関連付けられているすべての外観ストリームを削除し、ドキュメントの保存時にこの注釈の外観ストリームの生成を無効にします。注釈の外観に影響を与えるプロパティ Rectなど)が変更された場合、外観ストリームが再生成されることにご注意ください。したがって、このメソッドは通常、すべての注釈のプロパティを初期化した後に呼び出されます。
ResetAppearance()	次にドキュメントを保存するときに、注釈の外観ストリームを強制的に再生成します。