PDFのページオブジェクトを表現したクラスです。 More...

#include <NetPage.h>

Inheritance diagram for PdfTkNet::PtlPage:

Collaboration diagram for PdfTkNet::PtlPage:

Public Member Functions
PdfTk::PtlPage *	getNative ()

	PtlPage ()
	コンストラクタ More...

	PtlPage (PtlParamImagePage^ paramImagePage)
	コンストラクタ More...

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

	‾PtlPage ()
	デストラクタ

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

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

PtlRect	getViewBox ()
	ViewBoxを取得。 More...

void	setViewBox (PtlRect^ rectMM)
	ViewBoxを設定。 More...

PtlRect	getMediaBox ()
	MediaBoxを取得。 More...

void	setMediaBox (PtlRect^ rectMM)
	MediaBoxを設定。 More...

bool	hasCropBox ()
	CropBoxエントリーがあるかどうかを取得。 More...

PtlRect	getCropBox ()
	CropBoxを取得。 More...

void	setCropBox (PtlRect^ rectMM)
	CropBoxを設定。 More...

bool	hasBleedBox ()
	BleedBoxエントリーがあるかどうかを取得。 More...

PtlRect	getBleedBox ()
	BleedBoxを取得。 More...

void	setBleedBox (PtlRect^ rectMM)
	BleedBoxを設定。 More...

void	removeBleedBox ()
	BleedBoxを削除。 More...

bool	hasTrimBox ()
	TrimBoxエントリーがあるかどうかを取得。 More...

PtlRect	getTrimBox ()
	TrimBoxを取得。 More...

void	setTrimBox (PtlRect^ rectMM)
	TrimBoxを設定。 More...

void	removeTrimBox ()
	TrimBoxを削除。 More...

bool	hasArtBox ()
	ArtBoxエントリーがあるかどうかを取得。 More...

PtlRect	getArtBox ()
	ArtBoxを取得。 More...

void	setArtBox (PtlRect^ rectMM)
	ArtBoxを設定。 More...

void	removeArtBox ()
	ArtBoxを削除。 More...

PtlSize	getSize ()
	サイズを取得。 More...

PtlContent	getContent ()
	ページコンテントを取得。 More...

void	zoom (float ratio)
	ページを拡大縮小。 More...

void	setRotate (int value)
	回転角度を設定。 More...

int	getRotateNative ()
	PDFに設定してある/Rotateの値を取得。 More...

void	setRotateNative (int value)
	PDFの/Rotateに値を設定。 More...

bool	hasAnnots ()
	注釈があるかどうかを取得。 More...

PtlAnnots	getAnnots ()
	注釈コンテナを取得。 More...

bool	hasThumbnail ()
	サムネイルがあるかどうかを取得。 More...

void	removeThumbnail ()
	Thumbnailの削除。 More...

void	setMask (PtlParamSetMask^ paramSetMask)
	マスク設定。 More...

int	searchTextAndDoProcess (PtlParamSearchText^ paramSearchText)
	テキスト検索して後処理。 More...

PtlSearchTextResults	searchText (PtlParamSearchText^ paramSearchText)
	テキスト検索。 More...

Protected Attributes
PdfTk::PtlPage *	m_native

Detailed Description

PDFのページオブジェクトを表現したクラスです。

ページ番号は0オリジンとなっています。

Constructor & Destructor Documentation

◆ PtlPage() [1/3]

PdfTkNet::PtlPage::PtlPage ( )

コンストラクタ

Exceptions

PtlException

◆ PtlPage() [2/3]

PdfTkNet::PtlPage::PtlPage ( PtlParamImagePage^ paramImagePage )

コンストラクタ

Parameters

paramImagePage 画像ページ挿入パラメータ。

Exceptions

PtlException

◆ PtlPage() [3/3]

PdfTkNet::PtlPage::PtlPage ( PtlPage^ obj )

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

◆ getAnnots()

PtlAnnots PdfTkNet::PtlPage::getAnnots ( )

注釈コンテナを取得。

Returns: 注釈コンテナ。

Exceptions

PtlException

◆ getArtBox()

PtlRect PdfTkNet::PtlPage::getArtBox ( )

ArtBoxを取得。

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

Returns: ArtBoxの矩形(PtlRect)

Exceptions

PtlException

◆ getBleedBox()

PtlRect PdfTkNet::PtlPage::getBleedBox ( )

BleedBoxを取得。

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

Returns: BleedBoxの矩形(PtlRect)

Exceptions

PtlException

◆ getContent()

PtlContent PdfTkNet::PtlPage::getContent ( )

ページコンテントを取得。

PtlContentを取得して描画する場合は、PtlPageがPtlPagesに追加されたもの、若しくはPtlPagesから取得されたものでなければなりません。

Returns: ページコンテント。

Exceptions

PtlException

◆ getCropBox()

PtlRect PdfTkNet::PtlPage::getCropBox ( )

CropBoxを取得。

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

Returns: CropBoxの矩形(PtlRect)

Exceptions

PtlException

◆ getMediaBox()

PtlRect PdfTkNet::PtlPage::getMediaBox ( )

MediaBoxを取得。

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

