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

#include <NetParamDrawLayer.h>

公開型

enum class  ZORDER { ZORDER_FRONT = 1 , ZORDER_BACK = 2 }
enum class  SHOW { SHOW_ON = 1 , SHOW_OFF = 2 }

公開メンバ関数

PdfTk::PtlParamDrawLayer * getNative ()
 PtlParamDrawLayer ()
 コンストラクタ
 PtlParamDrawLayer (PtlParamDrawLayer^ obj)
 コピーコンストラクタ alias copy
 ~PtlParamDrawLayer ()
 デストラクタ
 !PtlParamDrawLayer ()
 ファイナライザ。
PtlParamDrawLayer operator= (PtlParamDrawLayer^ obj)
 コピーオペレータ alias copy
void setPage (PtlPage^ page)
 レイヤーに使用するPDF文書ページを設定。
void setName (String^ name)
 レイヤーの名前を設定。
void setOpacity (float opacity)
 レイヤーの不透明度を設定。
void setRotate (int value)
 回転角度を設定。
void setAngle (float angle)
 任意の傾きを設定。
void setZorder (ZORDER zorder)
 レイヤーのZオーダーを設定。
void setShow (SHOW show)
 レイヤーの表示/非表示を設定。

限定公開変数類

PdfTk::PtlParamDrawLayer * m_native

詳解

レイヤーの描画に使うパラメータクラスです。

列挙型メンバ詳解

◆ SHOW

レイヤーの表示/非表示

列挙値
SHOW_ON 

表示(デフォルト値)

SHOW_OFF 

非表示

◆ ZORDER

レイヤーのZオーダー

列挙値
ZORDER_FRONT 

ページの前面(デフォルト値)

ZORDER_BACK 

ページの背面

構築子と解体子

◆ PtlParamDrawLayer() [1/2]

PdfTkNet::PtlParamDrawLayer::PtlParamDrawLayer ( )

コンストラクタ

例外
PtlException

◆ PtlParamDrawLayer() [2/2]

PdfTkNet::PtlParamDrawLayer::PtlParamDrawLayer ( PtlParamDrawLayer^ obj)

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

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

◆ ~PtlParamDrawLayer()

PdfTkNet::PtlParamDrawLayer::~PtlParamDrawLayer ( )

デストラクタ

◆ !PtlParamDrawLayer()

PdfTkNet::PtlParamDrawLayer::!PtlParamDrawLayer ( )

ファイナライザ。

メソッド詳解

◆ getNative()

PdfTk::PtlParamDrawLayer * PdfTkNet::PtlParamDrawLayer::getNative ( )

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setAngle()

void PdfTkNet::PtlParamDrawLayer::setAngle ( float angle)

任意の傾きを設定。

傾きの角度は時計回りに90度単位になります。
傾きを設定する場合は他の関数より先に設定してください。

引数
angle任意の角度で配置する。反時計回りが正の値。
例外
PtlException

◆ setName()

void PdfTkNet::PtlParamDrawLayer::setName ( String^ name)

レイヤーの名前を設定。

名前の設定は必須です。

引数
nameレイヤーの名前。
例外
PtlException

◆ setOpacity()

void PdfTkNet::PtlParamDrawLayer::setOpacity ( float opacity)

レイヤーの不透明度を設定。

設定しない場合はデフォルト値として1.0が設定されます。

引数
opacity0.0 〜 1.0。0.0が透明、1.0が不透明。
例外
PtlException

◆ setPage()

void PdfTkNet::PtlParamDrawLayer::setPage ( PtlPage^ page)

レイヤーに使用するPDF文書ページを設定。

ページ描画以外は欠落します(注釈など)。
レイヤーに使用するPDF文書のオブジェクト(PtlPDFDocument)はPDF文書を保存するまで存在していなければなりません。

引数
pageレイヤーに使用するPDF文書のページ。
例外
PtlException

◆ setRotate()

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

回転角度を設定。

回転角度は時計回りに90度単位になります。
回転角度を設定する場合は他の関数より先に設定してください。

引数
value回転角度(0, 90, 180, 270)
例外
PtlException

◆ setShow()

void PdfTkNet::PtlParamDrawLayer::setShow ( SHOW show)

レイヤーの表示/非表示を設定。

設定しない場合はデフォルト値としてSHOW_ONが使用されます。

引数
showレイヤーの表示/非表示。SHOW_XXXのいずれか。
例外
PtlException

◆ setZorder()

void PdfTkNet::PtlParamDrawLayer::setZorder ( ZORDER zorder)

レイヤーのZオーダーを設定。

設定しない場合はデフォルト値としてZORDER_FRONTが使用されます。

引数
zorderレイヤーのZオーダー。ZORDER_XXXのいずれか。
例外
PtlException

メンバ詳解

◆ m_native

PdfTk::PtlParamDrawLayer* PdfTkNet::PtlParamDrawLayer::m_native
protected