Antenna House PDF Tool API (.NET) 8.0
PdfTkNet::PtlAnnotText クラス

#include <NetAnnotText.h>

PdfTkNet::PtlAnnotText の継承関係図
Inheritance graph
[凡例]
PdfTkNet::PtlAnnotText 連携図
Collaboration graph
[凡例]

公開型

enum class  ICON_TYPE {
  ICON_COMMENT = 1 , ICON_HELP = 2 , ICON_INSERT = 3 , ICON_KEY = 4 ,
  ICON_NEWPARAGRAPH = 5 , ICON_NOTE = 6 , ICON_PARAGRAPH = 7 , ICON_CUSTOM = 99 ,
  ICON_UNKNOWN = 100
}
基底クラス PdfTkNet::PtlAnnot に属する継承公開型
enum class  ANNOT_TYPE {
  TYPE_TEXT = 1 , TYPE_LINK = 2 , TYPE_FREE_TEXT = 3 , TYPE_LINE = 4 ,
  TYPE_SQUARE = 5 , TYPE_CIRCLE = 6 , TYPE_POLYGON = 7 , TYPE_POLYLINE = 8 ,
  TYPE_HIGHLIGHT = 9 , TYPE_UNDERLINE = 10 , TYPE_SQUIGGLY = 11 , TYPE_STRIKEOUT = 12 ,
  TYPE_STAMP = 13 , TYPE_CARET = 14 , TYPE_INK = 15 , TYPE_POPUP = 16 ,
  TYPE_FILE_ATTACHMENT = 17 , TYPE_SOUND = 18 , TYPE_MOVIE = 19 , TYPE_WIDGET = 20 ,
  TYPE_SCREEN = 21 , TYPE_PRINTER_MARK = 22 , TYPE_TRAP_NETWORK = 23 , TYPE_WATERMARK = 24 ,
  TYPE_3D = 25 , TYPE_REDACT = 26 , TYPE_PROJECTION = 27 , TYPE_RICHMEDIA = 28 ,
  TYPE_UNKNOWN = 100
}
enum class  ANNOT_FLAGS {
  FLAG_INVISIBLE = 0x00000001 , FLAG_HIDDEN = 0x00000002 , FLAG_PRINT = 0x00000004 , FLAG_NOZOOM = 0x00000008 ,
  FLAG_NOROTATE = 0x00000010 , FLAG_NOVIEW = 0x00000020 , FLAG_READONLY = 0x00000040 , FLAG_LOCKED = 0x00000080 ,
  FLAG_TOGGLE_NOVIEW = 0x00000100 , FLAG_LOCKED_CONTENTS = 0x00000200
}
enum class  BORDER_STYLE {
  BORDER_SOLID = 1 , BORDER_DASHED = 2 , BORDER_BEVELED = 3 , BORDER_INSET = 4 ,
  BORDER_UNDERLINE = 5
}
enum class  BORDER_LINE_WIDTH { BORDER_WIDTH_NONE = 0 , BORDER_WIDTH_THIN = 1 , BORDER_WIDTH_MIDDLE = 2 , BORDER_WIDTH_THICK = 3 }

公開メンバ関数

 PtlAnnotText ()
 コンストラクタ
 PtlAnnotText (PtlAnnotText^ obj)
 コピーコンストラクタ alias copy
 ~PtlAnnotText ()
 デストラクタ
 !PtlAnnotText ()
 ファイナライザ。
PtlAnnotText operator= (PtlAnnotText^ obj)
 コピーオペレータ alias copy
ICON_TYPE getIconType ()
 アイコンタイプを取得。
void setIconType (ICON_TYPE type)
 アイコンタイプを設定。
String getIconName ()
 アイコン名を取得。
void setIconName (String^ name)
 アイコン名を設定。
void setPage (PtlPage^ page)
 カスタムアイコンに使用するPDF文書ページを設定。
基底クラス PdfTkNet::PtlAnnotMarkup に属する継承公開メンバ関数
 PtlAnnotMarkup (ANNOT_TYPE type)
 コンストラクタ
 PtlAnnotMarkup (PtlAnnotMarkup^ obj)
 コピーコンストラクタ alias copy
virtual ~PtlAnnotMarkup ()
 デストラクタ
 !PtlAnnotMarkup ()
 ファイナライザ。
PtlAnnotMarkup operator= (PtlAnnotMarkup^ obj)
 コピーオペレータ alias copy
String getMarkUpTitle ()
 ポップアップウィンドウのタイトル文字列を取得。
void setMarkUpTitle (String^title)
 ポップアップウィンドウのタイトル文字列を設定。
String getMarkUpSubj ()
 サブジェクトの短い説明を取得。
void setMarkUpSubj (String^subj)
 サブジェクトの短い説明を設定。
PtlDate getMarkUpDate ()
 注釈生成日時を取得。
void setMarkUpDate (PtlDate^ date)
 注釈生成日時を設定。
float getMarkUpCA ()
 不透明度を取得。
void setMarkUpCA (float ca)
 不透明度を設定。
bool hasAnnotPopup ()
 ポップアップ注釈を持つか否かを取得。
