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

#include <NetPages.h>

PdfTkNet::PtlPages の継承関係図
PdfTkNet::PtlPages 連携図

公開型

enum class  INSERT_OPTION {
  OPTION_NONE = 0x00000000 , OPTION_EXECPT_ANNOTS = 0x00000001 , OPTION_EXCEPT_FORMS = 0x00000002 , OPTION_COPY_OUTLINES = 0x00000004 ,
  OPTION_COPY_ATTACHEDFILES = 0x00000008
}
enum class  NUM_PAGES { PAGE_ALL = -1 }
enum class  INSERT_POS { INSERT_LAST = -1 }

公開メンバ関数

PdfTk::PtlPages * getNative ()
 PtlPages ()
 コンストラクタ
 PtlPages (PtlPages^ obj)
 コピーコンストラクタ alias copy
 ~PtlPages ()
 デストラクタ
 !PtlPages ()
 ファイナライザ。
PtlPages operator= (PtlPages^ obj)
 コピーオペレータ alias copy
bool isEmpty ()
 空かどうかを取得。
int getCount ()
 ページ数を取得。
PtlPage get (int index)
 ページを取得。
void append (PtlPage^ page, INSERT_OPTION param)
 ページを追加。
void append (PtlPDFDocument^ doc, int fromNum, int numPages, INSERT_OPTION param)
 ページを追加。
void append (PtlParamImagePage^ paramImagePage)
 画像ページを追加。
void insert (int index, PtlPage^ page, INSERT_OPTION param)
 ページを挿入。
void insert (int index, PtlPDFDocument^ doc, int fromNum, int numPages, INSERT_OPTION param)
 ページを挿入。
void insert (int index, PtlParamImagePage^ paramImagePage)
 画像ページを挿入。
void move (int index, int fromNum, int numPages)
 ページを移動。
void remove (int index)
 ページを削除。
void remove (int index, int numPages)
 複数ページを削除。
void removeAll ()
 全ページを削除。

限定公開変数類

PdfTk::PtlPages * m_native

詳解

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

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

列挙型メンバ詳解

◆ INSERT_OPTION

ページ挿入オプション

列挙値
OPTION_NONE 

オプションはありません。

OPTION_EXECPT_ANNOTS 

注釈を除外してページ挿入します。

OPTION_EXCEPT_FORMS 

フォームを除外してページ挿入します。

OPTION_COPY_OUTLINES 

ページ挿入時にあわせてしおりをコピーします。 他PDFのページ挿入時に有効となります。

OPTION_COPY_ATTACHEDFILES 

ページ挿入時にあわせて添付ファイルをコピーします。 ここで言う添付ファイルは文書に添付されているものを指し、注釈に添付されているものは対象とはしません。 他PDFのページ挿入時に有効となります。

◆ INSERT_POS

enum class PdfTkNet::PtlPages::INSERT_POS
strong

挿入する位置。

列挙値
INSERT_LAST 

最後に挿入

◆ NUM_PAGES

enum class PdfTkNet::PtlPages::NUM_PAGES
strong

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

列挙値
PAGE_ALL 

全ページ対象

構築子と解体子

◆ PtlPages() [1/2]

PdfTkNet::PtlPages::PtlPages ( )

コンストラクタ

例外
PtlException

◆ PtlPages() [2/2]

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

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

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

◆ ~PtlPages()

PdfTkNet::PtlPages::~PtlPages ( )

デストラクタ

◆ !PtlPages()

PdfTkNet::PtlPages::!PtlPages ( )

ファイナライザ。

メソッド詳解

◆ append() [1/3]

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

ページを追加。

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

引数
pageページ
paramページ挿入オプションを論理和で指定
例外
PtlException

◆ append() [2/3]

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

画像ページを追加。

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

引数
paramImagePage画像ページ挿入パラメータ。
例外
PtlException

◆ append() [3/3]

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

ページを追加。

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

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

◆ get()

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

ページを取得。

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

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

◆ getCount()

int PdfTkNet::PtlPages::getCount ( )

ページ数を取得。

戻り値
ページ数
例外
PtlException

◆ getNative()

PdfTk::PtlPages * PdfTkNet::PtlPages::getNative ( )

◆ insert() [1/3]

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

ページを挿入。

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

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

◆ insert() [2/3]

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

画像ページを挿入。

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

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

◆ insert() [3/3]

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

ページを挿入。

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

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

◆ isEmpty()

bool PdfTkNet::PtlPages::isEmpty ( )

空かどうかを取得。

戻り値
true: 空、false: 空ではない。
例外
PtlException

◆ move()

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

ページを移動。

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

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

◆ operator=()

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

コピーオペレータ alias copy

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

◆ remove() [1/2]

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

ページを削除。

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

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

◆ remove() [2/2]

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

複数ページを削除。

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

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

◆ removeAll()

void PdfTkNet::PtlPages::removeAll ( )

全ページを削除。

例外
PtlException

メンバ詳解

◆ m_native

PdfTk::PtlPages* PdfTkNet::PtlPages::m_native
protected