PDFTool.NET  6.0
Public Types | Public Member Functions | Protected Attributes | List of all members
PdfTkNet::PtlPDFDocument Class Reference

PDF文書を表現したクラスです。 More...

#include <NetPDFDocument.h>

Inheritance diagram for PdfTkNet::PtlPDFDocument:
Inheritance graph
[legend]
Collaboration diagram for PdfTkNet::PtlPDFDocument:
Collaboration graph
[legend]

Public Types

enum  SAVE_OPTION { SAVE_OPTION::SAVE_RECONSTRUCT = 0, SAVE_OPTION::SAVE_LINEARIZE = 1, SAVE_OPTION::SAVE_INCREMENTAL_UPDATE = 2 }
 保存オプション More...
 

Public Member Functions

PdfTk::PtlPDFDocument * getNative ()
 
 PtlPDFDocument ()
 コンストラクタ More...
 
 PtlPDFDocument (PtlPDFDocument^ obj)
 コピーコンストラクタ alias copy More...
 
 ‾PtlPDFDocument ()
 デストラクタ
 
 !PtlPDFDocument ()
 ファイナライザ。
 
PtlPDFDocument operator= (PtlPDFDocument^ obj)
 コピーオペレータ alias copy More...
 
void setPassword (String^ password)
 パスワードを設定。 More...
 
void load (PtlParamInput^ inParam)
 PDF文書をロード。 More...
 
void setSaveOption (SAVE_OPTION option)
 保存時のオプションを設定。 More...
 
void save (PtlParamOutput^ outParam)
 PDF文書を保存。 More...
 
bool isEncrypted ()
 暗号化されているかどうかを取得。 More...
 
bool isEncryptedOnlyEmbeddedFiles ()
 添付ファイルのみ暗号化されているかどうかを取得。 More...
 
bool hasOwnerAuthority ()
 オーナー権限があるかどうかを取得。 More...
 
PtlEncrypt getEncrypt ()
 暗号化情報を取得。 More...
 
void setEncrypt (PtlEncrypt^ encrypt)
 暗号化情報を設定。 More...
 
void removeEncrypt ()
 暗号化情報を削除。 More...
 
bool isSignatured ()
 署名付きかどうかを取得。 More...
 
bool isPDFA ()
 PDF/Aかどうかを取得。 More...
 
bool isPDFX ()
 PDF/Xかどうかを取得。 More...
 
PtlDocProperty getDocProperty ()
 文書プロパティを取得。 More...
 
int getPageCount ()
 ページ数を取得。 More...
 
PtlPages getPages ()
 ページコンテナを取得。 More...
 
bool hasOutlines ()
 アウトラインを持っているかどうかを取得。 More...
 
PtlOutline getRootOutline ()
 ルートアウトラインを取得。 More...
 
bool hasEmbeddedFiles ()
 添付ファイルを持っているかどうかを取得。 More...
 
PtlEmbeddedFiles getEmbeddedFiles ()
 添付ファイルコンテナを取得。 More...
 
void appendWaterMark (PtlParamWaterMark^ waterMark)
 透かしを設定。 More...
 
void removeWaterMark (String^ name)
 透かしの削除。 More...
 
void setRestriction (PtlParamRestriction^ restriction)
 閲覧制限を設定。 More...
 
bool optimize (PtlParamOptimize^ paramOptimize)
 最適化。 More...
 
bool embedFonts ()
 フォント埋め込み。 More...
 
void importAnnotsFromFDF (PtlParamInput^ inParam)
 FDF文書のインポート。 More...
 
void importAnnotsFromPDF (PtlParamInput^ inParam)
 マークアップ注釈のPDFからのインポート。 More...
 
void exportAnnotsToFDF (PtlParamOutput^ outParam)
 FDF文書のエクスポート。 More...
 
int searchTextAndDoProcess (PtlParamSearchText^ paramSearchText)
 テキスト検索して後処理。 More...
 
PtlSearchTextResults searchText (PtlParamSearchText^ paramSearchText)
 テキスト検索。 More...
 

Protected Attributes

PdfTk::PtlPDFDocument * m_native
 

Detailed Description

PDF文書を表現したクラスです。

Member Enumeration Documentation

◆ SAVE_OPTION

enum PdfTkNet::PtlPDFDocument::SAVE_OPTION
strong

保存オプション

Enumerator
SAVE_RECONSTRUCT 

再構築(デフォルト)

SAVE_LINEARIZE 

リニアライズ

SAVE_INCREMENTAL_UPDATE 

増分更新

Constructor & Destructor Documentation

◆ PtlPDFDocument() [1/2]

PdfTkNet::PtlPDFDocument::PtlPDFDocument ( )

コンストラクタ

Exceptions
PtlException

◆ PtlPDFDocument() [2/2]

PdfTkNet::PtlPDFDocument::PtlPDFDocument ( PtlPDFDocument^  obj)

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

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

Member Function Documentation

