6. PDFThumbnailCtrl

6.4.1. プロパティ

6.4.2. メソッド

6.4.3. イベント

6.5.1. IsOpenプロパティ

bool IsOpen { get; }

解説：

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

6.5.2. IsModifiedプロパティ

bool IsModified { get; }

解説：

最後に保存してからPDFが変更されているかどうかを調べます。変更されていればTrueになります。

6.5.3. IsLockedByOwnerPasswordプロパティ

bool IsLockedByOwnerPassword { get; }

解説：

PDFにオーナパスワードセキュリティによるロックがかかっている状態かどうかを調べます。ロックされていればTrueになります。

6.5.4. HasFocusプロパティ

bool HasFocus { get; }

解説：

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

6.5.5. CurrentPageNumberプロパティ

int32 CurrentPageNumber { get; }

解説：

現在のページ番号です。

6.5.6. PageCountプロパティ

int32 PageCount { get; }

解説：

PDFの総ページ数です。PDFがオープンされていない場合は0になります。

6.5.7. SelectedPageCountプロパティ

int32 SelectedPageCount { get; }

解説：

選択中のページ数が返ります。

6.5.8. CtrlStyleプロパティ

int32 CtrlStyle { get; set; }

設定値：

解説：

コントロールのスタイルを上記ビットの組み合わせで設定します。デフォルトは0です。

6.5.9. BackgroundColorプロパティ

System.Drawing.Color BackgroundColor { get; set; }

解説：

背景色（ページの外の領域）です。

変更する場合はOpenDocument前に設定してください。OpenDocument後に設定しても反映されません。

6.5.10. TextColorプロパティ

System.Drawing.Color TextColor { get; set; }

解説：

ページ番号のテキスト色です。

変更する場合はOpenDocument前に設定してください。OpenDocument後に設定しても反映されません。

6.5.11. ThumbnailSizeプロパティ

int32 ThumbnailSize { get; set; }

解説：

表示するサムネイルのサイズです。単位はピクセルです。デフォルトは82です。

設定可能な値の範囲は、30～200です。変更する場合はOpenDocument前に設定してください。OpenDocument後に設定しても反映されません。

6.5.12. CanUndoプロパティ

bool CanUndo { get; }

解説：

Undoができるかどうか調べます。Undo可能であればTrueになります。

6.5.13. CanRedoプロパティ

bool CanRedo { get; }

解説：

Redoができるかどうか調べます。Redo可能であればTrueになります。

6.5.14. CanCutプロパティ

bool CanCut { get; }

解説：

Cutができるかどうか調べます。Cut可能であればTrueになります。

6.5.15. CanCopyプロパティ

bool CanCopy { get; }

解説：

Copyができるかどうか調べます。Copy可能であればTrueになります。

6.5.16. CanPasteプロパティ

bool CanPaste { get;}

解説：

Pasteができるかどうか調べます。Paste可能であればTrueになります。

6.5.17. CanDeleteプロパティ

bool CanDelete { get; }

解説：

Deleteができるかどうか調べます。Delete可能であればTrueになります。

6.5.18. CanModifyPageプロパティ

bool CanModifyPage { get; }

解説：

ページの編集（追加、削除、変更）ができるかどうか調べます。ページ編集可能であればTrueになります。

6.5.19. HasUserPasswordプロパティ

bool HasUserPassword { get; }

解説：

PDFにユーザパスワードが設定されているか調べます。ユーザパスワードが設定されていればTrueになります。

通常はオープン時のPDFの状態を返しますが、UserPasswordプロパティに値をセットした場合、状態が変更されます。ドキュメントをオープンしていない場合は必ずFalseになります。

6.5.20. HasOwnerPasswordプロパティ

bool HasOwnerPassword { get; }

解説：

PDFにオーナパスワードが設定されているか調べます。オーナパスワードが設定されていればTrueになります。

