PdfTkNet::PtlAnnotFileAttachment Class Reference

PDFのファイル添付注釈を表現したクラスです。 More...

#include <NetAnnotFileAttachment.h>

Inheritance diagram for PdfTkNet::PtlAnnotFileAttachment:

Collaboration diagram for PdfTkNet::PtlAnnotFileAttachment:

Public Types
enum	ICON_TYPE {   ICON_TYPE::ICON_GRAPH = 1, ICON_TYPE::ICON_PAPERCLIP = 2, ICON_TYPE::ICON_PUSHPIN = 3, ICON_TYPE::ICON_TAG = 4,   ICON_TYPE::ICON_CUSTOM = 99, ICON_TYPE::ICON_UNKNOWN = 100 }
	アイコンのタイプ More...
Public Types inherited from PdfTkNet::PtlAnnot
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
	PtlAnnotFileAttachment ()
	コンストラクタ More...
	PtlAnnotFileAttachment (PtlAnnotFileAttachment^ obj)
	コピーコンストラクタ alias copy More...
	‾PtlAnnotFileAttachment ()
	デストラクタ
	!PtlAnnotFileAttachment ()
	ファイナライザ。
PtlAnnotFileAttachment	operator= (PtlAnnotFileAttachment^ obj)
	コピーオペレータ alias copy More...
ICON_TYPE	getIconType ()
	アイコンタイプを取得。 More...
void	setIconType (ICON_TYPE type)
	アイコンタイプを設定。 More...
String	getIconName ()
	アイコン名を取得。 More...
void	setIconName (String^name)
	アイコン名を設定。 More...
void	setPage (PtlPage^ page)
	カスタムアイコンに使用するPDF文書ページを設定。 More...
String	getFileName ()
	添付ファイル名を取得。 More...
void	setFileName (String^filename)
	添付ファイル名を設定。 More...
void	readFile (PtlParamInput^ inParam)
	添付するファイルの読み込み。 More...
void	writeFile (PtlParamOutput^ outParam)
	添付ファイルの書き出し。 More...
Public Member Functions inherited from PdfTkNet::PtlAnnotMarkup
	PtlAnnotMarkup (ANNOT_TYPE type)
	コンストラクタ More...
	PtlAnnotMarkup (PtlAnnotMarkup^ obj)
	コピーコンストラクタ alias copy More...
virtual	‾PtlAnnotMarkup ()
	デストラクタ
	!PtlAnnotMarkup ()
	ファイナライザ。
PtlAnnotMarkup	operator= (PtlAnnotMarkup^ obj)
	コピーオペレータ alias copy More...
String	getMarkUpTitle ()
	ポップアップウィンドウのタイトル文字列を取得。 More...
void	setMarkUpTitle (String^title)
	ポップアップウィンドウのタイトル文字列を設定。 More...
String	getMarkUpSubj ()
	サブジェクトの短い説明を取得。 More...
void	setMarkUpSubj (String^subj)
	サブジェクトの短い説明を設定。 More...
PtlDate	getMarkUpDate ()
	注釈生成日時を取得。 More...
void	setMarkUpDate (PtlDate^ date)
	注釈生成日時を設定。 More...
float	getMarkUpCA ()
	不透明度を取得。 More...
void	setMarkUpCA (float ca)
	不透明度を設定。 More...
bool	hasAnnotPopup ()
	ポップアップ注釈を持つか否かを取得。 More...
PtlAnnotPopup	getAnnotPopup ()
	ポップアップ注釈を取得。 More...
void	setAnnotPopUp (PtlAnnotPopup^ popup)
	ポップアップ注釈を設定。 More...
Public Member Functions inherited from PdfTkNet::PtlAnnot
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...

Additional Inherited Members
Protected Attributes inherited from PdfTkNet::PtlAnnot
PdfTk::PtlAnnot *	m_native

Detailed Description

PDFのファイル添付注釈を表現したクラスです。

Member Enumeration Documentation

ICON_TYPE

enum PdfTkNet::PtlAnnotFileAttachment::ICON_TYPE

strong

アイコンのタイプ

Enumerator
ICON_GRAPH	グラフ
ICON_PAPERCLIP	ペーパークリップ
ICON_PUSHPIN	プッシュピン
ICON_TAG	タグ
ICON_CUSTOM	カスタムアイコン
ICON_UNKNOWN	未知のアイコン

Constructor & Destructor Documentation

PtlAnnotFileAttachment() [1/2]

PdfTkNet::PtlAnnotFileAttachment::PtlAnnotFileAttachment

(

)

コンストラクタ

Exceptions

PtlException

PtlAnnotFileAttachment() [2/2]

PdfTkNet::PtlAnnotFileAttachment::PtlAnnotFileAttachment

(

PtlAnnotFileAttachment^

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

getFileName()

String PdfTkNet::PtlAnnotFileAttachment::getFileName

(

)

添付ファイル名を取得。

Returns

添付ファイル名

Exceptions

PtlException

getIconName()

String PdfTkNet::PtlAnnotFileAttachment::getIconName

(

)

アイコン名を取得。

Returns

アイコン名。

Exceptions

PtlException

getIconType()

ICON_TYPE PdfTkNet::PtlAnnotFileAttachment::getIconType

(

)

アイコンタイプを取得。

Returns

アイコンタイプ。ICON_XXXのいずれかの値。

Exceptions

PtlException

operator=()

PtlAnnotFileAttachment PdfTkNet::PtlAnnotFileAttachment::operator=

(

PtlAnnotFileAttachment^

obj

)

コピーオペレータ alias copy

Parameters

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

readFile()

void PdfTkNet::PtlAnnotFileAttachment::readFile

(

PtlParamInput^

inParam

)

添付するファイルの読み込み。

Parameters

inParam

入力指定パラメータ。

Exceptions

PtlException

setFileName()

void PdfTkNet::PtlAnnotFileAttachment::setFileName

(

String^

filename

)

添付ファイル名を設定。

Adobe製品では拡張子付きのファイル名を設定しておかないと添付ファイルを取り出せないようです。

Parameters

filename

添付ファイル名 注意：filenameにはファイル名のみを指定し、パスを含めないでください。

Exceptions

PtlException

setIconName()

void PdfTkNet::PtlAnnotFileAttachment::setIconName

(

String^

name

)

アイコン名を設定。

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

Parameters

name

アイコン名。

Exceptions

PtlException

setIconType()

void PdfTkNet::PtlAnnotFileAttachment::setIconType

(

ICON_TYPE

type

)

アイコンタイプを設定。

Parameters

type	アイコンタイプ。ICON_XXXのいずれかの値。

Exceptions

PtlException

setPage()

void PdfTkNet::PtlAnnotFileAttachment::setPage

(

PtlPage^

page

)

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

Parameters

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

Exceptions

PtlException

writeFile()

void PdfTkNet::PtlAnnotFileAttachment::writeFile

(

PtlParamOutput^

outParam

)

添付ファイルの書き出し。

Parameters

outParam

出力指定パラメータ。

Exceptions

PtlException