◆ appendWaterMark()

void PdfTkNet::PtlPDFDocument::appendWaterMark ( PtlParamWaterMark^  waterMark)

透かしを設定。

Parameters
waterMark透かしのパラメータ
Exceptions
PtlException

◆ embedFonts()

bool PdfTkNet::PtlPDFDocument::embedFonts ( )

フォント埋め込み。

埋め込まれていないフォントを埋め込みフォントにします。
※ 埋め込みに使われるフォントがインストールされていないと埋め込み対象であっても埋め込みされません。

Returns
true: フォント埋め込みされた、false: フォント埋め込みされない。
Exceptions
PtlException

◆ exportAnnotsToFDF()

void PdfTkNet::PtlPDFDocument::exportAnnotsToFDF ( PtlParamOutput^  outParam)

FDF文書のエクスポート。

マークアップ注釈をFDFに書き出します。

Parameters
outParamOutputParam
Exceptions
PtlException

◆ getDocProperty()

PtlDocProperty PdfTkNet::PtlPDFDocument::getDocProperty ( )

文書プロパティを取得。

Returns
文書プロパティ。
Exceptions
PtlException

◆ getEmbeddedFiles()

PtlEmbeddedFiles PdfTkNet::PtlPDFDocument::getEmbeddedFiles ( )

添付ファイルコンテナを取得。

Returns
添付ファイルコンテナ。
Exceptions
PtlException

◆ getEncrypt()

PtlEncrypt PdfTkNet::PtlPDFDocument::getEncrypt ( )

暗号化情報を取得。

Returns
暗号化情報。PtlEncryptStandardType1若しくはPtlEncryptStandardType2。
Exceptions
PtlException

◆ getPageCount()

int PdfTkNet::PtlPDFDocument::getPageCount ( )

ページ数を取得。

Returns
ページ数

◆ getPages()

PtlPages PdfTkNet::PtlPDFDocument::getPages ( )

ページコンテナを取得。

Returns
ページコンテナ。
Exceptions
PtlException

◆ getRootOutline()

PtlOutline PdfTkNet::PtlPDFDocument::getRootOutline ( )

ルートアウトラインを取得。

ルートは仮想のしおりで一番上位にあり、他のしおりをたどっていく基点となります。
アウトラインを持っていなくてもルートは取得されます。

Returns
ルートアウトライン。
Exceptions
PtlException

◆ hasEmbeddedFiles()

bool PdfTkNet::PtlPDFDocument::hasEmbeddedFiles ( )

添付ファイルを持っているかどうかを取得。

Returns
true: 持っている、false: 持っていない。
Exceptions
PtlException

◆ hasOutlines()

bool PdfTkNet::PtlPDFDocument::hasOutlines ( )

アウトラインを持っているかどうかを取得。

Returns
true: 持っている、false: 持っていない。
Exceptions
PtlException

◆ hasOwnerAuthority()

bool PdfTkNet::PtlPDFDocument::hasOwnerAuthority ( )

オーナー権限があるかどうかを取得。

暗号化されていない場合、hasOwnerAuthorityはfalseです。

暗号化されている場合は下記の通りです。

ユーザーパスワード/オーナーパスワードの両方が設定されている場合、
ユーザーパスワードでloadするとhasOwnerAuthorityはfalseです。
オーナーパスワードでloadするとhasOwnerAuthorityはtrueです。

ユーザーパスワードのみが設定されている場合、
ユーザーパスワードでloadするとhasOwnerAuthorityはtrueです。

オーナーパスワードのみが設定されている場合、
オーナーパスワードでloadするとhasOwnerAuthorityはtrueです。
パスワードの設定なしでloadするとhasOwnerAuthorityはfalseです。

Returns
true: 暗号化されている、false: 暗号化されていない。
Exceptions
PtlException

◆ importAnnotsFromFDF()

void PdfTkNet::PtlPDFDocument::importAnnotsFromFDF ( PtlParamInput^  inParam)

FDF文書のインポート。

マークアップ注釈をFDFから取り込みます。

Parameters
inParamInputParam
Exceptions
PtlException

◆ importAnnotsFromPDF()

void PdfTkNet::PtlPDFDocument::importAnnotsFromPDF ( PtlParamInput^  inParam)

マークアップ注釈のPDFからのインポート。

マークアップ注釈をPDFから取り込みます。

Parameters
inParamInputParam
Exceptions
PtlException

◆ isEncrypted()

bool PdfTkNet::PtlPDFDocument::isEncrypted ( )

暗号化されているかどうかを取得。

Returns
true: 暗号化されている、false: 暗号化されていない。
Exceptions
PtlException

◆ isEncryptedOnlyEmbeddedFiles()

bool PdfTkNet::PtlPDFDocument::isEncryptedOnlyEmbeddedFiles ( )

添付ファイルのみ暗号化されているかどうかを取得。

Returns
true: 暗号化されている、false: 暗号化されていない。
Exceptions
PtlException