通常はオープン時のPDFの状態を返しますが、OwnerPasswordプロパティに値をセットした場合、状態が変更されます。ドキュメントをオープンしていない場合は必ずFalseになります。

6.5.21. UserPasswordプロパティ

string UserPassword { get; }

解説：

ユーザパスワードです。オープン時にユーザパスワードを指定してPDFを開くとその値が入ります。空文字をセットするとパスワードを設定していないことになり、HasUserPasswordでFalseが返るようになります。

値のセットはIsLockedByOwnerPassword()がTrueの状態では失敗します。

6.5.22. OwnerPasswordプロパティ

string OwnerPassword { get; set; }

解説：

オーナパスワードです。オープン時にオーナパスワードを指定してPDFを開くとその値が入ります。空文字をセットするとパスワードを設定していないことになり、HasOwnerPasswordでFalseが返るようになります。

値のセットはIsLockedByOwnerPassword()がTrueの状態では失敗します。

6.5.23. SecurityPermissionFlagプロパティ

int32 SecurityPermissionFlag { get; set; }

解説：

PDFのセキュリティ許可フラグです。

次のビットの組み合わせとなります。

値のセットはIsLockedByOwnerPasswordがTrueの状態では失敗します。

6.5.24. DocumentPathプロパティ

string DocumentPath { get; }

解説：

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

V5.0以降ではSaveDocumentでファイルパスを指定した後もオープンしたパスを返します。

6.5.25. SDKVersionプロパティ

string SDKVersion { get; }

解説：

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

6.5.26. SelectedPagesプロパティ

List<int> SelectedPages { get; }

解説：

選択中のページ番号のリストをSystem.Collections.Generic.Listとして返します。

6.5.27. OpenDocumentメソッド

int32 OpenDocument(string filePath, string password);

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

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

戻り値：

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

解説：

PDFファイルをオープンします。　閲覧パスワードがかかっているPDFの場合、デフォルトではパスワード入力ダイアログを表示します。それ以外のエラーが発生した場合はエラーダイアログを表示します。　

エラー時にダイアログを一切表示したくない場合はCtrlStyleプロパティで0x0004を指定してください。また、0x0008を指定するとパスワードがかかったPDFでもパスワード入力ダイアログが表示されません。この場合パスワード処理は自分でおこなう必要があります。エラーコードが843906の場合は、PDFにパスワードが設定されていて、与えられたpassWordが一致しないエラーです。パスワード入力を行い、再度OpenDocument()を呼び出してください。

6.5.28. SaveDocumentメソッド

int32 SaveDocument(string filePath);

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

戻り値：

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

解説：

PDFファイルを保存します。

エラー時にダイアログを一切表示したくない場合はCtrlStyleプロパティで0x0004を指定してください。

6.5.29. CloseDocumentメソッド

void CloseDocument ();

解説：

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

6.5.30. GetPDFDocumentHandleメソッド

IntPtr GetPDFDocumentHandle();

戻り値：

PDFDocumentのハンドル

解説：

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

6.5.31. AttachPDFDocumentメソッド

void AttachPDFDocument(IntPtr hPDFDocument);

hPDFDocument：PDFDocumentのハンドル

解説：

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

6.5.32. UnlockOwnerPasswordSecurityメソッド

bool UnlockOwnerPasswordSecurity(string password);

password：オーナパスワードを指定します。

戻り値：

セキュリティ解除に成功した場合、trueが返ります。

解説：

オーナパスワードを指定してセキュリティを解除します。

PDFにオーナパスワードがかかっている場合、オープン時にオーナパスワードを入力してPDFを開くか、この関数でセキュリティを解除しない限り、ページの回転、オブジェクトの追加、削除、変更といった編集機能は一切動作しません。

6.5.33. GotoPageメソッド

bool GotoPage (int32 pageNo);

pageNo：表示するページ

戻り値：

True 成功（ページが切り替わった場合）

解説：

指定したページを表示します。

