透かしの設定で使うパラメータクラスです。
すべての透かしパラメータクラスのベースクラスです。 More...

#include <NetParamWaterMark.h>

Inheritance diagram for PdfTkNet::PtlParamWaterMark:

[legend]

Collaboration diagram for PdfTkNet::PtlParamWaterMark:

Public Types
enum	TYPE_WATERMARK { TYPE_WATERMARK::TYPE_COLOR = 1, TYPE_WATERMARK::TYPE_TEXT = 2, TYPE_WATERMARK::TYPE_PDF = 3, TYPE_WATERMARK::TYPE_IMAGE = 4 }
	透かしのタイプ More...

enum	ALIGN { ALIGN::ALIGN_TOP_LEFT = 1, ALIGN::ALIGN_TOP = 2, ALIGN::ALIGN_TOP_RIGHT = 3, ALIGN::ALIGN_LEFT = 4, ALIGN::ALIGN_CENTER = 5, ALIGN::ALIGN_RIGHT = 6, ALIGN::ALIGN_BOTTOM_LEFT = 7, ALIGN::ALIGN_BOTTOM = 8, ALIGN::ALIGN_BOTTOM_RIGHT = 9 }
	透かしの配置 More...

enum	ZORDER { ZORDER::ZORDER_FRONT = 1, ZORDER::ZORDER_BACK = 2 }
	透かしのZオーダー More...

enum	PAGE_RANGE { PAGE_RANGE::PAGE_RANGE_ALL = 0, PAGE_RANGE::PAGE_RANGE_FIRST = 1, PAGE_RANGE::PAGE_RANGE_LAST = 2, PAGE_RANGE::PAGE_RANGE_ODD = 3, PAGE_RANGE::PAGE_RANGE_EVEN = 4, PAGE_RANGE::PAGE_RANGE_CUSTOM = 5 }
	透かしを入れるページの範囲 More...

Public Member Functions
PdfTk::PtlParamWaterMark *	getNative ()

	PtlParamWaterMark (TYPE_WATERMARK type)
	コンストラクタ More...

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

virtual	‾PtlParamWaterMark ()
	デストラクタ

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

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

TYPE_WATERMARK	getType ()
	透かしタイプ取得。 More...

void	setName (String^ name)
	透かしの名前を設定。 More...

void	setRect (PtlRect^ rectMM)
	透かしを配置する矩形を設定。 More...

void	setMargin (float topMM, float leftMM, float bottomMM, float rightMM)
	透かしを配置するときの余白を設定。 More...

void	setAlign (ALIGN align)
	透かしの配置を設定。 More...

void	setZorder (ZORDER zorder)
	透かしのZオーダーを設定。 More...

void	setPageRange (PAGE_RANGE pageRange)
	透かしを入れるページの範囲を設定。 More...

void	setNotInFirst (bool bNotInFirst)
	先頭ページに透かしを配置するかしないかの設定。 More...

void	setNotInLast (bool bNotInLast)
	最終ページに透かしを配置するかしないかの設定。 More...

void	setCustomPageRange (String^ customPageRange)
	透かしを配置するページの範囲の指定を設定。 More...

void	setDisplayWaterMark (bool bDisplayWaterMark)
	PDF表示時に透かしを表示する指定を設定。 More...

void	setPrintWaterMark (bool bPrintWaterMark)
	PDF印刷時に透かしを印刷する指定を設定。 More...

void	setOpacity (float opacity)
	透かしの不透明度を設定。 More...

void	setTiling (bool bTiling)
	透かしをタイリングして配置するかどうかを設定。 More...

Protected Attributes
PdfTk::PtlParamWaterMark *	m_native

Detailed Description

透かしの設定で使うパラメータクラスです。
すべての透かしパラメータクラスのベースクラスです。

Member Enumeration Documentation

◆ ALIGN

enum PdfTkNet::PtlParamWaterMark::ALIGN

strong

透かしの配置

Enumerator
ALIGN_TOP_LEFT	左上
ALIGN_TOP	中央上
ALIGN_TOP_RIGHT	右上
ALIGN_LEFT	中央左
ALIGN_CENTER	中央(デフォルト値)
ALIGN_RIGHT	中央右
ALIGN_BOTTOM_LEFT	左下
ALIGN_BOTTOM	中央下
ALIGN_BOTTOM_RIGHT	右下

◆ PAGE_RANGE

enum PdfTkNet::PtlParamWaterMark::PAGE_RANGE

strong

透かしを入れるページの範囲

Enumerator
PAGE_RANGE_ALL	全ページ
PAGE_RANGE_FIRST	先頭ページのみ
PAGE_RANGE_LAST	最終ページのみ
PAGE_RANGE_ODD	奇数ページ
PAGE_RANGE_EVEN	偶数ページ
PAGE_RANGE_CUSTOM	指定ページ(setCustomPageRangeでページ範囲を設定)

◆ TYPE_WATERMARK

enum PdfTkNet::PtlParamWaterMark::TYPE_WATERMARK

strong

透かしのタイプ

Enumerator
TYPE_COLOR	色
TYPE_TEXT	テキスト
TYPE_PDF	PDF
TYPE_IMAGE	画像

◆ ZORDER

enum PdfTkNet::PtlParamWaterMark::ZORDER

strong

透かしのZオーダー

Enumerator
ZORDER_FRONT	前面(デフォルト値)
ZORDER_BACK	背面

Constructor & Destructor Documentation

◆ PtlParamWaterMark() [1/2]

PdfTkNet::PtlParamWaterMark::PtlParamWaterMark ( TYPE_WATERMARK type )

コンストラクタ