Returns: MediaBoxの矩形(PtlRect)

Exceptions

PtlException

◆ getRotateNative()

int PdfTkNet::PtlPage::getRotateNative ( )

PDFに設定してある/Rotateの値を取得。

PDFの辞書に設定してある/Rotateの値を取得します。
/Rotateの値に関わらず、Contentに記述してある内容は/Rotate 0の状態で記述してありますが、
ビューワによって表示される際に、/Rotateの値に従って時計回りに回転されることになります。

Returns: 回転角度（時計回りに0, 90, 180, 270）。

Exceptions

PtlException

◆ getSize()

PtlSize PdfTkNet::PtlPage::getSize ( )

サイズを取得。

単位はmmとなりますので注意してください。

Returns: ページサイズ(PtlSize)

Exceptions

PtlException

◆ getTrimBox()

PtlRect PdfTkNet::PtlPage::getTrimBox ( )

TrimBoxを取得。

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

Returns: TrimBoxの矩形(PtlRect)

Exceptions

PtlException

◆ getViewBox()

PtlRect PdfTkNet::PtlPage::getViewBox ( )

ViewBoxを取得。

表示される矩形が取得されます。
座標の単位はmmで原点(0,0)は左下となりますので注意してください。

Returns: ViewBoxの矩形(PtlRect)

Exceptions

PtlException

◆ hasAnnots()

bool PdfTkNet::PtlPage::hasAnnots ( )

注釈があるかどうかを取得。

Returns: true: 注釈がある、false: 注釈がない。

Exceptions

PtlException

◆ hasArtBox()

bool PdfTkNet::PtlPage::hasArtBox ( )

ArtBoxエントリーがあるかどうかを取得。

Returns: true: ArtBoxがある、false: ArtBoxがない。

Exceptions

PtlException

◆ hasBleedBox()

bool PdfTkNet::PtlPage::hasBleedBox ( )

BleedBoxエントリーがあるかどうかを取得。

Returns: true: BleedBoxがある、false: BleedBoxがない。

Exceptions

PtlException

◆ hasCropBox()

bool PdfTkNet::PtlPage::hasCropBox ( )

CropBoxエントリーがあるかどうかを取得。

Returns: true: CropBoxがある、false: CropBoxがない。

Exceptions

PtlException

◆ hasThumbnail()

bool PdfTkNet::PtlPage::hasThumbnail ( )

サムネイルがあるかどうかを取得。

Returns: true: サムネイルがある、false: サムネイルがない。

Exceptions

PtlException

◆ hasTrimBox()

bool PdfTkNet::PtlPage::hasTrimBox ( )

TrimBoxエントリーがあるかどうかを取得。

Returns: true: TrimBoxがある、false: TrimBoxがない。

Exceptions

PtlException

◆ operator=()

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

コピーオペレータ alias copy

Parameters

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

Exceptions

PtlException

◆ removeArtBox()

void PdfTkNet::PtlPage::removeArtBox ( )

ArtBoxを削除。

Exceptions

PtlException

◆ removeBleedBox()

void PdfTkNet::PtlPage::removeBleedBox ( )

BleedBoxを削除。

Exceptions

PtlException

◆ removeThumbnail()

void PdfTkNet::PtlPage::removeThumbnail ( )

Thumbnailの削除。

Exceptions

PtlException

◆ removeTrimBox()

void PdfTkNet::PtlPage::removeTrimBox ( )

TrimBoxを削除。

Exceptions

PtlException

◆ searchText()

PtlSearchTextResults PdfTkNet::PtlPage::searchText ( PtlParamSearchText^ paramSearchText )

テキスト検索。

検索できるのはユニコードとして文字を取得できるもののみです。
またテキストに見えても実際は画像であったりパスであったりする場合もこれらは検索対象となりません。

Parameters

paramSearchText テキスト検索のパラメータ

Returns: PtlSearchTextResults。

Exceptions

PtlException

◆ searchTextAndDoProcess()

int PdfTkNet::PtlPage::searchTextAndDoProcess ( PtlParamSearchText^ paramSearchText )

テキスト検索して後処理。

検索できるのはユニコードとして文字を取得できるもののみです。
またテキストに見えても実際は画像であったりパスであったりする場合もこれらは検索対象となりません。
パラメータとしてPtlParamSearchTextAndHighlightが使用された場合は、検索された文字列に対してHighlight注釈処理が行われます。
パラメータとしてPtlParamSearchTextAndSetMaskが使用された場合は、検索された文字列に対してMask処理が行われます。
※ 注意事項
Mask処理は検索されたものは無条件に処理されます。
定型文書でない一般文書などでは想定外のテキストがMask処理されてしまうことがありますのでこの関数の使用には
十分注意して下さい。
(例) "元日", "本日"のようにテキストが取得された場合、"日本"で検索するとヒットして"日"と"本"は削除されていまいます。

Parameters

paramSearchText テキスト検索のパラメータ(PtlParamSearchTextAndHighlight若しくはPtlParamSearchTextAndSetMask)

Returns: 検索されたテキストの数。

Exceptions

PtlException

◆ setArtBox()

