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

#include <NetParamRestriction.h>

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

公開型

enum class  PAGE_RANGE {
  PAGE_RANGE_ALL = 0 , PAGE_RANGE_FIRST = 1 , PAGE_RANGE_LAST = 2 , PAGE_RANGE_ODD = 3 ,
  PAGE_RANGE_EVEN = 4 , PAGE_RANGE_CUSTOM = 5
}

公開メンバ関数

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

限定公開変数類

PdfTk::PtlParamRestriction * m_native

詳解

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

列挙型メンバ詳解

◆ PAGE_RANGE

enum class PdfTkNet::PtlParamRestriction::PAGE_RANGE
strong

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

列挙値
PAGE_RANGE_ALL 

全ページ

PAGE_RANGE_FIRST 

先頭ページのみ

PAGE_RANGE_LAST 

最終ページのみ

PAGE_RANGE_ODD 

奇数ページ

PAGE_RANGE_EVEN 

偶数ページ

PAGE_RANGE_CUSTOM 

指定ページ(setCustomPageRangeでページ範囲を設定)

構築子と解体子

◆ PtlParamRestriction() [1/2]

PdfTkNet::PtlParamRestriction::PtlParamRestriction ( )

コンストラクタ

例外
PtlException

◆ PtlParamRestriction() [2/2]

PdfTkNet::PtlParamRestriction::PtlParamRestriction ( PtlParamRestriction^ obj)

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

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

◆ ~PtlParamRestriction()

PdfTkNet::PtlParamRestriction::~PtlParamRestriction ( )

デストラクタ

◆ !PtlParamRestriction()

PdfTkNet::PtlParamRestriction::!PtlParamRestriction ( )

ファイナライザ。

メソッド詳解

◆ appendValidURL()

void PdfTkNet::PtlParamRestriction::appendValidURL ( String^ url)

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

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

引数
url閲覧可能とするURL。
例外
PtlException

◆ getNative()

PdfTk::PtlParamRestriction * PdfTkNet::PtlParamRestriction::getNative ( )

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setCustomPageRange()

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

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

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

引数
customPageRange閲覧制限を行うページの範囲の指定。
例外
PtlException

◆ setEnableParamWatermark()

void PdfTkNet::PtlParamRestriction::setEnableParamWatermark ( bool enableParam)

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

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

引数
enableParamウォーターマークに設定したパラメータを有効にするか。
例外
PtlException

◆ setPageRange()

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

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

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

引数
pageRange透かしを入れるページの範囲。PAGE_RANGE_XXXのいずれか。
例外
PtlException

◆ setValidTermEnd()

void PdfTkNet::PtlParamRestriction::setValidTermEnd ( PtlDate^ end)

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

引数
end終了日。
例外
PtlException

◆ setValidTermStart()

void PdfTkNet::PtlParamRestriction::setValidTermStart ( PtlDate^ start)

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

引数
start開始日。
例外
PtlException

◆ setWatermark()

void PdfTkNet::PtlParamRestriction::setWatermark ( PtlParamWaterMark^ paramWM)

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

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

引数
paramWMウォーターマーク。
例外
PtlException

メンバ詳解

◆ m_native

PdfTk::PtlParamRestriction* PdfTkNet::PtlParamRestriction::m_native
protected