Exceptions

PtlException

◆ PtlParamWaterMark() [2/2]

PdfTkNet::PtlParamWaterMark::PtlParamWaterMark ( PtlParamWaterMark^ obj )

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

◆ getType()

TYPE_WATERMARK PdfTkNet::PtlParamWaterMark::getType ( )

透かしタイプ取得。

Returns: 透かしタイプ

Exceptions

PtlException

◆ operator=()

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

コピーオペレータ alias copy

Parameters

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

◆ setAlign()

void PdfTkNet::PtlParamWaterMark::setAlign ( ALIGN align )

透かしの配置を設定。

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

Parameters

align 透かしの配置指定。ALIGN_XXXのいずれか。

Exceptions

PtlException

◆ setCustomPageRange()

void PdfTkNet::PtlParamWaterMark::setCustomPageRange ( String^ customPageRange )

透かしを配置するページの範囲の指定を設定。

Parameters

customPageRange 透かしを配置するページの範囲の指定。
setPageRangeでPAGE_RANGE_CUSTOMを設定した場合のみ有効。
例 "0,2-4" と指定すると、1ページと3から5ページに透かしが入ります。

Exceptions

PtlException

◆ setDisplayWaterMark()

void PdfTkNet::PtlParamWaterMark::setDisplayWaterMark ( bool bDisplayWaterMark )

PDF表示時に透かしを表示する指定を設定。

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

Parameters

bDisplayWaterMark PDF表示時に透かしを表示する指定。trueなら表示する。

Exceptions

PtlException

◆ setMargin()

void PdfTkNet::PtlParamWaterMark::setMargin	(	float	topMM,
		float	leftMM,
		float	bottomMM,
		float	rightMM
	)

透かしを配置するときの余白を設定。

透かしの配置位置の設定はsetRectとsetMarginがあります。
setRectも併せて設定するとsetRectで設定した矩形とsetMarginによって出来る矩形の交差する矩形が最終的に配置される矩形となります。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。

Parameters

topMM	透かしを配置するときの上側の余白(単位はmm)。
leftMM	透かしを配置するときの左側の余白(単位はmm)。
bottomMM	透かしを配置するときの下側の余白(単位はmm)。
rightMM	透かしを配置するときの右側の余白(単位はmm)。

Exceptions

PtlException

◆ setName()

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

透かしの名前を設定。

Parameters

name	透かしの名前。英数字で設定してください。

Exceptions

PtlException

◆ setNotInFirst()

void PdfTkNet::PtlParamWaterMark::setNotInFirst ( bool bNotInFirst )

先頭ページに透かしを配置するかしないかの設定。

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

Parameters

bNotInFirst 先頭ページに透かしを配置しない設定。trueなら配置しない。

Exceptions

PtlException

◆ setNotInLast()

void PdfTkNet::PtlParamWaterMark::setNotInLast ( bool bNotInLast )

最終ページに透かしを配置するかしないかの設定。

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

Parameters

bNotInLast 最終ページに透かしを配置しない設定。trueなら配置しない。

Exceptions

PtlException

◆ setOpacity()

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

透かしの不透明度を設定。

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

Parameters

opacity 0.0 〜 1.0。0.0が透明、1.0が不透明。

Exceptions

PtlException

◆ setPageRange()

void PdfTkNet::PtlParamWaterMark::setPageRange ( PAGE_RANGE pageRange )

透かしを入れるページの範囲を設定。

PAGE_RANGE_CUSTOMを設定した場合は、setCustomPageRangeでページ範囲を設定します。

Parameters

pageRange 透かしを入れるページの範囲。PAGE_RANGE_XXXのいずれか。

Exceptions

PtlException

◆ setPrintWaterMark()

void PdfTkNet::PtlParamWaterMark::setPrintWaterMark ( bool bPrintWaterMark )

PDF印刷時に透かしを印刷する指定を設定。

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

Parameters

bPrintWaterMark PDF印刷時に透かしを印刷する指定。trueなら印刷する。

Exceptions

PtlException

◆ setRect()

void PdfTkNet::PtlParamWaterMark::setRect ( PtlRect^ rectMM )

透かしを配置する矩形を設定。

透かしの配置位置の設定はsetRectとsetMarginがあります。
setMarginも併せて設定するとsetRectで設定した矩形とsetMarginによって出来る矩形の交差する矩形が配置される矩形となります。
表示矩形（ViewBox）上の座標値をmm単位で指定してください。

Parameters

rectMM 透かしを配置する矩形。

Exceptions

PtlException

◆ setTiling()

void PdfTkNet::PtlParamWaterMark::setTiling ( bool bTiling )

透かしをタイリングして配置するかどうかを設定。

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

Parameters

bTiling 透かしをタイリングして配置するかどうか。trueならタイリングして配置。

Exceptions

PtlException

◆ setZorder()

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

透かしのZオーダーを設定。

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

Parameters

zorder 透かしのZオーダー。ZORDER_XXXのいずれか。

Exceptions

PtlException

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ALIGN

◆ PAGE_RANGE

◆ TYPE_WATERMARK

◆ ZORDER

Constructor & Destructor Documentation

◆ PtlParamWaterMark() [1/2]

◆ PtlParamWaterMark() [2/2]

Member Function Documentation

◆ getType()

◆ operator=()

◆ setAlign()

◆ setCustomPageRange()

◆ setDisplayWaterMark()

◆ setMargin()

◆ setName()

◆ setNotInFirst()

◆ setNotInLast()

◆ setOpacity()

◆ setPageRange()

◆ setPrintWaterMark()

◆ setRect()

◆ setTiling()

◆ setZorder()