void PdfTkNet::PtlPage::setArtBox ( PtlRect^ rectMM )

ArtBoxを設定。

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

Parameters

rectMM ArtBoxの矩形(PtlRect)

Exceptions

PtlException

◆ setBleedBox()

void PdfTkNet::PtlPage::setBleedBox ( PtlRect^ rectMM )

BleedBoxを設定。

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

Parameters

rectMM BleedBoxの矩形(PtlRect)

Exceptions

PtlException

◆ setCropBox()

void PdfTkNet::PtlPage::setCropBox ( PtlRect^ rectMM )

CropBoxを設定。

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

Parameters

rectMM CropBoxの矩形(PtlRect)

Exceptions

PtlException

◆ setMask()

void PdfTkNet::PtlPage::setMask ( PtlParamSetMask^ paramSetMask )

マスク設定。

マスク矩形内のエレメントを削除します。
墨消しはこの関数を用いることにより実現できます。
※ 制限事項
矩形にエレメント全体が含まれた場合はエレメントは削除されますが、エレメントの一部
が矩形に囲まれた場合、囲まれた部分の部分削除が出来るのはテキストと画像だけです。
画像の部分削除が行われた場合、残された部分の色目などを完全に再現できるとは限りません。

Parameters

paramSetMask マスク設定のパラメータ

Exceptions

PtlException

◆ setMediaBox()

void PdfTkNet::PtlPage::setMediaBox ( PtlRect^ rectMM )

MediaBoxを設定。

座標の単位はmmで原点(0,0)は左下となりますので注意してください。
MediaBoxは他のBoxより先に設定してください。

Parameters

rectMM MediaBoxの矩形(PtlRect)

Exceptions

PtlException

◆ setRotate()

void PdfTkNet::PtlPage::setRotate ( int value )

回転角度を設定。

表示されるページを現在の状態からどれだけ時計回りに回転させるかを設定します。
角度は絶対値で90度単位になります。それ以外の値を指定した場合の動作は保証されません。
回転角度を設定する場合は他の関数より先に設定してください。

Parameters

value 回転角度（時計回りに0, 90, 180, 270）

Exceptions

PtlException

◆ setRotateNative()

void PdfTkNet::PtlPage::setRotateNative ( int value )

PDFの/Rotateに値を設定。

PDFの辞書にある/Rotateに値を設定します。
/Rotateの値に関わらず、Contentに記述してある内容は/Rotate 0の状態で記述してありますが、
ビューワによって表示される際に、/Rotateの値に従って時計回りに回転されることになります。

/Rotateに0以外の場合が設定されていてもビューワによる表示前の状態のことを考慮せずに、ビューワに
よって表示されている状態に描画できるのがPDFToolの特徴となっています。
しかしながら、ビューワによって回転される前の状態でページに描画したい用途もあるかもしれません。
そのような場合は、下記の様にすることで実現できます。

getRotateNative()関数で/Rotateの値を取得。
setRotateNativeに0を設定。
ここで、ビューワによって回転される前の状態に対して描画を行います。
setRotateNativeに1で取得した値を設定。

角度は絶対値で90度単位になります。それ以外の値を指定した場合の動作は保証されません。
回転角度を設定する場合は他の関数より先に設定してください。

Exceptions

PtlException

◆ setTrimBox()

void PdfTkNet::PtlPage::setTrimBox ( PtlRect^ rectMM )

TrimBoxを設定。

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

Parameters

rectMM TrimBoxの矩形(PtlRect)

Exceptions

PtlException

◆ setViewBox()

void PdfTkNet::PtlPage::setViewBox ( PtlRect^ rectMM )

ViewBoxを設定。

表示される矩形を設定します。
MediaBox,CropBoxに設定されます。
BleedBox,Trim,ArtBoxは削除されます。
座標の単位はmmで原点(0,0)は左下となりますので注意してください。

Parameters

rectMM ViewBoxの矩形(PtlRect)

Exceptions

PtlException

◆ zoom()

void PdfTkNet::PtlPage::zoom ( float ratio )

ページを拡大縮小。

Parameters

ratio 拡大縮小率
1.0が等倍です。0.1から10.0までの値を指定して下さい。

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PtlPage() [1/3]

◆ PtlPage() [2/3]

◆ PtlPage() [3/3]

Member Function Documentation

◆ getAnnots()

◆ getArtBox()

◆ getBleedBox()

◆ getContent()

◆ getCropBox()

◆ getMediaBox()

◆ getRotateNative()

◆ getSize()

◆ getTrimBox()

◆ getViewBox()

◆ hasAnnots()

◆ hasArtBox()

◆ hasBleedBox()

◆ hasCropBox()

◆ hasThumbnail()

◆ hasTrimBox()

◆ operator=()

◆ removeArtBox()

◆ removeBleedBox()

◆ removeThumbnail()

◆ removeTrimBox()

◆ searchText()

◆ searchTextAndDoProcess()

◆ setArtBox()

◆ setBleedBox()

◆ setCropBox()

◆ setMask()

◆ setMediaBox()

◆ setRotate()

◆ setRotateNative()

◆ setTrimBox()

◆ setViewBox()

◆ zoom()