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

#include <NetDest.h>

PdfTkNet::PtlDest の継承関係図
Inheritance graph
[凡例]
PdfTkNet::PtlDest 連携図
Collaboration graph
[凡例]

公開型

enum class  DEST_TYPE {
  TYPE_NONE = 0 , TYPE_XYZ = 1 , TYPE_FIT = 2 , TYPE_FIT_H = 3 ,
  TYPE_FIT_V = 4 , TYPE_FIT_R = 5 , TYPE_FIT_B = 6 , TYPE_FIT_BH = 7 ,
  TYPE_FIT_BV = 8
}

公開メンバ関数

PdfTk::PtlDest * getNative ()
 PtlDest (DEST_TYPE type)
 コンストラクタ
 PtlDest (PtlDest^ obj)
 コピーコンストラクタ
virtual ~PtlDest ()
 デストラクタ
 !PtlDest ()
 ファイナライザ。
PtlDest operator= (PtlDest^ obj)
 コピーオペレータ
DEST_TYPE getType ()
 宛先タイプを取得。
int getPageNumber ()
 宛先ページを取得。
void setPageNumber (int page)
 宛先ページを設定。
bool isLeftNull ()
 leftがnullかどうかをチェック。
float getLeft ()
 leftを取得。
void setLeft (float value)
 leftに数値を設定。
void setLeftNull ()
 leftにnullを設定。
bool isBottomNull ()
 bottomがnullかどうかをチェック。
float getBottom ()
 bottomを取得。
void setBottom (float value)
 bottomに数値を設定。
void setBottomNull ()
 bottomにnullを設定。
bool isRightNull ()
 rightがnullかどうかをチェック。
float getRight ()
 rightを取得。
void setRight (float value)
 rightに数値を設定。
void setRightNull ()
 rightにnullを設定。
bool isTopNull ()
 topがnullかどうかをチェック。
float getTop ()
 topを取得。
void setTop (float value)
 topに数値を設定。
void setTopNull ()
 topにnullを設定。
bool isZoomNull ()
 zoomがnullかどうかをチェック。
float getZoom ()
 zoomを取得。
void setZoom (float value)
 zoomを設定。
void setZoomNull ()
 zoomにnullを設定。

限定公開変数類

PdfTk::PtlDest * m_native

詳解

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

※ 注意
PDFToolは座標の原点(0,0)は左下ですが、この宛先のクラスに関しては異なります。
ページは回転が設定されている場合があります。
宛先の座標は回転する前(回転が0)の座標になります。原点もページが回転する前の座標で(0,0)となります。

列挙型メンバ詳解

◆ DEST_TYPE

enum class PdfTkNet::PtlDest::DEST_TYPE
strong

宛先のタイプ

列挙値
TYPE_NONE 

宛先なし(取得時専用)

TYPE_XYZ 

XYZ型

TYPE_FIT 

Fit型(全体表示)

TYPE_FIT_H 

FitH型(幅に合わせる)

TYPE_FIT_V 

FitV型(高さに合わせる)

TYPE_FIT_R 

FitR型

TYPE_FIT_B 

FitB型

TYPE_FIT_BH 

FitBH型(描画領域の幅に合わせる)

TYPE_FIT_BV 

FitBV型

構築子と解体子

◆ PtlDest() [1/2]

PdfTkNet::PtlDest::PtlDest ( DEST_TYPE type)

コンストラクタ

引数
typeタイプ
例外
PtlException

◆ PtlDest() [2/2]

PdfTkNet::PtlDest::PtlDest ( PtlDest^ obj)

コピーコンストラクタ

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

◆ ~PtlDest()

virtual PdfTkNet::PtlDest::~PtlDest ( )
virtual

デストラクタ

◆ !PtlDest()

PdfTkNet::PtlDest::!PtlDest ( )

ファイナライザ。

メソッド詳解

◆ getBottom()

float PdfTkNet::PtlDest::getBottom ( )

bottomを取得。

nullの場合、例外がスローされます。事前にisBottomNullでチェックしてください。
座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

戻り値
bottom値
例外
PtlException

◆ getLeft()

float PdfTkNet::PtlDest::getLeft ( )

