PdfTkNet::PtlParamRestriction Class Reference

PDFの閲覧制限を表現したクラスです。 More...

#include <NetParamRestriction.h>

Inheritance diagram for PdfTkNet::PtlParamRestriction:

Collaboration diagram for PdfTkNet::PtlParamRestriction:

Public Types
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::PtlParamRestriction *	getNative ()
	PtlParamRestriction ()
	コンストラクタ More...
	PtlParamRestriction (PtlParamRestriction^ obj)
	コピーコンストラクタ alias copy More...
	‾PtlParamRestriction ()
	デストラクタ
	!PtlParamRestriction ()
	ファイナライザ。
PtlParamRestriction	operator= (PtlParamRestriction^ obj)
	コピーオペレータ alias copy More...
void	appendValidURL (String^ url)
	閲覧可能とするURLを追加。 More...
void	setValidTermStart (PtlDate^ start)
	閲覧可能とする期間の開始日を設定。 More...
void	setValidTermEnd (PtlDate^ end)
	閲覧可能とする期間の終了日を設定。 More...
void	setWatermark (PtlParamWaterMark^ paramWM)
	閲覧不可時に表示するウォーターマークを設定。 More...
void	setEnableParamWatermark (bool enableParam)
	閲覧不可時に表示するウォーターマークのパラメータを有効にするかの設定。 More...
void	setPageRange (PAGE_RANGE pageRange)
	閲覧制限を行うページの範囲を設定。 More...
void	setCustomPageRange (String^ customPageRange)
	閲覧制限を行うページの範囲の指定を設定。 More...

Protected Attributes
PdfTk::PtlParamRestriction *	m_native

Detailed Description

PDFの閲覧制限を表現したクラスです。

Member Enumeration Documentation

PAGE_RANGE

enum PdfTkNet::PtlParamRestriction::PAGE_RANGE

strong

閲覧制限を行うページの範囲

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

Constructor & Destructor Documentation

PtlParamRestriction() [1/2]

PdfTkNet::PtlParamRestriction::PtlParamRestriction

(

)

コンストラクタ

Exceptions

PtlException

PtlParamRestriction() [2/2]

PdfTkNet::PtlParamRestriction::PtlParamRestriction

(

PtlParamRestriction^

obj

)

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

Parameters

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

Exceptions

PtlException

Member Function Documentation

appendValidURL()

void PdfTkNet::PtlParamRestriction::appendValidURL

(

String^

url

)

閲覧可能とするURLを追加。

複数URLを閲覧可能としたい場合はこの関数を複数呼ぶことで実現できます。

Parameters

url	閲覧可能とするURL。

Exceptions

PtlException

operator=()

PtlParamRestriction PdfTkNet::PtlParamRestriction::operator=

(

PtlParamRestriction^

obj

)

コピーオペレータ alias copy

Parameters

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

setCustomPageRange()

void PdfTkNet::PtlParamRestriction::setCustomPageRange

(

String^

customPageRange

)

閲覧制限を行うページの範囲の指定を設定。

Parameters

customPageRange

閲覧制限を行うページの範囲の指定。 setPageRangeでPAGE_RANGE_CUSTOMを設定した場合のみ有効。 例 "0,2-4" と指定すると、1ページと3から5ページに閲覧制限が入ります。ページは0オリジンです。

Exceptions

PtlException

setEnableParamWatermark()

void PdfTkNet::PtlParamRestriction::setEnableParamWatermark

(

bool

enableParam

)

閲覧不可時に表示するウォーターマークのパラメータを有効にするかの設定。

有効にすると、PtlParamWaterMarkに設定したページ範囲、setDisplayWaterMark/setPrintWaterMarkが使用されます。
但し、閲覧制限を設定するページにのみウォーターマークは設定されます。

Parameters

enableParam

ウォーターマークに設定したパラメータを有効にするか。

Exceptions

PtlException

setPageRange()

void PdfTkNet::PtlParamRestriction::setPageRange

(

PAGE_RANGE

pageRange

)

閲覧制限を行うページの範囲を設定。

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

Parameters

pageRange

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

Exceptions

PtlException

setValidTermEnd()

void PdfTkNet::PtlParamRestriction::setValidTermEnd

(

PtlDate^

end

)

閲覧可能とする期間の終了日を設定。

Parameters

end

終了日。

Exceptions

PtlException

setValidTermStart()

void PdfTkNet::PtlParamRestriction::setValidTermStart

(

PtlDate^

start

)

閲覧可能とする期間の開始日を設定。

Parameters

start

開始日。

Exceptions

PtlException

setWatermark()

void PdfTkNet::PtlParamRestriction::setWatermark

(

PtlParamWaterMark^

paramWM

)

閲覧不可時に表示するウォーターマークを設定。

設定しない場合は閲覧不可時に何も表示されません。

Parameters

paramWM

ウォーターマーク。

Exceptions

PtlException