PtlAnnotPopup getAnnotPopup ()
 ポップアップ注釈を取得。
void setAnnotPopUp (PtlAnnotPopup^ popup)
 ポップアップ注釈を設定。
基底クラス PdfTkNet::PtlAnnot に属する継承公開メンバ関数
PdfTk::PtlAnnot * getNative ()
 PtlAnnot (ANNOT_TYPE type)
 コンストラクタ
 PtlAnnot (PtlAnnot^ obj)
 コピーコンストラクタ alias copy
virtual ~PtlAnnot ()
 デストラクタ
 !PtlAnnot ()
 ファイナライザ。
PtlAnnot operator= (PtlAnnot^ obj)
 コピーオペレータ alias copy
ANNOT_TYPE getType ()
 注釈タイプを取得。
bool isMarkup ()
 マークアップ注釈か否かを取得。
PtlRect getRect ()
 矩形座標を取得。
void setRect (PtlRect^ rectMM)
 矩形座標を設定。
String getTextContents ()
 内容を取得。
void setTextContents (String^ contents)
 内容を設定。
PtlDate getDate ()
 日時の取得。
void setDate (PtlDate^ date)
 日時の設定。
ANNOT_FLAGS getAnnotFlags ()
 注釈フラグを取得。
void setAnnotFlags (ANNOT_FLAGS flag)
 注釈フラグを設定。
PtlColor getColor ()
 色を取得。
void setColor (PtlColorDeviceRGB^ color)
 色を設定。
PtlColor getInteriorColor ()
 内部色を取得。
void setInteriorColor (PtlColor^ color)
 内部色を設定。
BORDER_STYLE getBorderStyle ()
 境界線スタイルを取得。
void setBorderStyle (BORDER_STYLE style)
 境界線スタイルを設定。
BORDER_LINE_WIDTH getBorderWidth ()
 境界線幅をBORDER_LINE_WIDTHで取得。
void setBorderWidth (BORDER_LINE_WIDTH width)
 境界線幅をBORDER_LINE_WIDTHで設定。
float getBorderWidthNative ()
 注釈に設定してある境界線幅を直接取得。
void setBorderWidthNative (float width)
 注釈の境界線幅を数値で直接設定。
String getAnnotationName ()
 注釈名を取得。

その他の継承メンバ

基底クラス PdfTkNet::PtlAnnot に属する継承限定公開変数類
PdfTk::PtlAnnot * m_native

詳解

PDFのテキスト注釈を表現したクラスです。

列挙型メンバ詳解

◆ ICON_TYPE

enum class PdfTkNet::PtlAnnotText::ICON_TYPE
strong

アイコンのタイプ

列挙値
ICON_COMMENT 

コメント

ICON_HELP 

ヘルプ

ICON_INSERT 

テキスト挿入

ICON_KEY 

キー

ICON_NEWPARAGRAPH 

新規段落

ICON_NOTE 

ノート

ICON_PARAGRAPH 

段落

ICON_CUSTOM 

カスタムアイコン

ICON_UNKNOWN 

未知のアイコン

構築子と解体子

◆ PtlAnnotText() [1/2]

PdfTkNet::PtlAnnotText::PtlAnnotText ( )

コンストラクタ

例外
PtlException

◆ PtlAnnotText() [2/2]

PdfTkNet::PtlAnnotText::PtlAnnotText ( PtlAnnotText^ obj)

コピーコンストラクタ alias copy

引数
objコピー元オブジェクト。
例外
PtlException

◆ ~PtlAnnotText()

PdfTkNet::PtlAnnotText::~PtlAnnotText ( )

デストラクタ

◆ !PtlAnnotText()

PdfTkNet::PtlAnnotText::!PtlAnnotText ( )

ファイナライザ。

メソッド詳解

◆ getIconName()

String PdfTkNet::PtlAnnotText::getIconName ( )

アイコン名を取得。

戻り値
アイコン名。
例外
PtlException

◆ getIconType()

ICON_TYPE PdfTkNet::PtlAnnotText::getIconType ( )

アイコンタイプを取得。

戻り値
アイコンタイプ。ICON_XXXのいずれかの値。
例外
PtlException

◆ operator=()

PtlAnnotText PdfTkNet::PtlAnnotText::operator= ( PtlAnnotText^ obj)

コピーオペレータ alias copy

引数
objコピー元オブジェクト。

◆ setIconName()

void PdfTkNet::PtlAnnotText::setIconName ( String^ name)

アイコン名を設定。

アイコンタイプとしてICON_CUSTOMを設定した場合にのみ有効となります。
ICON_CUSTOM以外のアイコンタイプでアイコン名を設定すると動作は不定です。

引数
nameアイコン名。
例外
PtlException

◆ setIconType()

void PdfTkNet::PtlAnnotText::setIconType ( ICON_TYPE type)

アイコンタイプを設定。

引数
typeアイコンタイプ。ICON_XXXのいずれかの値。
例外
PtlException

◆ setPage()

void PdfTkNet::PtlAnnotText::setPage ( PtlPage^ page)

カスタムアイコンに使用するPDF文書ページを設定。

引数
pageカスタムアイコンに使用するPDF文書のページ。
例外
PtlException