8. PDFLayerCtrl

8.1. 概要

PDFのレイヤーを表示/操作するコントロールです。.NET版のみの提供となります。

PDFLayerCtrlはフォームに貼り付けるだけで簡単に利用することができます。

レイヤーコントロールには以下の機能があります。

・レイヤー名の確認

・レイヤーの階層の確認

・チェックボックスでレイヤーの表示・非表示

・右クリックメニューから以下の操作

  レイヤーの表示を初期状態にリセット

  すべてを展開

  すべてを閉じる

8.2. アプリケーションが実装すべき項目

コントロールには多くの機能がデフォルトで実装されており、ファイルを開くだけで簡単に利用できるようになっています。詳しくは付属のサンプルプログラムを参考にしてください。

機能概要

説明

コントロール間の同期

デフォルトではなにもしません。

同期をとるにはDocumentOpenedイベントでAttachPDFDocumentしてください。同期をとるとファイルをオープンした場合に、同期中の全コントロールに反映されます。

8.3. 制限事項

以下の制限事項があります。

  扱うIntentは「View」のみです。「Desig」は扱いません。

  Image / Alternate Image / Annotation の OCキー

  Usage辞書には一部をのぞき対応していません。印刷時は表示と同じ状態になります。

  複数のOCConfig辞書の切り替え。既定のOCConfig(「D」)を参照します。

8.4. API一覧

8.4.1. プロパティ

プロパティ名

.NET/.NET Framework

概要

IsOpen

PDFがオープンされているか調べます。

HasFocus

コントロールがフォーカスを持っているかどうか調べます。

DocumentPath

オープンしているPDFのPathを取得します。

SDKVersion

SDKバージョン番号を取得します。

8.4.2. メソッド

メソッド名

.NET/.NET Framework

概要

OpenDocument

PDFをオープンします。

CloseDocument

PDFをクローズします。

GetPDFDocumentHandle

PDFDocumentのハンドルを取得します。

AttachPDFDocument

PDFDocumentのハンドルをコントロールに関連付けます。

ResetView

ビューをクリアして作り直します。

8.4.3. イベント

イベント名

.NET/.NET Framework

概要

DocumentOpened

ドキュメントがオープンされたときに呼ばれます。

8.5. APIリファレンス

8.5.1. IsOpenプロパティ

型: bool (.NET) (getのみ)

解説: PDFがオープンされているかどうか調べます。オープンされていればTrueになります。

8.5.2. HasFocusプロパティ

型: bool (.NET)   (getのみ)

解説: コントロールがフォーカスを持っているかどうか調べます。フォーカスをもっていればTrueになります。.NETのControl.Focusedプロパティは正しく機能しませんのでこのプロパティを使用してください。

8.5.3. DocumentPathプロパティ

型: string (.NET) (getのみ)

解説:オープン中PDFファイルのPathを取得します。

8.5.4. SDKVersionプロパティ

型: string (.NET) (getのみ)

解説:PDFViewerSDKのバージョン番号です。

8.5.5. OpenDocumentメソッド

int32 OpenDocument(string filePath, string password); (.NET)

filePath:PDFファイルのパスを指定します。

password:パスワード パスワード無しの場合は空文字列を指定してください。

戻り値:成功した場合0が返ります。失敗した場合はエラーコードが返ります。

解説: PDFファイルをオープンします。 閲覧パスワードがかかっているPDFの場合、デフォルトではパスワード入力ダイアログを表示します。それ以外のエラーが発生した場合はエラーダイアログを表示します。 エラーコードが843906の場合は、PDFにパスワードが設定されていて、与えられたpassWordが一致しないエラーです。パスワード入力を行い、再度OpenDocument()を呼び出してください。

8.5.6. CloseDocumentメソッド

void CloseDocument (); (.NET)

解説:PDFファイルをクローズします。

8.5.7. GetPDFDocumentHandleメソッド

IntPtr GetPDFDocumentHandle(); (.NET)

戻り値: PDFDocumentのハンドル

解説:コントロールに関連付けられているPDFDocumentのハンドルを取得します。ハンドルはOpenDocumentでファイルを開いた後に取得してください。

8.5.8. AttachPDFDocumentメソッド

void AttachPDFDocument(IntPtr hPDFDocument); (.NET)

hPDFDocument:PDFDocumentのハンドル

解説:指定したPDFDocumentのハンドルをコントロールに関連付けます。一つのPDFDocumentを、複数のコントロールと使い回したいときに使用します。同じPDFDocumentを持つコントロールはファイルクローズ時などを同期します。

8.5.9. ResetViewメソッド

void ResetView(); (.NET)

解説:ビューをクリアして作り直します。

8.5.10. DocumentOpenedイベント

void DocumentOpened(IntPtr hPDFDocument); (.NET)

hPDFDocument:PDFDocumentのハンドル

解説:ドキュメントがオープンされたときに発行されます。