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

#include <NetAnnot.h>

Inheritance diagram for PdfTkNet::PtlAnnot:

[legend]

Collaboration diagram for PdfTkNet::PtlAnnot:

Public Types
enum	ANNOT_TYPE { ANNOT_TYPE::TYPE_TEXT = 1, ANNOT_TYPE::TYPE_LINK = 2, ANNOT_TYPE::TYPE_FREE_TEXT = 3, ANNOT_TYPE::TYPE_LINE = 4, ANNOT_TYPE::TYPE_SQUARE = 5, ANNOT_TYPE::TYPE_CIRCLE = 6, ANNOT_TYPE::TYPE_POLYGON = 7, ANNOT_TYPE::TYPE_POLYLINE = 8, ANNOT_TYPE::TYPE_HIGHLIGHT = 9, ANNOT_TYPE::TYPE_UNDERLINE = 10, ANNOT_TYPE::TYPE_SQUIGGLY = 11, ANNOT_TYPE::TYPE_STRIKEOUT = 12, ANNOT_TYPE::TYPE_STAMP = 13, ANNOT_TYPE::TYPE_CARET = 14, ANNOT_TYPE::TYPE_INK = 15, ANNOT_TYPE::TYPE_POPUP = 16, ANNOT_TYPE::TYPE_FILE_ATTACHMENT = 17, ANNOT_TYPE::TYPE_SOUND = 18, ANNOT_TYPE::TYPE_MOVIE = 19, ANNOT_TYPE::TYPE_WIDGET = 20, ANNOT_TYPE::TYPE_SCREEN = 21, ANNOT_TYPE::TYPE_PRINTER_MARK = 22, ANNOT_TYPE::TYPE_TRAP_NETWORK = 23, ANNOT_TYPE::TYPE_WATERMARK = 24, ANNOT_TYPE::TYPE_3D = 25, ANNOT_TYPE::TYPE_REDACT = 26, ANNOT_TYPE::TYPE_PROJECTION = 27, ANNOT_TYPE::TYPE_RICHMEDIA = 28, ANNOT_TYPE::TYPE_UNKNOWN = 100 }
	注釈のタイプ More...

enum	ANNOT_FLAGS { ANNOT_FLAGS::FLAG_INVISIBLE = 0x00000001, ANNOT_FLAGS::FLAG_HIDDEN = 0x00000002, ANNOT_FLAGS::FLAG_PRINT = 0x00000004, ANNOT_FLAGS::FLAG_NOZOOM = 0x00000008, ANNOT_FLAGS::FLAG_NOROTATE = 0x00000010, ANNOT_FLAGS::FLAG_NOVIEW = 0x00000020, ANNOT_FLAGS::FLAG_READONLY = 0x00000040, ANNOT_FLAGS::FLAG_LOCKED = 0x00000080, ANNOT_FLAGS::FLAG_TOGGLE_NOVIEW = 0x00000100, ANNOT_FLAGS::FLAG_LOCKED_CONTENTS = 0x00000200 }
	注釈フラグ。 More...

enum	BORDER_STYLE { BORDER_STYLE::BORDER_SOLID = 1, BORDER_STYLE::BORDER_DASHED = 2, BORDER_STYLE::BORDER_BEVELED = 3, BORDER_STYLE::BORDER_INSET = 4, BORDER_STYLE::BORDER_UNDERLINE = 5 }
	境界線スタイル More...

enum	BORDER_LINE_WIDTH { BORDER_LINE_WIDTH::BORDER_WIDTH_NONE = 0, BORDER_LINE_WIDTH::BORDER_WIDTH_THIN = 1, BORDER_LINE_WIDTH::BORDER_WIDTH_MIDDLE = 2, BORDER_LINE_WIDTH::BORDER_WIDTH_THICK = 3 }
	境界線幅 More...

Public Member Functions
PdfTk::PtlAnnot *	getNative ()

	PtlAnnot (ANNOT_TYPE type)
	コンストラクタ More...

	PtlAnnot (PtlAnnot^ obj)
	コピーコンストラクタ alias copy More...

virtual	‾PtlAnnot ()
	デストラクタ

	!PtlAnnot ()
	ファイナライザ。

