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

#include <NetAnnot.h>

PdfTkNet::PtlAnnot の継承関係図
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 }

公開メンバ関数

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 ()
 注釈名を取得。

限定公開変数類

PdfTk::PtlAnnot * m_native

詳解

PDFの注釈を表現したクラスです。
すべての注釈クラスのベースクラスです。

列挙型メンバ詳解

◆ ANNOT_FLAGS

注釈フラグ。

列挙値
FLAG_INVISIBLE 

標準タイプに属さず、注釈ハンドラがない場合は、表示しません。

FLAG_HIDDEN 

注釈タイプあるいはハンドラの有無にかかわらず、この注釈の表示、印刷、およびユーザとの対話をできないようにします。

FLAG_PRINT 

ページが印刷される場合は注釈も印刷されます。

FLAG_NOZOOM 

注釈の外観をページの倍率にあわせて拡縮しません。

FLAG_NOROTATE 

注釈の外観をページにあわせて回転しません。

FLAG_NOVIEW 

スクリーン上に表示されず、ユーザとの対話もできなくなります。

FLAG_READONLY 

ユーザとの対話ができなくなります。

FLAG_LOCKED 

削除やプロパティを変更することはできなくなります。

FLAG_TOGGLE_NOVIEW 

特定のイベントに対して NoView フラグの解釈を反転します。

FLAG_LOCKED_CONTENTS 

注釈の内容を変更することはできなくなります。

◆ ANNOT_TYPE

enum class PdfTkNet::PtlAnnot::ANNOT_TYPE
strong

注釈のタイプ

列挙値
TYPE_TEXT 

テキスト注釈 Markup

TYPE_LINK 

リンク注釈

TYPE_FREE_TEXT 

フリーテキスト注釈 Markup

TYPE_LINE 

ライン注釈 Markup

TYPE_SQUARE 

矩形注釈 Markup

TYPE_CIRCLE 

円注釈 Markup

TYPE_POLYGON 

多角形注釈 Markup

TYPE_POLYLINE 

折れ線注釈 Markup

TYPE_HIGHLIGHT 

ハイライト注釈 Markup

TYPE_UNDERLINE 

下線注釈 Markup

TYPE_SQUIGGLY 

くねくね下線注釈 Markup

TYPE_STRIKEOUT 

ストライクアウト注釈 Markup

TYPE_STAMP 

スタンプ注釈 Markup

TYPE_CARET 

キャレット注釈 Markup

TYPE_INK 

インク注釈 Markup

TYPE_POPUP 

ポップアップ注釈

TYPE_FILE_ATTACHMENT 

ファイル添付注釈 Markup

TYPE_SOUND 

サウンド注釈 Markup

TYPE_MOVIE 

ムービー注釈

TYPE_WIDGET 

ウィジェット注釈

TYPE_SCREEN 

スクリーン注釈

TYPE_PRINTER_MARK 

プリンタマーク注釈

TYPE_TRAP_NETWORK 

トラップネットワーク注釈

TYPE_WATERMARK 

ウォーターマーク注釈

TYPE_3D 

3D注釈

TYPE_REDACT 

リダクト注釈 Markup

TYPE_PROJECTION 

プロジェクション注釈 Markup

TYPE_RICHMEDIA 

リッチメディア注釈

TYPE_UNKNOWN 

未対応注釈

◆ BORDER_LINE_WIDTH

境界線幅

列挙値
BORDER_WIDTH_NONE 

非表示

BORDER_WIDTH_THIN 

細い

BORDER_WIDTH_MIDDLE 

BORDER_WIDTH_THICK 

太い

◆ BORDER_STYLE

境界線スタイル

列挙値
BORDER_SOLID 

実線(注釈を囲む実線の矩形)

BORDER_DASHED 

破線(注釈を囲む破線の矩形)

BORDER_BEVELED 

ベベル(エンボス加工をシミュレートした矩形で、ページの表面から盛り上がって見えます)

BORDER_INSET 

インセット(彫刻をシミュレートした矩形で、ページの表面から窪んでいるように見えます)

BORDER_UNDERLINE 

下線(注釈の境界ボックスの最下部に沿った1本の線)