◆ isPDFA()

bool PdfTkNet::PtlPDFDocument::isPDFA ( )

PDF/Aかどうかを取得。

Returns
true: PDF/A、false: PDF/Aでない。
Exceptions
PtlException

◆ isPDFX()

bool PdfTkNet::PtlPDFDocument::isPDFX ( )

PDF/Xかどうかを取得。

Returns
true: PDF/X、false: PDF/Xでない。
Exceptions
PtlException

◆ isSignatured()

bool PdfTkNet::PtlPDFDocument::isSignatured ( )

署名付きかどうかを取得。

Returns
true: 署名付き、false: 署名付きでない。
Exceptions
PtlException

◆ load()

void PdfTkNet::PtlPDFDocument::load ( PtlParamInput^  inParam)

PDF文書をロード。

Parameters
inParamInputParam
Exceptions
PtlException

◆ operator=()

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

コピーオペレータ alias copy

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

◆ optimize()

bool PdfTkNet::PtlPDFDocument::optimize ( PtlParamOptimize^  paramOptimize)

最適化。

Parameters
paramOptimize最適化のパラメータ
Returns
true: 最適化された、false: 最適化されない。
Exceptions
PtlException

◆ removeEncrypt()

void PdfTkNet::PtlPDFDocument::removeEncrypt ( )

暗号化情報を削除。

Exceptions
PtlException

◆ removeWaterMark()

void PdfTkNet::PtlPDFDocument::removeWaterMark ( String^  name)

透かしの削除。

Parameters
name削除する透かしの名前
Exceptions
PtlException

◆ save()

void PdfTkNet::PtlPDFDocument::save ( PtlParamOutput^  outParam)

PDF文書を保存。

Parameters
outParamOutputParam
Exceptions
PtlException

◆ searchText()

PtlSearchTextResults PdfTkNet::PtlPDFDocument::searchText ( PtlParamSearchText^  paramSearchText)

テキスト検索。

検索できるのはユニコードとして文字を取得できるもののみです。
またテキストに見えても実際は画像であったりパスであったりする場合もこれらは検索対象となりません。

Parameters
paramSearchTextテキスト検索のパラメータ
Returns
PtlSearchTextResults。
Exceptions
PtlException

◆ searchTextAndDoProcess()

int PdfTkNet::PtlPDFDocument::searchTextAndDoProcess ( PtlParamSearchText^  paramSearchText)

テキスト検索して後処理。

検索できるのはユニコードとして文字を取得できるもののみです。
またテキストに見えても実際は画像であったりパスであったりする場合もこれらは検索対象となりません。
パラメータとしてPtlParamSearchTextAndHighlightが使用された場合は、検索された文字列に対してHighlight注釈処理が行われます。
パラメータとしてPtlParamSearchTextAndSetMaskが使用された場合は、検索された文字列に対してMask処理が行われます。
※ 注意事項
Mask処理は検索されたものは無条件に処理されます。
定型文書でない一般文書などでは想定外のテキストがMask処理されてしまうことがありますのでこの関数の使用には
十分注意して下さい。
(例) "元日", "本日"のようにテキストが取得された場合、"日本"で検索するとヒットして"日"と"本"は削除されていまいます。

Parameters
paramSearchTextテキスト検索のパラメータ(PtlParamSearchTextAndHighlight若しくはPtlParamSearchTextAndSetMask)
Returns
検索されたテキストの数。
Exceptions
PtlException

◆ setEncrypt()

void PdfTkNet::PtlPDFDocument::setEncrypt ( PtlEncrypt^  encrypt)

暗号化情報を設定。

※ 制限事項
元のPDFの暗号化が256ビットAES暗号化でユーザーパスワードとオーナーパスワードが設定されている場合に制限事項があります。
256ビットAES暗号化以外の暗号化に変更しユーザーパスワードを元のままとしたい場合はPtlEncryptStandardのsetUserPasswordで
元のユーザーパスワードを設定する必要があります。

Parameters
encrypt暗号化情報
Exceptions
PtlException

◆ setPassword()

void PdfTkNet::PtlPDFDocument::setPassword ( String^  password)

パスワードを設定。

Parameters
passwordパスワード。
Exceptions
PtlException

◆ setRestriction()

void PdfTkNet::PtlPDFDocument::setRestriction ( PtlParamRestriction^  restriction)

閲覧制限を設定。

注意：
閲覧制限の内容を解析されないようオーナーパスワードの設定は必ず行ってください。

Parameters
restriction閲覧制限のパラメータ
Exceptions
PtlException

◆ setSaveOption()

void PdfTkNet::PtlPDFDocument::setSaveOption ( SAVE_OPTION  option)

保存時のオプションを設定。

オプションを設定しないと再構築して保存されます。

Parameters
option保存オプション。SAVE_XXXのいずれかの値。
Exceptions
PtlException
Generated by   doxygen 1.8.18