PtlAnnot	operator= (PtlAnnot^ obj)
	コピーオペレータ alias copy More...

ANNOT_TYPE	getType ()
	注釈タイプを取得。 More...

bool	isMarkup ()
	マークアップ注釈か否かを取得。 More...

PtlRect	getRect ()
	矩形座標を取得。 More...

void	setRect (PtlRect^ rectMM)
	矩形座標を設定。 More...

String	getTextContents ()
	内容を取得。 More...

void	setTextContents (String^ contents)
	内容を設定。 More...

PtlDate	getDate ()
	日時の取得。 More...

void	setDate (PtlDate^ date)
	日時の設定。 More...

ANNOT_FLAGS	getAnnotFlags ()
	注釈フラグを取得。 More...

void	setAnnotFlags (ANNOT_FLAGS flag)
	注釈フラグを設定。 More...

PtlColor	getColor ()
	色を取得。 More...

void	setColor (PtlColorDeviceRGB^ color)
	色を設定。 More...

PtlColor	getInteriorColor ()
	内部色を取得。 More...

void	setInteriorColor (PtlColorDeviceRGB^ color)
	内部色を設定。 More...

BORDER_STYLE	getBorderStyle ()
	境界線スタイルを取得。 More...

void	setBorderStyle (BORDER_STYLE style)
	境界線スタイルを設定。 More...

BORDER_LINE_WIDTH	getBorderWidth ()
	境界線幅をBORDER_LINE_WIDTHで取得。 More...

void	setBorderWidth (BORDER_LINE_WIDTH width)
	境界線幅をBORDER_LINE_WIDTHで設定。 More...

float	getBorderWidthNative ()
	注釈に設定してある境界線幅を直接取得。 More...

void	setBorderWidthNative (float width)
	注釈の境界線幅を数値で直接設定。 More...

Protected Attributes
PdfTk::PtlAnnot *	m_native

Detailed Description

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

Member Enumeration Documentation

◆ ANNOT_FLAGS

enum PdfTkNet::PtlAnnot::ANNOT_FLAGS

strong

注釈フラグ。

Enumerator
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 PdfTkNet::PtlAnnot::ANNOT_TYPE

strong

注釈のタイプ

Enumerator
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

enum PdfTkNet::PtlAnnot::BORDER_LINE_WIDTH

strong

境界線幅

Enumerator
BORDER_WIDTH_NONE	非表示
BORDER_WIDTH_THIN	細い
BORDER_WIDTH_MIDDLE	中
BORDER_WIDTH_THICK	太い

◆ BORDER_STYLE

enum PdfTkNet::PtlAnnot::BORDER_STYLE

strong

境界線スタイル

Enumerator
BORDER_SOLID	実線(注釈を囲む実線の矩形)
BORDER_DASHED	破線(注釈を囲む破線の矩形)
BORDER_BEVELED	ベベル(エンボス加工をシミュレートした矩形で、ページの表面から盛り上がって見えます)
BORDER_INSET	インセット(彫刻をシミュレートした矩形で、ページの表面から窪んでいるように見えます)
BORDER_UNDERLINE	下線(注釈の境界ボックスの最下部に沿った１本の線)

Constructor & Destructor Documentation

◆ PtlAnnot() [1/2]

PdfTkNet::PtlAnnot::PtlAnnot ( ANNOT_TYPE type )

コンストラクタ

Parameters

type タイプ

Exceptions

PtlException

◆ PtlAnnot() [2/2]

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

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

◆ getAnnotFlags()

ANNOT_FLAGS PdfTkNet::PtlAnnot::getAnnotFlags ( )

注釈フラグを取得。

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

Returns: フラグ。FLAG_XXXのフラグ。

Exceptions

PtlException

◆ getBorderStyle()

BORDER_STYLE PdfTkNet::PtlAnnot::getBorderStyle ( )

境界線スタイルを取得。

Returns: 境界線スタイル。BORDER_XXXのいずれかの値。

Exceptions

PtlException

◆ getBorderWidth()

BORDER_LINE_WIDTH PdfTkNet::PtlAnnot::getBorderWidth ( )