構築子と解体子

◆ PtlAnnot() [1/2]

PdfTkNet::PtlAnnot::PtlAnnot ( ANNOT_TYPE type)

コンストラクタ

引数
typeタイプ
例外
PtlException

◆ PtlAnnot() [2/2]

PdfTkNet::PtlAnnot::PtlAnnot ( PtlAnnot^ obj)

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

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

◆ ~PtlAnnot()

virtual PdfTkNet::PtlAnnot::~PtlAnnot ( )
virtual

デストラクタ

◆ !PtlAnnot()

PdfTkNet::PtlAnnot::!PtlAnnot ( )

ファイナライザ。

メソッド詳解

◆ getAnnotationName()

String PdfTkNet::PtlAnnot::getAnnotationName ( )

注釈名を取得。

注釈名(NM)を取得します。

戻り値
テキスト文字列
例外
PtlException

◆ getAnnotFlags()

ANNOT_FLAGS PdfTkNet::PtlAnnot::getAnnotFlags ( )

注釈フラグを取得。

フラグの定義が論理和で指定されています。

戻り値
フラグ。FLAG_XXXのフラグ。
例外
PtlException

◆ getBorderStyle()

BORDER_STYLE PdfTkNet::PtlAnnot::getBorderStyle ( )

境界線スタイルを取得。

戻り値
境界線スタイル。BORDER_XXXのいずれかの値。
例外
PtlException

◆ getBorderWidth()

BORDER_LINE_WIDTH PdfTkNet::PtlAnnot::getBorderWidth ( )

境界線幅をBORDER_LINE_WIDTHで取得。

境界線幅をPDFの設定値そのままで取得したい場合は、getBorderWidthNative()を使ってください。

戻り値
境界線幅。BORDER_WIDTH_XXXのいずれかの値。
例外
PtlException

◆ getBorderWidthNative()

float PdfTkNet::PtlAnnot::getBorderWidthNative ( )

注釈に設定してある境界線幅を直接取得。

戻り値
境界線幅。
例外
PtlException

◆ getColor()

PtlColor PdfTkNet::PtlAnnot::getColor ( )

色を取得。

下記注釈の色を取得します。
・FreeText : 線の色
・Line : 線の色
・Square : 線の色
・Circle : 線の色
・PolyLine : 線の色
・Polygon : 線の色
・Caret : Caretの色
・Ink : 線の色
・Squiggly : 線の色
・Highlight: Highlightの色
・Strikeout: Strikeoutの色
・Underline: Underlineの色

戻り値
色が設定されている場合は、PtlColorDeviceRGB。そうでない場合はPtlColorNone。
例外
PtlException

◆ getDate()

PtlDate PdfTkNet::PtlAnnot::getDate ( )

日時の取得。

戻り値
日時オブジェクト(PtlDate)
例外
PtlException

◆ getInteriorColor()

PtlColor PdfTkNet::PtlAnnot::getInteriorColor ( )

内部色を取得。

下記注釈の内部色を取得します。
・FreeText
・Line
・Square
・Circle
・PolyLine
・Polygon

戻り値
色が設定されている場合は、PtlColorDeviceRGB。そうでない場合はPtlColorNone。
例外
PtlException

◆ getNative()

PdfTk::PtlAnnot * PdfTkNet::PtlAnnot::getNative ( )

◆ getRect()

PtlRect PdfTkNet::PtlAnnot::getRect ( )

矩形座標を取得。

座標の単位はmmで原点(0,0)は左下となりますので注意してください。

戻り値
矩形座標
例外
PtlException

◆ getTextContents()

String PdfTkNet::PtlAnnot::getTextContents ( )

内容を取得。

テキスト文字列の内容を取得します。
注意:
このテキスト文字列は以下の目的で使用されます。

・注釈用に表示されるテキスト
・可読な形式での注釈コンテンツの代替説明
戻り値
テキスト文字列
例外
PtlException

◆ getType()

ANNOT_TYPE PdfTkNet::PtlAnnot::getType ( )

注釈タイプを取得。

戻り値
注釈タイプ
例外
PtlException

◆ isMarkup()

