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

#include <NetEditElement.h>

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

公開型

enum class  ELEMENT_TYPE {
  TYPE_TEXT = 1 , TYPE_IMAGE = 2 , TYPE_PATH = 3 , TYPE_SHADING = 4 ,
  TYPE_MCCONTAINER = 5 , TYPE_MCPLACE = 6 , TYPE_FORMXOBJECT = 7 , TYPE_UNKNOWN = 100
}

公開メンバ関数

PdfTk::PtlEditElement * getNative ()
 PtlEditElement (ELEMENT_TYPE type)
 コンストラクタ
 PtlEditElement (PtlEditElement^ obj)
 コピーコンストラクタ
virtual ~PtlEditElement ()
 デストラクタ
 !PtlEditElement ()
 ファイナライザ。
PtlEditElement operator= (PtlEditElement^ obj)
 コピーオペレータ
ELEMENT_TYPE getType ()
 エレメントタイプを取得。
PtlTransMatrix getMatrix ()
 ページ/FormXObjectそれぞれの座標系でのMatrixを取得。
void setMatrix (PtlTransMatrix^ matrix)
 ページ/FormXObjectそれぞれの座標系でのMatrixを設定。
PtlTransMatrix getMatrixAtPage ()
 ページ座標系のMatrixを取得。
void setMatrixAtPage (PtlTransMatrix^ matrix)
 ページ座標系のMatrixを設定。
PtlRect getBBox ()
 ページ座標系のBBoxを取得。
PtlRect getClippedBBox ()
 クリッピングされたBBoxを取得。
PtlQuadPoint getQuadPoint ()
 ページ座標系のQuadPointを取得。
bool hasClip ()
 クリッピングがあるかどうかを取得。
PtlEditClip getClip ()
 クリッピングを取得。
void setClip (PtlEditClip^ clip)
 クリッピングを設定。

限定公開変数類

PdfTk::PtlEditElement * m_native

詳解

コンテントに描画されるエレメントを表現したクラスです。
すべてのエレメントクラスのベースクラスです。

列挙型メンバ詳解

◆ ELEMENT_TYPE

エレメントのタイプ

列挙値
TYPE_TEXT 

テキスト

TYPE_IMAGE 

画像

TYPE_PATH 

パス

TYPE_SHADING 

シェイディング

TYPE_MCCONTAINER 

Marked Content(BMC,BDC,EMC)

TYPE_MCPLACE 

Marked Content(MP,DP)

TYPE_FORMXOBJECT 

FormXObject

TYPE_UNKNOWN 

未対応エレメント

構築子と解体子

◆ PtlEditElement() [1/2]

PdfTkNet::PtlEditElement::PtlEditElement ( ELEMENT_TYPE type)

コンストラクタ

引数
typeタイプ
例外
PtlException

◆ PtlEditElement() [2/2]

PdfTkNet::PtlEditElement::PtlEditElement ( PtlEditElement^ obj)

コピーコンストラクタ

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

◆ ~PtlEditElement()

virtual PdfTkNet::PtlEditElement::~PtlEditElement ( )
virtual

デストラクタ

◆ !PtlEditElement()

PdfTkNet::PtlEditElement::!PtlEditElement ( )

ファイナライザ。

メソッド詳解

◆ getBBox()

PtlRect PdfTkNet::PtlEditElement::getBBox ( )

ページ座標系のBBoxを取得。

ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのBBoxがPtlOptionの設定に応じて取得されます。

戻り値
Rect ページでのBBox
例外
PtlException

◆ getClip()

PtlEditClip PdfTkNet::PtlEditElement::getClip ( )

クリッピングを取得。

hasClipでクリッピングがあるかどうかを確認したうえで使用してください。

戻り値
クリッピング
例外
PtlException

◆ getClippedBBox()

PtlRect PdfTkNet::PtlEditElement::getClippedBBox ( )

クリッピングされたBBoxを取得。

クリッピングされている場合、クリッピングされたBBoxを取得します。
ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのBBoxがPtlOptionの設定に応じて取得されます。

戻り値
Rect ページでのBBox
例外
PtlException

◆ getMatrix()

PtlTransMatrix PdfTkNet::PtlEditElement::getMatrix ( )

ページ/FormXObjectそれぞれの座標系でのMatrixを取得。

ページコンテント内のElementはページのユーザースペース空間座標系でのMatrixが取得されます。
FormXObjectコンテント内のElementはFormXObjectのユーザースペース空間座標系で実Matrixが取得されます。
PtlOptionは全て無視されユーザースペース空間での座標/ポイント単位で取得されます。

戻り値
Matrix ユーザースペース空間でのMatrix
例外
PtlException

◆ getMatrixAtPage()

PtlTransMatrix PdfTkNet::PtlEditElement::getMatrixAtPage ( )

ページ座標系のMatrixを取得。

ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのMatrixがPtlOptionの設定に応じて取得されます。
PtlOptionのsetCoodでCOOD_VIEWを設定しても、この関数ではその設定は無視されCOOD_USERが設定されているものとして値が取得されます。

戻り値
atrix ページでのMatrix
例外
PtlException

◆ getNative()

PdfTk::PtlEditElement * PdfTkNet::PtlEditElement::getNative ( )

◆ getQuadPoint()

PtlQuadPoint PdfTkNet::PtlEditElement::getQuadPoint ( )

ページ座標系のQuadPointを取得。

ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのQuadPointがPtlOptionの設定に応じて取得されます。

戻り値
QuadPoint ページでのQuadPoint
例外
PtlException

◆ getType()

ELEMENT_TYPE PdfTkNet::PtlEditElement::getType ( )

エレメントタイプを取得。

戻り値
エレメントタイプ
例外
PtlException

◆ hasClip()

bool PdfTkNet::PtlEditElement::hasClip ( )

クリッピングがあるかどうかを取得。

戻り値
true: クリッピングがある、false: クリッピングがない。
例外
PtlException

◆ operator=()

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

コピーオペレータ

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

◆ setClip()

void PdfTkNet::PtlEditElement::setClip ( PtlEditClip^ clip)

クリッピングを設定。

引数
clipクリッピング
例外
PtlException

◆ setMatrix()

void PdfTkNet::PtlEditElement::setMatrix ( PtlTransMatrix^ matrix)

ページ/FormXObjectそれぞれの座標系でのMatrixを設定。

ページコンテント内のElementはページのユーザースペース空間座標系でのMatrixを設定します。
FormXObjectコンテント内のElementはFormXObjectのユーザースペース空間座標系で実Matrixを設定します。
PtlOptionは全て無視されます。

引数
matrixユーザースペース空間でのMatrix
例外
PtlException

◆ setMatrixAtPage()

void PdfTkNet::PtlEditElement::setMatrixAtPage ( PtlTransMatrix^ matrix)

ページ座標系のMatrixを設定。

ページコンテント内のElementもFormXObjectコンテント内のElementもページ座標系でのMatrixがPtlOptionの設定に応じて設定されます。
PtlOptionのsetCoodでCOOD_VIEWを設定しても、この関数ではその設定は無視されCOOD_USERが設定されているものとして値が設定されます。

引数
matrixページベースでのMatrix
例外
PtlException

メンバ詳解

◆ m_native

PdfTk::PtlEditElement* PdfTkNet::PtlEditElement::m_native
protected