境界線幅をBORDER_LINE_WIDTHで取得。

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

Returns: 境界線幅。BORDER_WIDTH_XXXのいずれかの値。

Exceptions

PtlException

◆ getBorderWidthNative()

float PdfTkNet::PtlAnnot::getBorderWidthNative ( )

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

Returns: 境界線幅。

Exceptions

PtlException

◆ getColor()

PtlColor PdfTkNet::PtlAnnot::getColor ( )

色を取得。

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

Returns: 色が設定されている場合は、PtlColorDeviceRGB。そうでない場合はPtlColorNone。

Exceptions

PtlException

◆ getDate()

PtlDate PdfTkNet::PtlAnnot::getDate ( )

日時の取得。

Returns: 日時オブジェクト(PtlDate)

Exceptions

PtlException

◆ getInteriorColor()

PtlColor PdfTkNet::PtlAnnot::getInteriorColor ( )

内部色を取得。

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

Returns: 色が設定されている場合は、PtlColorDeviceRGB。そうでない場合はPtlColorNone。

Exceptions

PtlException

◆ getRect()

PtlRect PdfTkNet::PtlAnnot::getRect ( )

矩形座標を取得。

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

Returns: 矩形座標

Exceptions

PtlException

◆ getTextContents()

String PdfTkNet::PtlAnnot::getTextContents ( )

内容を取得。

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

・注釈用に表示されるテキスト
・可読な形式での注釈コンテンツの代替説明

Returns: テキスト文字列

Exceptions

PtlException

◆ getType()

ANNOT_TYPE PdfTkNet::PtlAnnot::getType ( )

注釈タイプを取得。

Returns: 注釈タイプ

Exceptions

PtlException

◆ isMarkup()

bool PdfTkNet::PtlAnnot::isMarkup ( )

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

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

Returns: true: マークアップ注釈。false: マークアップ注釈でない。

Exceptions

PtlException

◆ operator=()

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

コピーオペレータ alias copy

Parameters

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

◆ setAnnotFlags()

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

注釈フラグを設定。

Parameters

flag	フラグ。FLAG_XXXのフラグ。

Exceptions

PtlException

◆ setBorderStyle()

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

境界線スタイルを設定。

Parameters

style 境界線スタイル。BORDER_XXXのいずれかの値。

Exceptions

PtlException

◆ setBorderWidth()

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

境界線幅をBORDER_LINE_WIDTHで設定。

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

Parameters

width 境界線幅。BORDER_WIDTH_XXXのいずれかの値。

Exceptions

PtlException

◆ setBorderWidthNative()

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

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

Parameters

width 境界線幅。mm単位で指定してください。

Exceptions

PtlException

◆ setColor()

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

色を設定。

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

Parameters

color 色

Exceptions

PtlException

◆ setDate()

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

日時の設定。

Parameters

date	設定する日時オブジェクト(PtlDate)

Exceptions

PtlException

◆ setInteriorColor()

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

内部色を設定。

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

Parameters

color 色

Exceptions

PtlException

◆ setRect()

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

矩形座標を設定。

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

Parameters

rectMM 矩形座標

Exceptions

PtlException

◆ setTextContents()

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

内容を設定。

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

・注釈用に表示されるテキスト
・可読な形式での注釈コンテンツの代替説明

Parameters

contents テキスト文字列

Exceptions

PtlException

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ANNOT_FLAGS

◆ ANNOT_TYPE

◆ BORDER_LINE_WIDTH

◆ BORDER_STYLE

Constructor & Destructor Documentation

◆ PtlAnnot() [1/2]

◆ PtlAnnot() [2/2]

Member Function Documentation

◆ getAnnotFlags()

◆ getBorderStyle()

◆ getBorderWidth()

◆ getBorderWidthNative()

◆ getColor()

◆ getDate()

◆ getInteriorColor()

◆ getRect()

◆ getTextContents()

◆ getType()

◆ isMarkup()

◆ operator=()

◆ setAnnotFlags()

◆ setBorderStyle()

◆ setBorderWidth()

◆ setBorderWidthNative()

◆ setColor()

◆ setDate()

◆ setInteriorColor()

◆ setRect()

◆ setTextContents()