bool PdfTkNet::PtlAnnot::isMarkup ( )

マークアップ注釈か否かを取得。

マークアップ注釈か否かを取得します。

戻り値
true: マークアップ注釈。false: マークアップ注釈でない。
例外
PtlException

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setAnnotFlags()

void PdfTkNet::PtlAnnot::setAnnotFlags ( ANNOT_FLAGS flag)

注釈フラグを設定。

フラグの定義を論理和で指定します。
設定しない場合は、各注釈により下記の値が設定されたとみなされます。
PtlAnnotText : FLAG_PRINT|FLAG_NOZOOM|FLAG_NOROTATE
PtlAnnotLink : 0
PtlAnnotStamp : FLAG_PRINT
PtlAnnotPopup : FLAG_PRINT|FLAG_NOZOOM|FLAG_NOROTATE
PtlAnnotFileAttachment : FLAG_PRINT|FLAG_NOZOOM|FLAG_NOROTATE

引数
flagフラグ。FLAG_XXXのフラグ。
例外
PtlException

◆ setBorderStyle()

void PdfTkNet::PtlAnnot::setBorderStyle ( BORDER_STYLE style)

境界線スタイルを設定。

引数
style境界線スタイル。BORDER_XXXのいずれかの値。
例外
PtlException

◆ setBorderWidth()

void PdfTkNet::PtlAnnot::setBorderWidth ( BORDER_LINE_WIDTH width)

境界線幅をBORDER_LINE_WIDTHで設定。

境界線幅を指定した数値で直接設定したい場合は、setBorderWidthNative()を使ってください。

引数
width境界線幅。BORDER_WIDTH_XXXのいずれかの値。
例外
PtlException

◆ setBorderWidthNative()

void PdfTkNet::PtlAnnot::setBorderWidthNative ( float width)

注釈の境界線幅を数値で直接設定。

引数
width境界線幅。mm単位で指定してください。
例外
PtlException

◆ setColor()

void PdfTkNet::PtlAnnot::setColor ( PtlColorDeviceRGB^ color)

色を設定。

下記注釈の色を設定します。
・FreeText : 線の色
・Line : 線の色
・Square : 線の色
・Circle : 線の色
・PolyLine : 線の色
・Polygon : 線の色
・Caret : Caretの色
・Ink : 線の色
・Squiggly : 線の色
・Highlight: Highlightの色
・Strikeout: Strikeoutの色
・Underline: Underlineの色

引数
color
例外
PtlException

◆ setDate()

void PdfTkNet::PtlAnnot::setDate ( PtlDate^ date)

日時の設定。

引数
date設定する日時オブジェクト(PtlDate)
例外
PtlException

◆ setInteriorColor()

void PdfTkNet::PtlAnnot::setInteriorColor ( PtlColor^ color)

内部色を設定。

下記注釈の内部色を設定します。
・FreeText
・Line
・Square
・Circle
・PolyLine
・Polygon
指定できる色はPtlColorDeviceRGB,PtlColorNoneです。

引数
color
例外
PtlException

◆ setRect()

void PdfTkNet::PtlAnnot::setRect ( PtlRect^ rectMM)

矩形座標を設定。

座標の単位はmmで原点(0,0)は左下となりますので注意してください。
※ 注意事項
PtlAnnotTextMarkupはPtlQuadPointsにQuadPointを追加したら自動的に矩形座標は設定されますので
この関数で矩形座標を設定しないでください。
PtlAnnotPolygonはPtlPointsにPointを追加したら自動的に矩形座標は設定されますので
この関数で矩形座標を設定しないでください。

引数
rectMM矩形座標
例外
PtlException

◆ setTextContents()

void PdfTkNet::PtlAnnot::setTextContents ( String^ contents)

内容を設定。

テキスト文字列の内容を設定します。
注意:
このテキスト文字列は以下の目的で使用されます。

・注釈用に表示されるテキスト
・可読な形式での注釈コンテンツの代替説明
引数
contentsテキスト文字列
例外
PtlException

メンバ詳解

◆ m_native

PdfTk::PtlAnnot* PdfTkNet::PtlAnnot::m_native
protected