leftを取得。

nullの場合、例外がスローされます。事前にisLeftNullでチェックしてください。
座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

戻り値
left値
例外
PtlException

◆ getNative()

PdfTk::PtlDest * PdfTkNet::PtlDest::getNative ( )

◆ getPageNumber()

int PdfTkNet::PtlDest::getPageNumber ( )

宛先ページを取得。

ページ番号は0オリジンです。

戻り値
宛先ページ番号
例外
PtlException

◆ getRight()

float PdfTkNet::PtlDest::getRight ( )

rightを取得。

nullの場合、例外がスローされます。事前にisRightNullでチェックしてください。
座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

戻り値
right値
例外
PtlException

◆ getTop()

float PdfTkNet::PtlDest::getTop ( )

topを取得。

nullの場合、例外がスローされます。事前にisTopNullでチェックしてください。
座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

戻り値
top値
例外
PtlException

◆ getType()

DEST_TYPE PdfTkNet::PtlDest::getType ( )

宛先タイプを取得。

戻り値
宛先タイプ
例外
PtlException

◆ getZoom()

float PdfTkNet::PtlDest::getZoom ( )

zoomを取得。

nullの場合、例外がスローされます。事前にisZoomNullでチェックしてください。

戻り値
zoom値
例外
PtlException

◆ isBottomNull()

bool PdfTkNet::PtlDest::isBottomNull ( )

bottomがnullかどうかをチェック。

戻り値
true: null、false: 数値。
例外
PtlException

◆ isLeftNull()

bool PdfTkNet::PtlDest::isLeftNull ( )

leftがnullかどうかをチェック。

戻り値
true: null、false: 数値。
例外
PtlException

◆ isRightNull()

bool PdfTkNet::PtlDest::isRightNull ( )

rightがnullかどうかをチェック。

戻り値
true: null、false: 数値。
例外
PtlException

◆ isTopNull()

bool PdfTkNet::PtlDest::isTopNull ( )

topがnullかどうかをチェック。

戻り値
true: null、false: 数値。
例外
PtlException

◆ isZoomNull()

bool PdfTkNet::PtlDest::isZoomNull ( )

zoomがnullかどうかをチェック。

戻り値
true: null、false: 数値。
例外
PtlException

◆ operator=()

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

コピーオペレータ

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

◆ setBottom()

void PdfTkNet::PtlDest::setBottom ( float value)

bottomに数値を設定。

座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

引数
valuebottom値
例外
PtlException

◆ setBottomNull()

void PdfTkNet::PtlDest::setBottomNull ( )

bottomにnullを設定。

例外
PtlException

◆ setLeft()

void PdfTkNet::PtlDest::setLeft ( float value)

leftに数値を設定。

座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

引数
valueleft値
例外
PtlException

◆ setLeftNull()

void PdfTkNet::PtlDest::setLeftNull ( )

leftにnullを設定。

例外
PtlException

◆ setPageNumber()

void PdfTkNet::PtlDest::setPageNumber ( int page)

宛先ページを設定。

ページ番号は0オリジンです。

引数
page宛先ページ番号
例外
PtlException

◆ setRight()

void PdfTkNet::PtlDest::setRight ( float value)

rightに数値を設定。

座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください

引数
valueright値
例外
PtlException

◆ setRightNull()

void PdfTkNet::PtlDest::setRightNull ( )

rightにnullを設定。

例外
PtlException

◆ setTop()

void PdfTkNet::PtlDest::setTop ( float value)

topに数値を設定。

座標の単位はmmで原点(0,0)はページが回転する前の座標での左下となりますので注意してください。

引数
valuetop値
例外
PtlException

◆ setTopNull()

void PdfTkNet::PtlDest::setTopNull ( )

topにnullを設定。

例外
PtlException

◆ setZoom()

void PdfTkNet::PtlDest::setZoom ( float value)

zoomを設定。

引数
valuezoom値
例外
PtlException

◆ setZoomNull()

void PdfTkNet::PtlDest::setZoomNull ( )

zoomにnullを設定。

例外
PtlException

メンバ詳解

◆ m_native

PdfTk::PtlDest* PdfTkNet::PtlDest::m_native
protected