ページのコンテナを表現するクラスです。 More...

#include <NetPages.h>

Inheritance diagram for PdfTkNet::PtlPages:

Collaboration diagram for PdfTkNet::PtlPages:

Public Types
enum	INSERT_OPTION { INSERT_OPTION::OPTION_NONE = 0x00000000, INSERT_OPTION::OPTION_EXECPT_ANNOTS = 0x00000001, INSERT_OPTION::OPTION_EXCEPT_FORMS = 0x00000002, INSERT_OPTION::OPTION_COPY_OUTLINES = 0x00000004, INSERT_OPTION::OPTION_COPY_ATTACHEDFILES = 0x00000008 }
	ページ挿入オプション More...

enum	NUM_PAGES { NUM_PAGES::PAGE_ALL = -1 }
	挿入/削除するページ数。開始ページ以降全ページ対象。 More...

enum	INSERT_POS { INSERT_POS::INSERT_LAST = -1 }
	挿入する位置。 More...

Public Member Functions
PdfTk::PtlPages *	getNative ()

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

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

	‾PtlPages ()
	デストラクタ

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

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

bool	isEmpty ()
	空かどうかを取得。 More...

int	getCount ()
	ページ数を取得。 More...

PtlPage	get (int index)
	ページを取得。 More...

void	append (PtlPage^ page, INSERT_OPTION param)
	ページを追加。 More...

void	append (PtlPDFDocument^ doc, int fromNum, int numPages, INSERT_OPTION param)
	ページを追加。 More...

void	append (PtlParamImagePage^ paramImagePage)
	画像ページを追加。 More...

void	insert (int index, PtlPage^ page, INSERT_OPTION param)
	ページを挿入。 More...

void	insert (int index, PtlPDFDocument^ doc, int fromNum, int numPages, INSERT_OPTION param)
	ページを挿入。 More...

void	insert (int index, PtlParamImagePage^ paramImagePage)
	画像ページを挿入。 More...

void	move (int index, int fromNum, int numPages)
	ページを移動。 More...

void	remove (int index)
	ページを削除。 More...

void	remove (int index, int numPages)
	複数ページを削除。 More...

void	removeAll ()
	全ページを削除。 More...

Protected Attributes
PdfTk::PtlPages *	m_native

Detailed Description

ページのコンテナを表現するクラスです。

ページ番号は0オリジンとなっています。indexが0のものが先頭ページとなります。

Member Enumeration Documentation

◆ INSERT_OPTION

enum PdfTkNet::PtlPages::INSERT_OPTION

strong

ページ挿入オプション

Enumerator
OPTION_NONE	オプションはありません。
OPTION_EXECPT_ANNOTS	注釈を除外してページ挿入します。
OPTION_EXCEPT_FORMS	フォームを除外してページ挿入します。
OPTION_COPY_OUTLINES	ページ挿入時にあわせてしおりをコピーします。他PDFのページ挿入時に有効となります。
OPTION_COPY_ATTACHEDFILES	ページ挿入時にあわせて添付ファイルをコピーします。ここで言う添付ファイルは文書に添付されているものを指し、注釈に添付されているものは対象とはしません。他PDFのページ挿入時に有効となります。

◆ INSERT_POS

enum PdfTkNet::PtlPages::INSERT_POS

strong

挿入する位置。

Enumerator
INSERT_LAST	最後に挿入

◆ NUM_PAGES

enum PdfTkNet::PtlPages::NUM_PAGES

strong

挿入/削除するページ数。開始ページ以降全ページ対象。

Enumerator
PAGE_ALL	全ページ対象

Constructor & Destructor Documentation

◆ PtlPages() [1/2]

PdfTkNet::PtlPages::PtlPages ( )

コンストラクタ

Exceptions

PtlException

◆ PtlPages() [2/2]

PdfTkNet::PtlPages::PtlPages ( PtlPages^ obj )

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

◆ append() [1/3]

void PdfTkNet::PtlPages::append	(	PtlPage^	page,
		INSERT_OPTION	param
	)

ページを追加。

最後に、ページを追加します。

Parameters

page	ページ
param	ページ挿入オプションを論理和で指定

Exceptions

PtlException

◆ append() [2/3]

void PdfTkNet::PtlPages::append ( PtlParamImagePage^ paramImagePage )

画像ページを追加。

最後に、画像ページを追加します。
画像がTiffの場合、PtlParamImagePageでsetImagePageNumberに-1を設定すると、
Tiffのページ数分ページが追加されます。

Parameters

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

Exceptions

PtlException

◆ append() [3/3]