6.5.34. GetPageRotationメソッド

int32 GetPageRotation (int32 pageNo);

pageNo：ページ番号

戻り値：

回転角度

解説：

指定したページの回転角度を取得します。

6.5.35. RotatePagesメソッド

void RotatePages(int32 rotation);

rotation：回転角度。90/180/270のいずれかを指定

解説：

選択中のページを回転します。回転は90度単位です。

6.5.36. InsertNewPagesメソッド

void InsertNewPages(int32 pageCount, int32 rotation, int32 pageWidth, int32 pageHeight, int32 destIndex,);

pageCount：挿入するページ数

rotation：回転角度　90/180/270のいずれかを指定

pageWidth/pageHeight：ページサイズ(twip)

destIndex：挿入先。0からはじまるインデックス。

解説：

白紙ページを挿入します。

6.5.37. MovePagesメソッド

void MovePages(int32 destIndex );

destIndex：移動先。0からはじまるインデックス

解説：

選択中のページを指定した位置へ移動します。

6.5.38. CopyPagesメソッド

void CopyPages(int32 destIndex);

destIndex：コピー先。0からはじまるインデックス

解説：

選択中のページを指定した位置へコピーします。

6.5.39. ResetViewメソッド

void ResetView();

解説：

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

6.5.40. Undoメソッド

void Undo();

解説：

最後の編集操作を取り消します。最高５０回まで可能です。CanUndo()でアンドゥー可能かどうか調べることができます。

6.5.41. Redoメソッド

void Redo();

解説：

Undoを取り消します。最高５０回まで可能です。CanRedo()でリドゥー可能かどうか調べることができます。

6.5.42. Cutメソッド

void Cut();

解説：

選択されたページを切り取ってクリップボードに保存します。CanCut()でカット（切り取り）が可能かどうか調べることができます。

6.5.43. Copyメソッド

void Copy();

解説：

選択されたページをコピーしてクリップボードに保存します。CanCopy()でコピー可能かどうか調べることができます

6.5.44. Pasteメソッド

void Paste();

解説：

クリップボードの内容（CutやCopyしたページ）を貼り付けます。CanPaste()で貼り付け可能かどうか調べることができます。

6.5.45. Deleteメソッド

void Delete();

解説：

選択されたページを削除します。CanDelete()で削除可能かどうか調べることができます。

6.5.46. SelectPageメソッド

void SelectPage(int32 pageNo, bool bSelect);

pageNo：ページ番号

bSelect：選択する場合はTrue、選択解除する場合はFalseを指定します。

解説：

指定したページを選択、または選択解除します。ページ遷移はおこないません。

6.5.47. SelectAllメソッド

void SelectAll(bool bSelect);

bSelect：選択する場合はTrue、選択解除する場合はFalseを指定します。

解説：

全ページを選択、または選択解除します。

6.5.48. DocumentOpenedイベント

void DocumentOpened(IntPtr hPDFDocument);

hPDFDocument：PDFDocumentのハンドル

解説：

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

6.5.49. PageTurnedイベント

void PageTurned(int32 pageNo);

pageNo：ページ番号

解説：

現在ページが変更になったときに発行されます。

6.5.50. DragDropFilesイベント

int32 DragDropFiles(BSTR\[\] files);

files：ドロップされたファイル名

戻り値：デフォルトの動作（files[0]を開く）を実行する場合は0以外を返します。　0を返すとデフォルト動作をおこないません。

解説：

コントロールにファイルがドラッグ＆ドロップされたときに発行されます。

6.5.51. ContextMenuCイベント

int32 ContextMenuC(System.Drawing.Point point);

戻り値：コントロールのデフォルト処理を実行する場合は1を返します。　0を返すとデフォルト処理をおこないません。

point：カーソル位置のクライアント座標が入ります。

解説：

マウス右クリックされるかコンテキストメニューボタンが押されたときに発行されます。