void PdfTkNet::PtlPages::append	(	PtlPDFDocument^	doc,
		int	fromNum,
		int	numPages,
		INSERT_OPTION	param
	)

ページを追加。

最後に、ページを追加します。

Parameters

doc	PDF文書
fromNum	開始ページ(ページ番号は0オリジン)
numPages	追加するページ数 PAGE_ALLの指定も可能です。
param	ページ挿入オプションを論理和で指定

Exceptions

PtlException

◆ get()

PtlPage PdfTkNet::PtlPages::get ( int index )

ページを取得。

指定位置にあるページを取得します。

Parameters

index 位置。0が先頭ページ。
indexが負やページ数以上の場合、例外が発生します。

Returns: ページ

Exceptions

PtlException

◆ getCount()

int PdfTkNet::PtlPages::getCount ( )

ページ数を取得。

Returns: ページ数

Exceptions

PtlException

◆ insert() [1/3]

void PdfTkNet::PtlPages::insert	(	int	index,
		PtlPage^	page,
		INSERT_OPTION	param
	)

ページを挿入。

指定位置に、指定されたページを挿入します。
指定位置にあったページと後続のページは後ろに移動します。

Parameters

index	位置。0が先頭ページ。 indexが負やページ数以上の場合、例外が発生します。
page	ページ
param	ページ挿入オプションを論理和で指定

Exceptions

PtlException

◆ insert() [2/3]

void PdfTkNet::PtlPages::insert	(	int	index,
		PtlParamImagePage^	paramImagePage
	)

画像ページを挿入。

指定位置に、画像ページを挿入します。
指定位置にあったページと後続のページは後ろに移動します。
画像がTiffの場合、PtlParamImagePageでsetImagePageNumberに-1を設定すると、
Tiffのページ数分ページが挿入されます。

Parameters

index	位置。0が先頭ページ。 indexが負やページ数以上の場合、例外が発生します。
paramImagePage	画像ページ挿入パラメータ。

Exceptions

PtlException

◆ insert() [3/3]

void PdfTkNet::PtlPages::insert	(	int	index,
		PtlPDFDocument^	doc,
		int	fromNum,
		int	numPages,
		INSERT_OPTION	param
	)

ページを挿入。

指定位置に、指定されたページを挿入します。
指定位置にあったページと後続のページは後ろに移動します。

Parameters

index	位置。0が先頭ページ。 indexが負やページ数以上の場合、例外が発生します。
doc	PDF文書
fromNum	開始ページ(ページ番号は0オリジン)
numPages	挿入するページ数 PAGE_ALLの指定も可能です。
param	ページ挿入オプションを論理和で指定

Exceptions

PtlException

◆ isEmpty()

bool PdfTkNet::PtlPages::isEmpty ( )

空かどうかを取得。

Returns: true: 空、false: 空ではない。

Exceptions

PtlException

◆ move()

void PdfTkNet::PtlPages::move	(	int	index,
		int	fromNum,
		int	numPages
	)

ページを移動。

指定位置に、指定されたページを移動します。

Parameters

index	位置。0が先頭ページ。 INSERT_LASTの指定も可能です。
fromNum	開始ページ(ページ番号は0オリジン)
numPages	移動するページ数 PAGE_ALLの指定も可能です。

Exceptions

PtlException

◆ operator=()

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

コピーオペレータ alias copy

Parameters

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

◆ remove() [1/2]

void PdfTkNet::PtlPages::remove ( int index )

ページを削除。

指定位置のページを削除し、後続のページを前につめます。

Parameters

index 位置。0が先頭ページ。
indexが負やページ数以上の場合、例外が発生します。

Exceptions

PtlException

◆ remove() [2/2]

void PdfTkNet::PtlPages::remove	(	int	index,
		int	numPages
	)

複数ページを削除。

指定位置のページから指定ページ数を削除し、後続のページを前につめます。

Parameters

index	位置。0が先頭ページ。 indexが負やページ数以上の場合、例外が発生します。
numPages	削除するページ数 PAGE_ALLの指定も可能です。

Exceptions

PtlException

◆ removeAll()

void PdfTkNet::PtlPages::removeAll ( )

全ページを削除。

Exceptions

PtlException

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ INSERT_OPTION

◆ INSERT_POS

◆ NUM_PAGES

Constructor & Destructor Documentation

◆ PtlPages() [1/2]

◆ PtlPages() [2/2]

Member Function Documentation

◆ append() [1/3]

◆ append() [2/3]

◆ append() [3/3]

◆ get()

◆ getCount()

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ isEmpty()

◆ move()

◆ operator=()

◆ remove() [1/2]

◆ remove() [2/2]

◆ removeAll()