5. PDFPageViewCtrl

5.1. 概要

PDFのページを表示するコントロールです。様々なページレイアウト、ビューモード、選択ツール、検索、回転、印刷、画像ファイル変換といった機能を利用することができます。

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

5.2. チュートリアル .NET Framework版

以下ではVisualStudio C#での初歩的な使用方法を説明します。.NET Framework版を利用するには事前に.NET Framework 4.6.2以降のインストールが必要です。 詳細は「4.3動作に必要なモジュール、手続き等」をご覧ください。以下は32bit版での説明です。

  1. VisualStudioを起動する前に環境変数”Path”にbin\Win32 フォルダのパスを追加してください。こうしないとフォームデザイナを開いたときエラーになることがあります。(ビルド、実行には影響しませんので開発環境のみおこなってください。64bit版コントロールでの開発については、「64bit版コントロールについて」を参照ください。)
  2. メニューから[ファイル]-[新規作成]-[プロジェクト]を選び、「新しいプロジェクト」ダイアログからVisualC#の「Windowsフォーム アプリケーション」を選択して適当なプロジェクト名(ここでは” AvsDotNetGuiSample”とします)を入力したら[OK]を押してください。
  3. メニューから[ツール]-[ツールボックス アイテムの選択]を選び、右下の「参照...」ボタンを押してbin\Win32ディレクトリにあるAvsDotNetGuiCtl.dllを選択してください。「PDFPageViewControl」にチェックをつけて[OK]を押します。
  4. ツールボックスペインに「PDFPageViewControl」のアイコンが追加されていますのでそれを選びフォーム上でドラッグ&ドロップして貼り付けてください。その他、OpenFileDialogコントロール、Buttonコントロールを貼り付けてください。
  5. 貼り付けたButtonコントロールをダブルクリックします。コードが表示されますので次のように処理を書きます。

private void button1_Click(object sender, EventArgs e)

{

if (openFileDialog1.ShowDialog() == DialogResult.OK)

pdfPageViewCtrl1.OpenDocument(openFileDialog1.FileName, "");

}

  1. メニューから[プロジェクト]-[参照の追加]を選び[参照]タブを選択し、bin\Win32ディレクトリにあるAvsDotNetGuiCtl.dllを選択してください。[OK]を押すとプロジェクトの参照設定にAvsDotNetGuiCtlが追加されます。
  2. 実行します。ボタンを押すとファイルダイアログが表示されPDFファイルを指定すると表示することができます。

5.3. チュートリアル ActiveX版

以下ではVisualStudio C#での初歩的な使用方法を説明します。 ActiveX版を利用するには事前にocxのレジストリ登録が必要です。 詳細は「4.3動作に必要なモジュール、手続き等」をご覧ください。以下は32bit版での説明です。

  1. メニューから[ファイル]-[新規作成]-[プロジェクト]を選び、「新しいプロジェクト」ダイアログからVisualC#の「Windowsフォーム アプリケーション」を選択して適当なプロジェクト名(ここでは”AvsActiveXCtlSample”とします)を入力したら[OK]を押してください。
  2. メニューから[ツール]-[ツールボックス アイテムの選択]を選び、「COM コンポーネント」から「PDFPageView Control」にチェックをつけて[OK]を押します。
  3. ツールボックスペインに「PDFPageView Control」のアイコンが追加されていますのでそれを選びフォーム上でドラッグ&ドロップして貼り付けてください。その他、OpenFileDialogコントロール、Buttonコントロールを貼り付けてください。
  4. 貼り付けたButtonコントロールをダブルクリックします。コードが表示されますので次のように処理を書きます。

private void button1_Click(object sender, EventArgs e)

{

if (openFileDialog1.ShowDialog() == DialogResult.OK)

axPDFPageView1.OpenDocument(openFileDialog1.FileName, "");

      }

実行します。ボタンを押すとファイルダイアログが表示されPDFファイルを指定すると表示することができます。

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

コントロールには多くの機能がデフォルトで実装されており、ほとんどの機能はボタンを用意してメソッドを呼び出すだけで、もしくはファイルを開いただけで、簡単に利用できるようになっています。ここでは各機能についてアプリケーション側が実装すべきこと、関知できることについて簡単に説明します。詳しくは付属のサンプルプログラムを参考にしてください。

機能概要

説明

ファイルのドラッグ&ドロップ

デフォルトではドロップされたファイルの一つを開きます。

異なる動作をおこないたい場合はDragDropFilesイベントをハンドリングしてください。

コントロール間の同期(編集)

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

同期をとるにはDocumentOpenedイベントでAttachPDFDocumentしてください。同期をとるとページの入れ替えや回転といった編集処理をおこなったとき、同期中の全コントロールに反映されます。

コントロール間の同期(ページ遷移)

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

同期をとるにはPageTurnedイベントでGotoPageしてください。

右クリックメニュー

デフォルトで用意されています。

ContextMenuCイベントをハンドリングすることで独自の右クリックメニューを使用することも可能です。

ドキュメント情報の編集(セキュリティ解除)

ドキュメント情報編集ダイアログが用意されています。

ShowDocumentPropertyDialogを呼び出してください。独自のダイアログを作成して使用することも可能ですし、ModifyObjectsで直接編集も可能です。

注釈の処理

注釈を処理するためのGUIインタフェースはデフォルトで用意されています。

プログラムから注釈を操作したい場合は、CreateObject/GetObjectInfo/DeleteObject/ModifyObjectsなどを使用してください。SetDefaultObjectPropertyでデフォルトプロパティを変更することも可能です。

ショートカットキー[Delete]/[BackSpace]/[Esc]/[Ctrl]/[Shift]/方向キーがデフォルトでハンドリングされています。意図的な別処理への置き換えでなければアプリケーション側ではハンドリングしないでください。

アンドゥー、リドゥー

デフォルトで実装されています。

独自のアンドゥー処理を差し込むことはできません。

ショートカットキー[Ctrl]+[Z]/[Y]がデフォルトでハンドリングされていますので意図的に別の処理に置き換えたいのでなければアプリケーション側ではハンドリングしないでください。

スクロール

スクロールバークリック、ハンドツール、キー押下などによるスクロール処理がデフォルトで実装されています。ScrollToPositionで任意の位置へスクロールすることが可能です。

ショートカットキー[Home]/[End]/[PageUp]/[PageDown]/方向キーがデフォルトでハンドリングされています。意図的な別処理への置き換えでなければアプリケーション側ではハンドリングしないでください。

検索

デフォルトで実装されています。

検索ダイアログは用意(ShowSearchDialog)されておりますが、独自のダイアログを作成して使用することも可能です。

カット、コピー&ペースト、すべて選択

デフォルトで実装されています。

ショートカットキー[Ctrl]+[X]/[C]/[V]/[A]がデフォルトでハンドリングされています。意図的な別処理への置き換えでなければアプリケーション側ではハンドリングしないでください。

印刷

デフォルトで実装されています。

印刷ダイアログは用意されておりますが、独自のダイアログを作成して使用することも可能です。

アクション実行

デフォルトで実装されています。

DoActionイベントを実装することでアクション実行時のメッセージを変更したり非表示にすることが可能です。

5.5. API一覧

※一部のAPIは.NET/.NET Framework のみでActiveXからは利用できません。

5.5.1. プロパティ

プロパティ名

.NET/

.NET Framework

ActiveX

概要

IsOpen

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

IsModified

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

IsLockedByOwnerPassword

オーナパスワードでロックされている状態かどうか調べます。

IsSearched

検索状態か調べます。

IsSearchedAll

全検索状態か調べます。

HasFocus

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

PageCount

ページ数を取得します。

ShowCoverPageDuringTwoUp

見開きレイアウトの時、1ページ目を右側に表示します。

PageShadow

ページに影をつけます。

BackgroundColor

背景色を設定します。

TextSelectedColor

テキスト選択色を設定します。

SearchedAllColor

全検索で見つかったキーワードの背景色を設定します。

HiligtTextColor

テキストのハイライト色を設定します。

PageLayout

ページレイアウトを設定します。

ViewMode

ビューモードを設定します。

SelectMode

選択モードを設定します。

Direction

見開きレイアウトの綴じ方を取得/設定します。

CtrlStyle

スタイルを設定します。

HasUserPassword

ユーザパスワードが設定されているかどうかを調べます。

HasOwnerPassword

オーナパスワードが設定されているかどうかを調べます。

UserPassword

ユーザパスワードを取得/設定します。

OwnerPassword

オーナパスワードを取得/設定します。

SecurityPermissonFlag

PDFのセキュリティフラグを取得/設定します。

ZoomRatio

ズーム倍率を設定します。

ZoomRatioLimit

最大ズーム倍率を取得します。

CurrentPageNumber

現在のページ番号を表示します。

CanUndo

Undoが可能か調べます。

CanRedo

Redoが可能か調べます。

CanCut

Cutが可能な状態か調べます。

CanCopy

Copyが可能な状態か調べます。

CanPaste

Pasteが可能な状態か調べます。

CanDelete

Deleteが可能な状態か調べます。

CanModifyPage

ページ編集が可能な状態か調べます。

CanModifyAnnotation

注釈の追加、削除、変更が可能な状態か調べます。

CanModifyFontStyle

フォントスタイル変更が可能な状態か調べます。

CanUndoView

UndoViewが可能な状態か調べます。

CanRedoView

RedoViewが可能な状態か調べます。

CanPrint

印刷が可能な状態か調べます。

SelectedObjectCount

選択されているオブジェクトの数を取得します。

PdfVersion

PDFのバージョンを取得します。

CreationDate

PDFの作成日時を取得します。

ModifyDate

PDFの更新日時を取得します。

Title

PDFのタイトルを取得/設定します。

Author

PDFの作成者を取得/設定します。

Subject

PDFのサブタイトルを取得/設定します。

Keywords

PDFのキーワードを取得/設定します。

Creator

PDFを作成したアプリケーション名を取得します。

Producer

PDF変換をおこなったツール名を取得します。

DocumentPath

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

SDKVersion

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

SearchStartPage

検索開始ページを取得/設定します。

LoadPageCount

読み込みページ数を設定します。

SelectedTextString

選択中のテキストを取得します。

ViewCoord

View座標であるかを取得/設定します。

IncludeArtifact

テキスト装飾を含めるかを取得/設定します。

5.5.2. メソッド

メソッド名

.NET/.NET Framework

ActiveX

概要

OpenDocument

PDFをオープンします。

SaveDocument

PDFを保存します。

CloseDocument

PDFをクローズします。

PrintDocument

印刷をおこないます。

GetPDFDocumentHandle

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

AttachPDFDocument

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

UnlockOwnerPasswordSecurity

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

GetPageWidth

ページの幅を取得します。

GetPageHeight

ページの高さを取得します。

GetNextZoomRatio

ズーム倍率の次の値を取得します。

GotoPage

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

GotoFirstPage

先頭ページを表示します。

GotoLastPage

最終ページを表示します。

GotoPreviousPage

前ページを表示します。

GotoNextPage

次ページを表示します。

GetPageRotation

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

RotatePages

ページを回転します。

ResetView

ビューを作り直します。

Undo

最後の編集操作を取り消します。

Redo

Undoを取り消します。

Cut

切り取ってクリップボードに保存します。

Copy

コピーしてクリップボードに保存します。

Paste

クリップボードの内容を貼り付けます。

Delete

削除をおこないます。

SelectAll

ページテキストの全選択をおこないます。

ShowDocumentPropertyDialog

ドキュメントプロパティダイアログを表示します。

ShowFontStyleDialog

フォントスタイルダイアログを表示します。

ShowObjectPropertyDialog

オブジェクトプロパティダイアログを表示します。

UndoView

前の表示に戻します。

RedoView

UndoViewを取り消します。

ShowSearchDialog

検索ダイアログを表示します。

Search

検索をおこないます。

SearchNext

次検索をおこないます。

SearchPrevious

前検索をおこないます。

ClearSelect

選択中のテキストをクリアします。

MakeBmpPage

指定したページをBMP画像に変換します。

MakeJpegPage

指定したページをJPEG画像に変換します。

MakePngPage

指定したページをPNG画像に変換します。

MakeTiffPage

指定したページをTIFF画像に変換します。

MakeEmfPage

指定したページをEMF画像に変換します。

MakeSvgPage

指定したページをSVG形式に変換します。

GetDefaultObjectProperty

デフォルトのオブジェクトプロパティを取得します。

SetDefaultObjectProperty

デフォルトのオブジェクトプロパティを設定します。

GetCursorPosition

現在カーソル位置の座標を取得します。

ScrollToPosition

指定した位置へスクロールします。

ClientToLogical

クライアント座標を論理座標に変換します。

SetSelectModeEx

カスタム選択モードを作成するときに使用します。

CreateObject

オブジェクト(注釈)を作成します。

GetObjectCount

指定したページにあるオブジェクト(注釈)数を取得します。

GetObjectInfo

オブジェクトを取得します。

DeleteObjects

オブジェクトを削除します。

ModifyObjects

オブジェクトを編集します。

HitTest

指定した位置になにがあるか調べます。

GetNextObjectId

次のオブジェクトのIDを取得します。

SetHilightText

指定範囲のテキストをハイライト表示します。

ClearHilightText

ハイライト表示をすべて解除します。

GetTextInfoInRect

指定範囲のテキスト情報を取得します。

ClientToLogicalRect

矩形をクライアント座標から論理座標に変換します。

SetCtrlCursor

コントロールのカーソルを指定します。

SetSmoothing

スムージングを設定します。

SelectTextString

指定した範囲の文字列を選択します。

SetFocus

コントロールにHフォーカスを設定します。

GetSelectedTexfInfo

選択中のテキストのテキスト情報を取得します。

5.5.3. イベント

イベント名

.NET/.NET Framework

ActiveX

概要

DocumentOpened

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

PageTurned

ページ移動が起きたときに呼ばれます。

Zoom

拡大・縮小が起きたときに呼ばれます。

DragDropFiles

ファイルがドラッグ&ドロップされたときに呼ばれます。

ObjectAdded

オブジェクトが追加された時に呼ばれます。

DoAction

アクション実行時に呼ばれます。

DefaultObjectPropertyChanged

デフォルトのオブジェクトプロパティが変更されたときに呼ばれます。

MouseDownC

コントロール上でマウスボタンが押されたときに呼ばれます。

MouseUpC

コントロール上でマウスボタンが離されたときに呼ばれます。

DoubleClickC

コントロール上でマウスボタンをダブルクリックしたときに呼ばれます。

MouseMoveC

コントロール上でマウスを動かしたときに呼ばれます。

ContextMenuC

コントロール上でマウスボタンが右クリックされたときやコンテキストメニューボタンが押されたときに呼ばれます。

KeyDownC

コントロール上でキーが押されたときに呼ばれます。

KeyUpC

コントロール上でキーが離されたときに呼ばれます。

ObjectDeleted

注釈が削除されたときに呼ばれます。

ObjectResized

注釈をリサイズや端点を移動したときに呼ばれます。

ObjectMoved

注釈を移動したときに呼ばれます。

EditBoxShowed

テキスト入力ボックスが表示や非表示されたときに呼ばれます。

EditBoxTextEdited

テキスト入力ボックスに文字が入力されたときに呼ばれます。

5.6. APIリファレンス

5.6.1. IsOpenプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (getのみ)

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

5.6.2. IsModifiedプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (getのみ)

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

5.6.3. IsLockedByOwnerPasswordプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (getのみ)

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

5.6.4. IsSearchedプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (getのみ)

解説: 検索状態かどうかを調べます。検索状態であればTrueになります。

5.6.5. IsSearchedAllプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (getのみ)

解説: 全検索状態かどうかを調べます。全検索状態であればTrueになります。

5.6.6. HasFocusプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (getのみ)

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

5.6.7. PageCountプロパティ

型: int32 (.NET) / long (ActiveX) (getのみ)

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

5.6.8. ShowCoverPageDuringTwoUpプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (get / set)

解説:見開きページレイアウトで1ページ目を独立して表示するかどうかの指定です。

デフォルトはFalseです。

5.6.9. PageShadowプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (get / set)

解説:ページの影を描画するかどうかの指定です。描画する場合はTrueを指定します。デフォルトはTrueです。

5.6.10. BackgroundColorプロパティ

型: System.Drawing.Color (.NET) / OLE_COLOR (ActiveX) (get / set)

解説:背景色(ページの外の領域)です。

5.6.11. TextSelectedColorプロパティ

型: System.Drawing.Color (.NET) / OLE_COLOR (ActiveX) (get / set)

解説:テキストの選択色です。

5.6.12. SearchedAllColorプロパティ

型: System.Drawing.Color (.NET) / OLE_COLOR (ActiveX) (get / set)

解説:全検索で見つかったキーワードの背景色です。

5.6.13. HilightTextColorプロパティ

型: System.Drawing.Color (.NET) / OLE_COLOR (ActiveX) (get / set)

解説:SetHilightTextメソッドで指定したテキストハイライトの背景色です。

5.6.14. PageLayoutプロパティ

型:AvsPageLayout (enum)  (get / set)

設定値:

AvsPageLayout (enum値)

説明

APL_SINGLE

0

単ページ表示

APL_CONTINUOUS

1

連続ページ表示

APL_TWOUP

2

見開き表示

APL_TWOUP_CONTINUOUS

3

連続見開き表示

APL_TWOUP_COVER

4

見開き表示(表紙)

APL_TWOUP_COVER_CONTINUOUS

5

連続見開き表示(表紙)

解説:ページレイアウトです。 連続表示(1と3)はビューモードの「ページサイズに合わせる」と排他の関係にあります。よって連続表示を指定すると「ページサイズに合わせる」ビューモードは「指定倍率」に変更されます。

デフォルトは「連続ページ表示」です。

5.6.15. ViewModeプロパティ

型:AvsViewMode (enum) (get / set)

設定値:

AvsViewMode

説明

AVM_CUSTOM

0

指定倍率

AVM_FITPAGE

1

ページサイズに合わせる

AVM_FITWIDTH

2

幅に合わせる

AVM_FITHEIGHT

3

高さに合わせる

解説:ビューモードです。「ページサイズに合わせる」はページレイアウトの連続表示と排他の関係になります。よって「ページサイズに合わせる」を指定すると連続表示ページレイアウトは単表示に変更されます。

デフォルトは「幅に合わせる」です。

5.6.16. SelectModeプロパティ

型:AvsSelectMode (enum)  (get / set)

設定値:

AvsSelectMode

説明

ASM_NORMAL

0

通常モード

オブジェクトの矩形選択が可能です。

ASM_TXTSEL

1

テキスト選択モード

ドラッグすることによってテキストを選択することができます。

ALTを押しながらドラッグすると矩形選択が可能です。

ASM_HAND

2

ハンドモード

ビューをドラッグすることによってスクロールすることができます。

ASM_MQZOOM

3

マーキーズームモード

ページの一部分をドラッグで範囲指定するとその範囲がビュー全体に表示されるように拡大されます。また、単にクリックするとクリックした位置を中心に拡大します。

Ctrlを押した状態でおこなうと縮小になります。

ASM_OBJEDIT

4

オブジェクト編集モード

リンク注釈を編集することが可能です。オブジェクトの矩形選択が可能です。

ASM_CUSTOM1 – ASM_CUSTOM5

51-55

カスタムモード

独自の選択モードを作成することが可能です。

ASM_INS_STICKYNOTE

100

ノート注釈を挿入するモードです。

ASM_INS_LINK

101

リンク挿入するモードです。

ASM_INS_FILEATTACHMENT

102

ファイル添付注釈を挿入するモードです。

ASM_INS_TEXTBOX

103

テキストボックス注釈を挿入するモードです。

ASM_INS_CALLOUT

104

引出線注釈を挿入するモードです。

ASM_INS_TYPEWRITER

105

タイプライター注釈を挿入するモードです。

ASM_INS_LINE

106

線注釈を挿入するモードです。

ASM_INS_ARROW

107

矢印線注釈を挿入するモードです。

ASM_INS_RECTANGLE

108

長方形注釈を挿入するモードです。

ASM_INS_OVAL

109

楕円注釈を挿入するモードです。

ASM_INS_POLYGON

110

多角形注釈を挿入するモードです。

ASM_INS_POLYLINE

111

折れ線注釈を挿入するモードです。

ASM_INS_HIGHLIGHT

112

ハイライト注釈を挿入するモードです。

ASM_INS_UNDERLINE

113

下線注釈を挿入するモードです。

ASM_INS_CROSSOUT

114

取消線注釈を挿入するモードです。

ASM_INS_SQUIGGLY

115

波線注釈を挿入するモードです。

解説:選択モードです。デフォルトは「テキスト選択モード」です。

5.6.17. Directionプロパティ

型:AvsDirectionType (enum)  (get / set)

設定値:

AvsDirectionType (enum値)

説明

ADT_L2R

0

左綴じ(Left to Right)

ADT_R2L

1

右綴じ(Right to Left)

解説:ページレイアウトが見開き表示時の綴じ方です。

PDFファイルに指定がある場合はその設定に従って表示されます。指定がない場合のデフォルトは「左綴じ」です。表示上の設定は変更できますが、PDFファイルには反映されません。

5.6.18. CtrlStyleプロパティ

型: int32 (.NET) / long (ActiveX)  (get / set)

設定値:

AvsCtrlStyle

説明

AGCS_HIDEOBJECTS

0x00000001

注釈等のオブジェクトを表示しません

AGCS_PREVIEWMODE

0x00000002

プレビューモード(編集不可、テキスト選択不可、注釈選択不可、ポップアップ注釈非表示)に設定します

AGCS_HIDEERRDLG

0x00000004

エラーダイアログを表示しません

AGCS_HIDEPASSWORDDLG

0x00000008

パスワード入力ダイアログを表示しません

AGCS_READONLY

0x00000010

読込専用モード(編集不可)に設定します

AGCS_IGNOREOPENPAGELAYOUT

0x00000020

PDFに設定されたオープンページレイアウトを無視します。

AGCS_IGNOREOPENACTION

0x00000040

PDFに設定されたオープンアクションを無視します。

AGCS_HIDEANNOTATIONS

0x00000080

注釈を非表示にします。

AGCS_NOTURNATSINGLELAYOUT

0x00000100

単ページ表示のとき、キーまたはマウスホイールでのスクロールによるページ遷移を抑制します。

AGCS_DONTONKILLFOCUSEBWND

0x00000200

テキスト入力がフォーカスを失ったときに再度フォーカスを当てることをしません。

AGCS_DONTOFFSAHIGHLIGHTS

0x00000400

ページ上をクリックしたとき、全検索結果のハイライトが消えないようにします。

AGCS_DISABLECURSOR

0x00000800

コントロールのマウスカーソルの制御を抑止します。

※注釈ポップアップの入力欄、テキストボックス・引き出し線・タイプライターのテキスト入力、PDFPageViewCtrl で表示するWindows標準部品は抑止されません。

AGCS_DISABLEDRAGCOPY

0x00100000

CTRL+Dragによる注釈コピーを禁止します。

AGCS_DISABLEALTTXTSEL

0x00200000

ALT+ドラッグによる範囲指定テキスト選択を禁止します。

解説:コントロールのスタイルを上記ビットの組み合わせで設定します。デフォルトは0です。0x0011を指定(読込専用、オブジェクト非表示)するとV2.5相当になります。

(V5以降)AGCS_ALIGNVERTICALCENTERは廃止されました。

5.6.19. HasUserPasswordプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (getのみ)

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

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

5.6.20. HasOwnerPasswordプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX) (getのみ)

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

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

5.6.21. UserPasswordプロパティ

型: string (.NET) / BSTR(ActiveX)   (get / set)

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

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

5.6.22. OwnerPasswordプロパティ

型: string (.NET) / BSTR(ActiveX)   (get / set)

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

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

5.6.23. SecurityPermissionFlagプロパティ

型: int32 (.NET) / long (ActiveX)   (get / set)

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

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

AvsSecurityPermissionFlag

説明

ASPF_ENABLE_PRINT

0x0004

印刷許可

ASPF_ENABLE_CHANGEDOC

0x0008

ドキュメント内容の変更許可

ASPF_ENABLE_COPYCONTENT

0x0010

内容のコピー許可

ASPF_ENABLE_MODIFYANNOT

0x0020

注釈の編集許可

ASPF_ENABLE_FILLFORM

0x0100

フォームフィールドの入力許可

ASPF_ENABLE_ACCESSIBILITY

0x0200

アクセシビリティの許可

ASPF_ENABLE_ASSEMBLEDOC

0x0400

ページの挿入、削除、回転許可

ASPF_ENABLE_PRINTHIGHLEVEL

0x0804

高解像度の印刷許可

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

5.6.24. ZoomRatioプロパティ

型: float32 (.NET) / single (ActiveX)   (get / set)

解説:現在のズーム倍率です。値をセットするとViewModeが自動的に0になります。

5.6.25. ZoomRatioLimitプロパティ

型: float32 (.NET) / single (ActiveX)   (get のみ)

解説:最大ズーム倍率を取得します。

5.6.26. CurrentPageNumberプロパティ

型: int32 (.NET) / long (ActiveX)   (get のみ)

解説:現在のページ番号です。

5.6.27. CanUndoプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:Undoができるかどうか調べます。Undo可能ならばTrueになります。

5.6.28. CanRedoプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:Redoができるかどうか調べます。Redo可能ならばTrueになります。

5.6.29. CanCutプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:Cutができるかどうか調べます。Cut可能ならばTrueになります。

5.6.30. CanCopyプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:Copyができるかどうか調べます。Copy可能ならばTrueになります。

本文テキストを選択している状態でもPDFにコピー不可のセキュリティがかかっていた場合、falseが返ります。

5.6.31. CanPasteプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:Pasteができるかどうか調べます。Paste可能ならばTrueになります。

5.6.32. CanDeleteプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:Deleteができるかどうか調べます。Delete可能ならばTrueになります。

5.6.33. CanModifyPageプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:ページ編集(回転)ができるかどうか調べます。ページ編集可能ならばTrueになります。

5.6.34. CanModifyAnnotationプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:注釈の編集(追加、削除、変更)ができるかどうか調べます。注釈編集可能ならばTrueになります。

5.6.35. CanModifyFontStyleプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:フォントスタイル変更ができるかどうか調べます。フォントスタイル変更可能ならばTrueになります。

5.6.36. CanUndoViewプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:UndoViewができるかどうか調べます。UndoView可能ならばTrueになります。

5.6.37. CanRedoViewプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:RedoViewができるかどうか調べます。RedoView可能ならばTrueになります。

5.6.38. CanPrintプロパティ

型: bool (.NET) / VARIANT_BOOL (ActiveX)   (get のみ)

解説:PDFに印刷制御のセキュリティがかかっているか調べます。印刷可能ならばTrueになります。印刷不可の場合、印刷はおこなえません。

5.6.39. SelectedObjectCountプロパティ

型: int32 (.NET) / long (ActiveX)   (get のみ)

解説:選択されているオブジェクトの数を取得します。

5.6.40. PdfVersionプロパティ

型: string (.NET) / BSTR(ActiveX)   (get のみ)

解説:PDFのバージョンです。

5.6.41. CreationDateプロパティ

型: string (.NET) / BSTR(ActiveX)   (get のみ)

解説:PDFメタ情報の作成日時です。

5.6.42. ModifyDateプロパティ

型: string (.NET) / BSTR(ActiveX)   (get のみ)

解説:PDFメタ情報の更新日時です。

5.6.43. Titleプロパティ

型: string (.NET) / BSTR(ActiveX)   (get / set)

解説:PDFメタ情報のタイトルです。

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

5.6.44. Authorプロパティ

型: string (.NET) / BSTR(ActiveX)   (get / set)

解説:PDFメタ情報の作成者名です。

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

5.6.45. Subjectプロパティ

型: string (.NET) / BSTR(ActiveX)   (get / set)

解説:PDFメタ情報のサブタイトルです。

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

5.6.46. Keywordsプロパティ

型: string (.NET) / BSTR(ActiveX)   (get / set)

解説:PDFメタ情報のキーワードです。

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

(V5以降)複数行を指定する場合改行は”\r\n”を使用します。

5.6.47. Creatorプロパティ

型: string (.NET) / BSTR(ActiveX)   (get のみ)

解説:PDFメタ情報の作成したアプリケーション名です。

5.6.48. Producerプロパティ

型: string (.NET) / BSTR(ActiveX)   (get のみ)

解説:PDFメタ情報のPDF変換をおこなったツール名です。

5.6.49. DocumentPathプロパティ

型: string (.NET) / BSTR(ActiveX)   (get のみ)

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

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

5.6.50. SDKVersionプロパティ

型: string (.NET) / BSTR(ActiveX)   (get のみ)

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

5.6.51. SearchStartPage プロパティ

型: int32 (.NET) / long (ActiveX)   (get / set)

解説:検索範囲の開始ページ番号です。指定された開始ページと最終ページの範囲で検索が行われます。SearchメソッドやShowSearchDialogメソッドで検索を開始する前に指定してください。指定されたページ番号が最終ページ番号より大きい場合は最終ページが検索の開始ページになります。

5.6.52. LoadPageCount プロパティ

型: int32 (.NET) / long (ActiveX)   (get / set)

解説:メモリに読み込むページ数を設定します。設定のみで取得はできません。設定はオープンの前に行ってください。

 設定したページ数よりPDFのページ数が多いと、設定したページ数までメモリに持ちます。

初期値は 200 です。値の範囲は 2以上、上限はありません。

 ファイル名でオープンした場合はファイルがオープンしたままになります。オープンしたままにしたくない場合はストリームでオープンしてください。

※メモリを多く消費するPDFでメモリ不足が発生する場合に使用します。通常は指定する必要はありません。

5.6.53. SelectedTextString プロパティ

型: string (.NET) / BSTR (ActiveX)   (get のみ)

解説: 選択中のテキストを取得します。

 テキストが選択されていない場合は、空文字列になります。

5.6.54. ViewCoord プロパティ

型: bool(.NET)   (get / set)

解説: 現在の座標系がビュー座標系であるかを取得および設定します。

 Falseの場合、従来の論理座標系になります。

 ビュー座標系および論理座標系について「4.5座標系について」をご覧ください。

5.6.55. IncludeArtifactプロパティ

型: bool(.NET)   (get / set)

解説:APIやGUI操作の結果にテキスト装飾(タグ付きPDFにおいて”Artifact”とタグ付けされたテキスト)を含めるかを取得・設定します。Trueの場合含めます。

指定はPDFオープン前に行ってください。オープン後のプロパティの設定は反映されません。

対象となるメソッドや操作は以下になります。

 GetTextInfoInRect, GetSelectedTextInfo, HitTest, SelectedTextString

  テキスト選択、マウスカーソル (テキスト検索は対象外です)

5.6.56. OpenDocumentメソッド

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

long OpenDocument(BSTR filePath, BSTR password); (ActiveX)

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

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

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

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

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

5.6.57. SaveDocumentメソッド

int32 SaveDocument(string filePath); (.NET)

long SaveDocument(BSTR filePath); (ActiveX)

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

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

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

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

5.6.58. CloseDocumentメソッド

void CloseDocument (); (.NET)

void CloseDocument (); (ActiveX)

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

5.6.59. PrintDocumentメソッド

bool PrintDocument(bool bShowDialog, string printerName, int32 fromPageNo, int32 toPageNo,

int32 paperSize, int32 paperWidth, int32 paperHeight, AvsPrintOrientation orientation,

AvsPrintPageScaleMode pageScaleMode, bool isCenterAlign, int32 copies,

bool isCollate, string jobName, int32 exMode); (.NET)

VARIANT_BOOL PrintDocument(VARIANT_BOOL bShowDialog, BSTR printerName,

long fromPageNo, long toPageNo, long paperSize, long paperWidth, long paperHeight,

AvsPrintOrientation orientation, AvsPrintPageScaleMode pageScaleMode,

VARIANT_BOOL isCenterAlign, long copies, VARIANT_BOOL isCollate, BSTR jobName,

long exMode); (ActiveX)

bShowDialog:印刷ダイアログを表示する場合Trueを指定します。

printerName:プリンタ名

fromPageNo:開始ページ番号。 0を指定すると1ページになります。

toPageNo:終了ページ番号。 0を指定すると最終ページになります。

paperSize:用紙サイズ。 0~118,256を指定できます。0 を指定するとプリンタのデフォルト用紙サイズになります。※解説参照

paperWidth:用紙幅(0.1mm単位)。用紙サイズに256を指定した場合のみ有効です。

paperHeight:用紙の高さ(0.1mm単位)。用紙サイズに256を指定した場合のみ有効です。

orientation:用紙の向きを次の値で指定します。

AvsPrintOrientation

説明

APO_AUTO

0

ページサイズに合わせて向きを変えます

APO_PORTRAIT

1

APO_LANDSCAPE

2

pageScaleMode:ページの拡大・縮小を次の値で指定します。

AvsPrintPageScaleMode

説明

APS_NORMAL

0

なし

APS_FITPAPER

1

用紙に合わせて拡大、縮小する

APS_SHRINKTOPAPER

2

大きいページを縮小

isCenterAlign:用紙の中央に印刷する場合はTrueを指定します。

copies:印刷部数。

isCollate:部単位印刷をおこなう場合はTrueを指定します。

jobName:プリンタのジョブ名。省略するとファイルパス(ストリームの場合は”PDF File”)になります。

exMode:下記ビットの組み合わせで指定します。

AvsPrintExMode

説明

APM_DUPLEX

0x0001

両面印刷(APM_DUPHORZを指定すると短辺とじ、指定しないと長辺とじ

APM_DUPHORZ

0x0002

短辺とじ。APM_DUPLEXの指定が必要です。

戻り値:成功した場合trueが返ります。失敗した場合はfalseが返ります。

解説: 印刷をおこないます。ダイアログを表示する場合はbShowDialog以外の引数はダイアログのデフォルト値として使用されます。PDFに印刷不可のセキュリティがかかっている場合は印刷できません。

指定したプリンタに対する印刷権限がない場合はデフォルトプリンタに印刷されます。

paperSizeには次の値を設定できます。

0 プリンタのデフォルト用紙サイズ

1 Letter 8 1/2 x 11 in

2 Letter Small 8 1/2 x 11 in

3 Tabloid 11 x 17 in

4 Ledger 17 x 11 in

5 Legal 8 1/2 x 14 in

6 Statement 5 1/2 x 8 1/2 in

7 Executive 7 1/4 x 10 1/2 in

8 A3 297 x 420 mm

9 A4 210 x 297 mm

10 A4 Small 210 x 297 mm

11 A5 148 x 210 mm

12 B4 (JIS) 250 x 354

13 B5 (JIS) 182 x 257 mm

14 Folio 8 1/2 x 13 in

15 Quarto 215 x 275 mm

16 10x14 in

17 11x17 in

18 Note 8 1/2 x 11 in

19 Envelope #9 3 7/8 x 8 7/8

20 Envelope #10 4 1/8 x 9 1/2

21 Envelope #11 4 1/2 x 10 3/8

22 Envelope #12 4 \276 x 11

23 Envelope #14 5 x 11 1/2

24 C size sheet

25 D size sheet

26 E size sheet

27 Envelope DL 110 x 220mm

28 Envelope C5 162 x 229 mm

29 Envelope C3 324 x 458 mm

30 Envelope C4 229 x 324 mm

31 Envelope C6 114 x 162 mm

32 Envelope C65 114 x 229 mm

33 Envelope B4 250 x 353 mm

34 Envelope B5 176 x 250 mm

35 Envelope B6 176 x 125 mm

36 Envelope 110 x 230 mm

37 Envelope Monarch 3.875 x 7.5 in

38 6 3/4 Envelope 3 5/8 x 6 1/2 in

39 US Std Fanfold 14 7/8 x 11 in

40 German Std Fanfold 8 1/2 x 12 in

41 German Legal Fanfold 8 1/2 x 13 in

42 B4 (ISO) 250 x 353 mm

43 Japanese Postcard 100 x 148 mm

44 9 x 11 in

45 10 x 11 in

46 15 x 11 in

47 Envelope Invite 220 x 220 mm

48 RESERVED--DO NOT USE

49 RESERVED--DO NOT USE

50 Letter Extra 9 \275 x 12 in

51 Legal Extra 9 \275 x 15 in

52 Tabloid Extra 11.69 x 18 in

53 A4 Extra 9.27 x 12.69 in

54 Letter Transverse 8 \275 x 11 in

55 A4 Transverse 210 x 297 mm

56 Letter Extra Transverse 9\275 x 12 in

57 SuperA/SuperA/A4 227 x 356 mm

58 SuperB/SuperB/A3 305 x 487 mm

59 Letter Plus 8.5 x 12.69 in

60 A4 Plus 210 x 330 mm

61 A5 Transverse 148 x 210 mm

62 B5 (JIS) Transverse 182 x 257 mm

63 A3 Extra 322 x 445 mm

64 A5 Extra 174 x 235 mm

65 B5 (ISO) Extra 201 x 276 mm

66 A2 420 x 594 mm

67 A3 Transverse 297 x 420 mm

68 A3 Extra Transverse 322 x 445 mm

69 Japanese Double Postcard 200 x 148 mm

70 A6 105 x 148 mm

71 Japanese Envelope Kaku #2

72 Japanese Envelope Kaku #3

73 Japanese Envelope Chou #3

74 Japanese Envelope Chou #4

75 Letter Rotated 11 x 8 1/2 11 in

76 A3 Rotated 420 x 297 mm

77 A4 Rotated 297 x 210 mm

78 A5 Rotated 210 x 148 mm

79 B4 (JIS) Rotated 364 x 257 mm

80 B5 (JIS) Rotated 257 x 182 mm

81 Japanese Postcard Rotated 148 x 100 mm

82 Double Japanese Postcard Rotated 148 x 200 mm

83 A6 Rotated 148 x 105 mm

84 Japanese Envelope Kaku #2 Rotated

85 Japanese Envelope Kaku #3 Rotated

86 Japanese Envelope Chou #3 Rotated

87 Japanese Envelope Chou #4 Rotated

88 B6 (JIS) 128 x 182 mm

89 B6 (JIS) Rotated 182 x 128 mm

90 12 x 11 in

91 Japanese Envelope You #4

92 Japanese Envelope You #4 Rotated

93 PRC 16K 146 x 215 mm

94 PRC 32K 97 x 151 mm

95 PRC 32K(Big) 97 x 151 mm

96 PRC Envelope #1 102 x 165 mm

97 PRC Envelope #2 102 x 176 mm

98 PRC Envelope #3 125 x 176 mm

99 PRC Envelope #4 110 x 208 mm

100 PRC Envelope #5 110 x 220 mm

101 PRC Envelope #6 120 x 230 mm

102 PRC Envelope #7 160 x 230 mm

103 PRC Envelope #8 120 x 309 mm

104 PRC Envelope #9 229 x 324 mm

105 PRC Envelope #10 324 x 458 mm

106 PRC 16K Rotated

107 PRC 32K Rotated

108 PRC 32K(Big) Rotated

109 PRC Envelope #1 Rotated 165 x 102 mm

110 PRC Envelope #2 Rotated 176 x 102 mm

111 PRC Envelope #3 Rotated 176 x 125 mm

112 PRC Envelope #4 Rotated 208 x 110 mm

113 PRC Envelope #5 Rotated 220 x 110 mm

114 PRC Envelope #6 Rotated 230 x 120 mm

115 PRC Envelope #7 Rotated 230 x 160 mm

116 PRC Envelope #8 Rotated 309 x 120 mm

117 PRC Envelope #9 Rotated 324 x 229 mm

118 PRC Envelope #10 Rotated 458 x 324 mm

256 カスタムサイズ paperWidth/ paperHeightに任意の値を指定してください。

5.6.60. GetPDFDocumentHandleメソッド

IntPtr GetPDFDocumentHandle(); (.NET)

INT64 GetPDFDocumentHandle(); (ActiveX)

戻り値: PDFDocumentのハンドル

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

5.6.61. AttachPDFDocumentメソッド

void AttachPDFDocument(IntPtr hPDFDocument); (.NET)

void AttachPDFDocument(INT64 hPDFDocument); (ActiveX)

hPDFDocument:PDFDocumentのハンドル

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

5.6.62. UnlockOwnerPasswordSecurityメソッド

bool UnlockOwnerPasswordSecurity (string password); (.NET)

VARIANT_BOOL UnlockOwnerPasswordSecurity(BSTR password); (ActiveX)

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

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

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

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

5.6.63. GetPageWidthメソッド

int32 GetPageWidth(int32 pageNumber); (.NET)

long GetPageWidth(long pageNumber); (ActiveX)

pageNumber:ページ番号を指定します。

戻り値:指定したページの幅が返ります。(単位:twip)

解説: 指定したページの幅を取得します。単位はTwipです。PDFがオープンされていない場合は0になります。

5.6.64. GetPageHeightメソッド

int32 GetPageHeight(int32 pageNumber); (.NET)

long GetPageHeight(long pageNumber); (ActiveX)

pageNumber:ページ番号を指定します。

戻り値:指定したページの高さが返ります。(単位:twip)

解説: 指定したページの高さを取得します。単位はTwipです。PDFがオープンされていない場合は0になります。

5.6.65. GetNextZoomRatioメソッド

float32 GetNextZoomRatio (bool bZoomIn); (.NET)

single GetNextZoomRatio (VARIANT_BOOL bZoomIn); (ActiveX)

bZoomIn:拡大時の次ズーム倍率を取得する場合はTrue、縮小時はFalseを指定します。

戻り値:ズーム倍率

解説:ズーム倍率の次の刻み値を取得します。刻み値はコントロール内部で決められた値で下から順に10 → 25 → 50 → 75 → 100 → 125 → 150 → 200 → 400 → 800 → 1600 → 3200 → 6400 になります。

マーキーズームやマウスホイールによる拡大/縮小はこの刻み値に従っておこなわれます。

5.6.66. GotoPageメソッド

bool GotoPage (int32 pageNo,); (.NET)

VARIANT_BOOL GotoPage (long pageNo,); (ActiveX)

pageNo:表示するページ

戻り値:True 成功(ページが切り替わった場合)

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

5.6.67. GotoFirstPageメソッド

bool GotoFirstPage (); (.NET)

VARIANT_BOOL GotoFirstPage (); (ActiveX)

戻り値:true 成功(ページが切り替わった場合)

解説:先頭ページを表示します。

5.6.68. GotoLastPageメソッド

bool GotoLastPage (); (ActiveX)

VARIANT_BOOL GotoLastPage (); (ActiveX)

戻り値:True 成功(ページが切り替わった場合)

解説:最終ページを表示します。

5.6.69. GotoPreviousPageメソッド

bool GotoPreviousPage (); (ActiveX)

VARIANT_BOOL GotoPreviousPage (); (ActiveX)

戻り値:True 成功(ページが切り替わった場合)

解説:前ページを表示します。

5.6.70. GotoNextPageメソッド

bool GotoNextPage (); (.NET)

VARIANT_BOOL GotoNextPage (); (ActiveX)

戻り値:True 成功(ページが切り替わった場合)

解説:次ページを表示します。

5.6.71. GetPageRotationメソッド

int32 GetPageRotation (int32 pageNo); (.NET)

long GetPageRotation (long pageNo); (ActiveX)

pageNo:ページ番号

戻り値:回転角度

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

5.6.72. RotatePagesメソッド

void RotatePages (int32 pageNo, int32 rotation); (.NET)

void RotatePages (long pageNo, long rotation); (ActiveX)

pageNo:ページ番号 -1を指定すると全ページ

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

解説:指定したページを回転します。回転は90度単位です。

5.6.73. ResetViewメソッド

void ResetView(); (.NET)

void ResetView(); (ActiveX)

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

5.6.74. Undoメソッド

void Undo(); (.NET)

void Undo(); (ActiveX)

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

5.6.75. Redoメソッド

void Redo(); (.NET)

void Redo(); (ActiveX)

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

5.6.76. Cutメソッド

void Cut(); (.NET)

void Cut(); (ActiveX)

解説:選択されたオブジェクトやテキストボックスの文字列を切り取ってクリップボードに保存します。CanCut()で切り取り可能かどうか調べることができます。

5.6.77. Copyメソッド

void Copy(); (.NET)

void Copy(); (ActiveX)

解説:選択された本文テキスト、オブジェクト、テキストボックスの文字列をコピーしてクリップボードに保存します。CanCopy()でコピー可能かどうか調べることができます

5.6.78. Pasteメソッド

void Paste(); (.NET)

void Paste(); (ActiveX)

解説:クリップボードの内容(CutやCopyしたオブジェクト、文字列)を貼り付けます。CanPaste()で貼り付け可能かどうか調べることができます。

5.6.79. Deleteメソッド

void Delete(); (.NET)

void Delete(); (ActiveX)

解説:選択されたオブジェクトやテキストボックスの文字列を削除します。CanDelete()で削除可能かどうか調べることができます。

5.6.80. SelectAllメソッド

void SelectAll(bool bSelect); (.NET)

void SelectAll(VARIANT_BOOL bSelect); (ActiveX)

bSelect:Trueを指定すると選択、Falseを指定すると選択解除

解説:ページテキストをすべて選択、または選択解除します。

5.6.81. ShowDocumentPropertyDialogメソッド

void ShowDocumentPropertyDialog(); (.NET)

void ShowDocumentPropertyDialog(); (ActiveX)

解説:PDFドキュメントのプロパティ設定ダイアログを表示します。

5.6.82. ShowFontStyleDialogメソッド

void ShowFontStyleDialog(); (.NET)

void ShowFontStyleDialog(); (ActiveX)

解説:フリーテキスト注釈のフォントスタイル設定ダイアログを表示します。フリーテキスト注釈やその中のテキストを選択している状態で使用することができます。使用可能な状態かどうかはCanModifyFontStyleで調べることができます。

5.6.83. ShowObjectPropertyDialogメソッド

void ShowObjectPropertyDialog(); (.NET)

void ShowObjectPropertyDialog(); (ActiveX)

解説:選択されているオブジェクトのプロパティ設定ダイアログを表示します。オブジェクトが一つ以上選択されている必要があります。

5.6.84. UndoViewメソッド

void UndoView(); (.NET)

void UndoView(); (ActiveX)

解説:表示をアンドゥーして一つ前の表示に戻します。最高50回まで可能です。CanUndoViewプロパティでアンドゥー可能かどうか調べることができます。

5.6.85. RedoViewメソッド

void RedoView(); (.NET)

void RedoView(); (ActiveX)

解説:UndoViewを取り消します。最高50回可能です。CanRedoViewプロパティでリドゥー可能かどうか調べることができます。

5.6.86. ShowSearchDialogメソッド

void ShowSearchDialog(string searchStr, int32 bMatchCase, int32 bSearchAll); (.NET)

void ShowSearchDialog(BSTR searchStr, long bMatchCase, long bSearchAll); (ActiveX)

searchStr:検索文字列。NULLを指定すると選択中の文字列がある場合はその文字列、ない場合は前回と同じ文字列になります。

bMatchCase:大文字と小文字を区別する場合は1を、区別しない場合は0を、前回と同じ指定にする場合は2を指定します。

bSearchAll:全検索する場合は1を、しない場合は0を、前回と同じ指定にする場合は2を指定します。

解説: 検索ダイアログを表示して検索をおこないます。3つの引数は検索ダイアログ表示時の初期値となります。

5.6.87. Searchメソッド

bool Search(string searchStr, bool bMatchCase, bool bSearchAll, bool bReverse,

bool bMultiStr); (.NET)

VARIANT_BOOL Search(BSTR searchStr, VARIANT_BOOL bMatchCase,

VARIANT_BOOL bSearchAll, VARIANT_BOOL bReverse, VARIANT_BOOL bMultiStr); (ActiveX)

searchStr:検索文字列。NULLを指定すると選択中の文字列がある場合はその文字列、ない場合は前回と同じ文字列になります。

bMatchCase:大文字と小文字を区別する場合はTrueを指定します。

bSearchAll:全検索する場合はTrueを、しない場合はFalseを指定します。

bReverse:リバース検索(逆方向に検索)をおこなう場合はTrueを指定します。

bMultiStr:複数単語検索をおこなう場合はTrueを指定します。文字列の指定はsearchStrにスペース区切りで複数の文字列をセットしてください。複数単語検索は全検索時のみ有効です。

戻り値:True 成功。

解説: 検索をおこないます。検索後はSearchNext、SearchPreviousが有効になります。検索に失敗したときは「検索文字列が見つかりませんでした。」というメッセージが表示されます。これを非表示にしたい場合は、CtrlStyleプロパティでAGCS_HIDEERRDLGを指定してください。

(V5以降)SearchNextやSearchPreviousメソッドを繰り返し呼び出し一巡した場合、再び、最初から検索を繰り返します。

5.6.88. SearchNextメソッド

void SearchNext(); (.NET)

void SearchNext(); (ActiveX)

解説:次検索をおこないます。

5.6.89. SearchPreviousメソッド

void SearchPrevious(); (.NET)

void SearchPrevious(); (ActiveX)

解説:前検索をおこないます。

5.6.90. ClearSelectメソッド

void ClearSelect(); (.NET)

void ClearSelect(); (ActiveX)

解説:選択中のテキストをクリア(非選択状態)にします。検索によって選択状態になったテキストもクリアされます。

5.6.91. MakeBmpPageメソッド

bool MakeBmpPage(int32 pageNo, int32 dpi, string scale, int32 height, AvsImageColor nColor,

System.Drawing.Rectangle rcClip, string filePath); (.NET)

VARIANT_BOOL MakeBmpPage(long pageNo, long dpi, BSTR scale, long height,

AvsImageColor nColor, long clipLeft, long clipTop, long clipRight, long clipBottom,

BSTR filePath); (ActiveX)

戻り値:成功の場合はTrue、失敗したらFalseを返します。

pageNo:ページ番号

dpi:スケーリング時のDPI値(1以上、1440以下)

scale:出力時のスケール文字列。100%以下、”1”==”100%”,”100px”は幅の指定

height:出力イメージの最大高さ(Pixel)

nColor:色数を次の値で指定します。

AvsImageColor

説明

IMC_COLOR

0

フルカラー

IMC_256COLOR

1

256色カラー

IMC_GRAYSCALE

2

グレースケール

IMC_MONOCHROME

3

モノクローム

clipLeft/clipTop/clipRight/clipBottom/rcClip:イメージを作成するページ内の領域。空の矩形はページ全体(twip)

filePath:出力先ファイルパス

解説:指定ページをBMP画像に変換します。

※ 注釈等のオブジェクトは外観ストリーム情報をもつものだけが表示されるためページビューの表示とは異なる場合があります。また編集内容は反映されません。

5.6.92. MakeJpegPageメソッド

bool MakeJpegPage(int32 pageNo, int32 dpi, string scale, int32 height, AvsImageColor nColor,

int32 quality, System.Drawing.Rectangle rcClip, string filePath); (.NET)

VARIANT_BOOL MakeJpegPage(long pageNo, long dpi, BSTR scale, long height,

AvsImageColor nColor, long quality, long clipLeft, long clipTop, long clipRight, long clipBottom, BSTR filePath); (ActiveX)

戻り値:成功の場合はTrue、失敗したらFalseを返します。

pageNo:ページ番号

dpi:スケーリング時のDPI値(1以上、1440以下)

scale:出力時のスケール文字列。100%以下、”1”==”100%”,”100px”は幅の指定

height:出力イメージの最大高さ(Pixel)

nColor:色数を指定します。MakeBmpPageの同変数を参照してください。

quality:変換品質(1-100 %)1-100以外の場合は80として処理します。

clipLeft/clipTop/clipRight/clipBottom/rcClip:イメージを作成するページ内の領域。空の矩形はページ全体(twip)

filePath:出力先ファイルパス

解説:指定ページをJPEG画像に変換します。

※ 注釈等のオブジェクトは外観ストリーム情報をもつものだけが表示されるためページビューの表示とは異なる場合があります。また編集内容は反映されません。

5.6.93. MakePngPageメソッド

bool MakePngPage(int32 pageNo, int32 dpi, string scale, int32 height, AvsImageColor nColor,

System.Drawing.Rectangle rcClip, string filePath); (.NET)

VARIANT_BOOL MakePngPage(long pageNo, long dpi, BSTR scale, long height,

AvsImageColor nColor, long clipLeft, long clipTop, long clipRight, long clipBottom,

BSTR filePath); (ActiveX)

戻り値:成功の場合はTrue、失敗したらFalseを返します。

pageNo:ページ番号

dpi:スケーリング時のDPI値(1以上、1440以下)

scale:出力時のスケール文字列。100%以下、”1”==”100%”,”100px”は幅の指定

height:出力イメージの最大高さ(Pixel)

nColor:色数を指定します。MakeBmpPageの同変数を参照してください。

clipLeft/clipTop/clipRight/clipBottom/rcClip:イメージを作成するページ内の領域。空の矩形はページ全体(twip)

filePath:出力先ファイルパス

解説:指定ページをPNG画像に変換します。注釈等オブジェクトの編集内容は反映されません。

5.6.94. MakeTiffPageメソッド

bool MakeTiffPage(int32 startPageNo, int32 endPageNo, int32 dpi, string scale, int32 height,

AvsImageColor nColor, int32 quality, System.Drawing.Rectangle rcClip,

AvsTiffCompression compression, string filePath); (.NET)

VARIANT_BOOL MakeTiffPage(long startPageNo, long endPageNo, long dpi, BSTR scale,

long height, AvsImageColor nColor, long quality, long clipLeft, long clipTop,

long clipRight, long clipBottom, long compression, BSTR filePath); (ActiveX)

戻り値:成功の場合はTrue、失敗したらFalseを返します。

startPageNo:開始ページ番号

endPageNo:終了ページ番号

dpi:スケーリング時のDPI値(1以上、1440以下)

scale:出力時のスケール文字列。100%以下、”1”==”100%”,”100px”は幅の指定

height:出力イメージの最大高さ(Pixel)

nColor:色数を指定します。MakeBmpPageの同変数を参照してください。

quality:DCT変換品質(1-100 %)compressionで2のDCTが指定されたときのみ有効です。

1-100以外の場合は80として処理します。

clipLeft/clipTop/clipRight/clipBottom/rcClip:イメージを作成するページ内の領域。空の矩形はページ全体(twip)

compression:圧縮形式を次の値で指定します。デフォルトは1のLZWです。

AvsTiffCompression

説明

TCP_None

0

圧縮なし

TCP_LZW

1

LZW

TCP_DCT

2

DCT (JPEG)

TCP_Flate

3

Flate

TCP_RunLength

4

RunLength

TCP_CCITT3

5

CCITT3

TCP_CCITT4

6

CCITT4

filePath:出力先ファイルパス

解説:指定ページをTIFF画像に変換します。

※ 注釈等のオブジェクトは外観ストリーム情報をもつものだけが表示されるためページビューの表示とは異なる場合があります。また編集内容は反映されません。複数ページを指定した場合はページの編集内容(ページ移動等)も反映されません。

5.6.95. MakeSvgPageメソッド

bool MakeSvgPage(int32 pageNo, System.Drawing.Rectangle rcClip, string filePath); (.NET)

VARIANT_BOOL MakeSvgPage (long pageNo, long clipLeft, long clipTop, long clipRight, long clipBottom, BSTR filePath); (ActiveX)

戻り値:成功の場合はTrue、失敗したらFalseを返します。

pageNo:ページ番号

clipLeft/clipTop/clipRight/clipBottom/rcClip:SVGを作成するページ内の領域。空の矩形はページ全体(twip)

filePath:出力先ファイルパス

解説:指定ページをSVGファイルに変換します。

※ 注釈等のオブジェクトは外観ストリーム情報をもつものだけが表示されるためページビューの表示とは異なる場合があります。また編集内容は反映されません。

5.6.96. GetDefaultObjectProperty/ GetDefaultObjectProperty2メソッド

AvsDotNetGuiCtl.ObjectProperty GetDefaultObjectProperty(AvsSelectMode type); (.NET)

void GetDefaultObjectProperty2(AvsSelectMode type,

AVSACTIVEXCTLLib.AvsObjectProperty* op); (ActiveX)

void GetDefaultObjectProperty(AvsSelectMode type, long* color, long* fillColor, long* borderStyle,

float* borderWidth, float* opacity, long* lineCap1, long* lineCap2, BSTR* fontName,

long* fontStyle, long* fontSize, long* fontColor, BSTR* text, long *exStyle ); (ActiveX)

解説:指定したオブジェクトタイプのデフォルトプロパティを取得します。戻り値、引数の説明はSetDefaultObjectPropertyを参照してください。

5.6.97. SetDefaultObjectProperty/ SetDefaultObjectProperty2メソッド

void SetDefaultObjectProperty(AvsSelectMode type, AvsDotNetGuiCtl.ObjectProperty op); (.NET)

void SetDefaultObjectProperty2(AvsSelectMode type,

AVSACTIVEXCTLLib.AvsObjectProperty op); (ActiveX)

void SetDefaultObjectProperty(AvsSelectMode type, OLE_COLOR color, OLE_COLOR fillColor,

AvsBorderStyle borderStyle, float borderWidth, float opacity, AvsLineCapType lineCap1,

AvsLineCapType lineCap2, BSTR fontName, long fontStyle, long fontSize,

OLE_COLOR fontColor, BSTR text, long exStyle ); (ActiveX)

type:設定するオブジェクトタイプ。ASM_INS_STICKYNOTE(100)~.ASM_INS_SQUIGGLY(115)の間で指定します。※下記表参照

color:色、境界線色を示すCOLORREF値(-1を指定すると透過)

fillColor:背景色を示すCOLORREF値(-1を指定すると透過)

borderStyle:境界線スタイル

AvsBorderStyle

説明

ABDS_SOLID

0

実線

ABDS_DOT

1

点線

ABDS_DASH1

2

破線1

ABDS_DASH2

3

破線2

ABDS_DASHDOT1

4

一点鎖線1

ABDS_DASHDOT2

5

一点鎖線2

ABDS_DASHDOT3

6

一点鎖線3

ABDS_UNDERLINE

7

下線(リンク注釈のみ指定可)

borderWidth:境界線の幅(単位:twip)

opacity:不透明度(0~1.0)

lineCap1/lineCap2:始点/終点のラインキャップ

AvsLineCapType

説明

ALCT_NONE

0

なし

ALCT_OPENARROW

1

開いた矢印

ALCT_CLOSEDARROW

2

閉じた矢印

ALCT_ROPENARROW

3

開いた矢印(内向き)

ALCT_RCLOSEDARROW

4

閉じた矢印(内向き)

ALCT_BUTTON

5

突合わせ

ALCT_DIAMOND

6

ひし形

ALCT_CIRCLE

7

円形

ALCT_SQUARE

8

四角形

ALCT_SLASH

9

スラッシュ

fontName:フォント名

fontStyle:フォントスタイル 下記ビットの組み合わせを指定します。

AvsFontStyle

説明

AFTS_BOLD

0x0001

強調表示

AFTS_ITALIC

0x0002

斜体

AFTS_UNDERLINE

0x0004

下線

AFTS_STRIKEOUT

0x0008

取消線

fontSize:フォントサイズ(単位:ポイント)

fontColor:フォント色を示すCOLORREF値

text:初期挿入するテキスト

exStyle:ノート注釈、ファイル添付ではアイコンの種類。リンクではハイライト表示スタイルを示します。

ノート注釈

ファイル添付

リンク

0

注釈

グラフ

なし

1

ヘルプ

クリップ

反転

2

テキスト挿入

添付

アウトライン

3

キー

タグ

プッシュ

4

新規段落

5

ノート

6

段落

解説:指定したオブジェクトタイプのデフォルトプロパティを設定します。設定すると次回そのオブジェクトを新規作成したときにプロパティの初期値として使われます。
オブジェクトタイプによって設定可能なプロパティは異なります。(下記表参照)

AvsSelectMode

color

fillColor

border

Style

border

Width

opacity

line

Cap1

line

Cap2

font

Name

font

Style

font

Size

font

Color

text

exStyle

ASM_INS_STICKYNOTE

ASM_INS_LINK

ASM_INS_FILEATTACHMENT

ASM_INS_TEXTBOX

ASM_INS_CALLOUT

ASM_INS_TYPEWRITER

ASM_INS_LINE

ASM_INS_ARROW

ASM_INS_RECTANGLE

ASM_INS_OVAL

ASM_INS_POLYGON

ASM_INS_POLYLINE

ASM_INS_HIGHLIGHT

ASM_INS_UNDERLINE

ASM_INS_CROSSOUT

ASM_INS_SQUIGGLY

AvsDotNetGuiCtl.ObjectProperty(.NET) / AVSACTIVEXCTLLib.AvsObjectProperty(ActiveX)はオブジェクトのプロパティをあらわすクラスです。

AvsDotNetGuiCtl.ObjectProperty/ AVSACTIVEXCTLLib.AvsObjectProperyメンバ

メンバ名

説明

.NET

ActiveX

int32

long

Color

SetDefaultObjectProperty引数を参照してください。

int32

long

FillColor

AvsBorderStyle

BorderStyle

float32

float

BorderWidth

float32

float

Opacity

AvsLineCapType

LineCap1

AvsLineCapType

LineCap2

String

BSTR

FontName

int32

float

FontStyle

int32

float

FontSize

int32

float

FontColor

String

BSTR

Text

int32

float

ExStyle

5.6.98. GetCursorPositionメソッド

AvsDotNetGuiCtl.LogicalPoint GetCursorPosition(); (.NET)

void GetCursorPosition(long* pageNo, long* x, long* y); (ActiveX)

戻り値:論理座標(ページ番号、x, y)を返します。(.NET)

pageNo:ページ番号 (ActiveX)

x:x座標 (ActiveX)

y:y座標 (ActiveX)

解説:現在カーソル位置を論理座標(単位:twip)で取得します。

AvsDotNetGuiCtl.LogicalPoint(.NET) は論理座標をあらわすクラスです。

AvsDotNetGuiCtl.LogicalPointクラス メンバ

LogicalPoint(int32 pageNo, int32 x, int32 y)

コンストラクタ

int32 PageNumber

ページ番号

int32 X

X座標

int32 Y

Y座標

5.6.99. ScrollToPositionメソッド

void ScrollToPosition(AvsDotNetGuiCtl.LogicalPoint lPos, bool isAddUndoView); (.NET)

void ScrollToPosition(long pageNo, long x, long y, VARIANT_BOOL isAddUndoView); (ActiveX)

pageNo:ページ番号 (ActiveX)

x:x座標 (ActiveX)

y:y座標 (ActiveX)

lPos:論理座標 (.NET)

isAddUndoView:ビューのアンドゥを追加するかどうかの指定

解説:指定した論理位置がビューの左上にくるようにビューをスクロールします。AvsDotNetGuiCtl.LogicalPointクラスについての説明はGetCursorPositionを参照してください。

5.6.100. ClientToLogicalメソッド

AvsDotNetGuiCtl.LogicalPoint ClientToLogical(System.Drawing.Point point); (.NET)

void ClientToLogical(long x, long y, long* pageNo, long* x, long* y,); (ActiveX)

戻り値 (.NET):論理座標(ページ番号、x, y)を返します。

x( ActiveX):クライアントx座標

y (ActiveX):クライアントy座標

pageNo (ActiveX):論理ページ番号

x (ActiveX):論理x座標

y (ActiveX):論理y座標

point (.NET):クライアント座標

解説:指定したクライアント座標を論理座標に変換します。

連続ページ表示や見開き表示では複数ページが同時に表示されるため、

論理座標と合わせて論理ページ番号が返ります。

         ※ページ領域外では、論理座標は負値や論理ページのページサイズを超える値となります。

5.6.101. SetSelectModeExメソッド

void.SetSelectModeEx(AvsSelectMode mode, int32 customOperation); (.NET)

void SetSelectModeEx(AvsSelectMode mode, long customOperation); (ActiveX)

mode:カスタムモード(ASM_CUSTOM1~ASM_CUSTOM5)を指定します。詳細はAvsSelectModeを確認してください。

customOperation:このカスタムモードに許可する操作を下記ビットの組み合わせで指定します。

AvsEnableOperation

説明

AEO_RCOBJSEL

0x0001

オブジェクトの矩形選択ができます。

AEO_TEXTSEL

0x0002

テキストの選択ができます。

AEO_LINKOP

0x0008

リンク注釈をクリックしてアクションを発動できます。

AEO_LINKEDT

0x0010

リンク注釈を選択、編集することができます。

AEO_ANNOTEDT

0x0020

リンク注釈を除く注釈を選択、編集することができます。

AEO_FORMOP

0x0040

フォームをクリックしてアクションを発動できます。(現状は未対応)

AEO_FORMEDT

0x0080

フォームを選択、編集することができます。

AEO_DRAGSCRL

0x0100

ドラッグによるスクロールができます。

AEO_MQZOOM

0x0200

マーキーズーム機能を使うことができます。

AEO_PANSCRL

0x0400

タッチ操作によるスクロール、ピンチイン・ピンチアウトができます。

解説:独自のカスタム選択モードを作成、指定します。

5.6.102. CreateObjectメソッド

String CreateObject(AvsDotNetGuiCtl.AvsSelectMode mode, int32 pageNo, long mask,

AvsDotNetGuiCtl.AvsObject object); (.NET)

BSTR CreateObject(AvsSelectMode mode, long pageNo, long mask,

AVSACTIVEXCTLLib.AvsObject object); (ActiveX)

戻り値:作成したオブジェクトのIDを返します。失敗した場合は空文字列を返します。

mode:注釈作成モード(ASM_INS_STICKYNOTE~ASM_INS_SQUIGGLY)を指定します。詳細はAvsSelectModeを確認してください。

pageNo:注釈を作成するページ番号を指定します。

mask:どのパラメータを指定したいかを下記マスクビットの組み合わせで指定します。

AvsObjectMask

説明

AOPM_COLOR

0x00000001

AOPM_FILLCOLOR

0x00000002

背景色

AOPM_OPACITY

0x00000004

不透明度

AOPM_BORDERSTYLE

0x00000008

境界線スタイル

AOPM_BORDERWIDTH

0x00000010

境界線幅

AOPM_LINECAP

0x00000020

始点/終点のラインキャップ

AOPM_FONTNAME

0x00000080

フォント名

AOPM_FONTSTYLE

0x00000100

フォントスタイル

AOPM_FONTSIZE

0x00000200

フォントサイズ

AOPM_FONTCOLOR

0x00000400

フォント色

AOPM_TEXT

0x00000800

テキスト

AOPM_EXSTYLE

0x00001000

特殊スタイル

AOPM_COORDINATE

0x00010000

座標

AOPM_STATE

0x00020000

状態

AOPM_FILE

0x00040000

添付ファイル

AOPM_SUBJECT

0x00080000

タイトル

AOPM_AUTHOR

0x00100000

作成者

AOPM_PARENTIDD

0x00200000

ポップアップ注釈の親注釈ID

AOPM_LASTUPDATED

0x00400000

更新日時

AOPM_CREATIONDATE

0x00800000

作成日時

AOPM_ALL

0xFFFFFFFF

すべてのパラメータ

object:オブジェクトのパラメータを指定します。

 AvsObject

AvsDotNetGuiCtl.AvsObject/ AVSACTIVEXCTLLib.AvsObjectメンバ

メンバ名

説明

.NET

ActiveX

AvsObjectType

Type

オブジェクトタイプです。読み取り専用。

String

BSTR

Id

オブジェクトIDです。読み取り専用。

Int32

float

State

オブジェクト状態のビットの組み合わせです。AvsObjectState参照。

ArrayList

VARIANT

Coordinates

オブジェクトの論理座標です。

.NETではSystem.Drawing.PointのArrayList配列、ActiveXではlongの配列になります。

AvsObjectProperty

Property

オブジェクトのプロパティです。

String

BSTR

FileName

添付ファイルのファイル名です。

Stream

VARIANT

FileBin

添付ファイルのバイナリです。ActiveXではBYTEの配列になります。

String

BSTR

Subject

タイトルです。リンク注釈は取得、設定できません。

String

BSTR

Author

作成者名です。リンク注釈は取得、設定できません。

String

BSTR

ParentId

ポップアップ注釈の親注釈IDです。読み取り専用。

ポップアップ注釈でのみ有効です。

String

BSTR

LastUpdated

更新日時です。読み取り専用。

String

BSTR

CreationDate

作成日時です。読み取り専用。

Int32

PageNumber

注釈が存在するページ番号。読み取り専用。(.Netのみ)

AvsObjectType

AvsObjectType

説明

OT_ANT_UNKNOWN

-1

不明

OT_ANT_TEXT

0

テキスト注釈(ノート注釈)

OT_ANT_LINK

1

リンク注釈

OT_ANT_FREETEXT

2

フリーテキスト注釈(テキストボックス、コールアウト、タイプライター)

OT_ANT_LINE

3

線注釈

OT_ANT_SQUARE

4

四角形注釈

OT_ANT_CIRCLE

5

楕円注釈

OT_ANT_POLYGON

6

多角形注釈

OT_ANT_POLYLINE

7

折れ線注釈

OT_ANT_HIGHLIGHT

8

ハイライト注釈

OT_ANT_UNDERLINE

9

下線注釈

OT_ANT_SQUIGGLY

10

波下線注釈

OT_ANT_STRIKEOUT

11

取消線注釈

OT_ANT_STAMP

12

スタンプ注釈

OT_ANT_CARET

13

キャレット注釈

OT_ANT_INK

14

インク注釈

OT_ANT_POPUP

15

ポップアップ注釈

OT_ANT_FILEATTACHMENT

16

ファイル添付注釈

OT_ANT_SOUND

17

サウンド注釈

OT_ANT_MOVIE

18

ムービー注釈

OT_ANT_WIDGET

19

ウィジェット注釈

OT_ANT_SCREEN

20

スクリーン注釈

OT_ANT_PRINTERMARK

21

プリンターマーク注釈

OT_ANT_TRAPNET

22

トラップネット注釈

OT_ANT_WATERMARK

23

ウォーターマーク注釈

OT_ANT_3D

24

3D注釈

OT_ANT_PROJECTION

25

プロジェクション注釈

OT_ANT_RICHMEDIA

26

リッチメディア注釈

  AvsObjectState

AvsObjectState

説明

OST_SELECTED

0x0001

選択されているか?(取得・設定)

OST_MODIFIED

0x0002

編集状態か?(取得のみ)

OST_OPENED

0x0004

ポップアップがオープンしているか?(取得・設定)

OST_LOCKED

0x0008

編集不可(ロック)であるか?(取得・設定)

※注釈のプロパティダイアログで「ロック」をチェックすることと同等です。

OST_NOTSELECTABLE

0x0010

選択不可であるか?(取得・設定)

※選択不可を指定した場合、選択状態は解除されます。また、選択(OST_SELECTED)を指定しても選択状態になりません。

解説:

注釈をプログラムからダイレクト作成します。 オブジェクトパラメータのうち、Coordinatesは必ず指定が必要ですので下記表に従って必要な配列をつくり、指定してください。

作成できる注釈は、ASM_INS_STICKYNOTE ~ ASM_INS_SQUIGGLY に対応した注釈になります。

※.NETの場合はSystem.Drawing.Pointの配列をArrayListで指定します。

ActiveXの場合はlongの配列を「X座標、Y座標、X座標・・・」の順で指定します。

(Pointではないので.NETの倍の配列要素数になります)

AvsSelectMode

AvsSelectMode

対応する注釈タイプ

(AvsObjectType)

Coordinatesに指定する必要がある座標

ASM_INS_STICKYNOTE

OT_ANT_TEXT

0:左上

ASM_INS_LINK

OT_ANT_LINK

0:左上 1:右下

ASM_INS_FILEATTACHMENT

OT_ANT_FILEATTACHMENT

0:左上

ASM_INS_TEXTBOX

OT_ANT_FREETEXT

0:左上 1:右下

ASM_INS_CALLOUT

OT_ANT_FREETEXT

0:左上 1:右下 2-4: 引出線

(2:矢印-4:テキストボックス接続点)

ASM_INS_TYPEWRITER

OT_ANT_FREETEXT

0:左上 1:右下

ASM_INS_LINE

OT_ANT_LINE

0:始点 1:終点

ASM_INS_ARROW

OT_ANT_LINE

ASM_INS_RECTANGLE

OT_ANT_SQUARE

0:左上 1:右下

ASM_INS_OVAL

OT_ANT_CIRCLE

ASM_INS_POLYGON

OT_ANT_POLYGON

点の数だけ順番に指定してください。

ASM_INS_POLYLINE

OT_ANT_POLYLINE

ASM_INS_HIGHLIGHT

OT_ANT_HIGHLIGHT

0:左上 1:右上 2:左下 3:右下

ASM_INS_UNDERLINE

OT_ANT_UNDERLINE

ASM_INS_CROSSOUT

OT_ANT_STRIKEOUT

ASM_INS_SQUIGGLY

OT_ANT_SQUIGGLY

OT_ANT_POPUP

0:左上 1:右下

その他、下記に注意してください。

  • Coordinatesの座標は指定したページのページサイズに収まるよう指定してください。座標に問題がある場合、位置を補正しますがそれでも問題がある場合はメソッドが失敗します。
  • ポップアップ注釈(OT_ANT_POPUP)では GetObjectInfo/ModifyObjectsでのみ、Coordinatesプロパティが利用できます。作成/削除はできません。
  • ファイル添付注釈をつくる場合はmaskにAOPM_FILEの指定が必要です。
  • AOPM_FILEの指定をした場合はFileNameとFileBinの指定が必須となります。

5.6.103. GetObjectCountメソッド

int32 GetObjectCount (int32 pageNo); (.NET)

long GetObjectCount(long pageNo); (ActiveX)

戻り値:注釈数

pageNo:ページ番号

解説:指定したページに含まれるオブジェクト(注釈)数を取得します。未対応の注釈はカウントされません。

5.6.104. GetObjectInfoメソッド

AvsDotNetGuiCtl.AvsObject GetObjectInfo(String id, long mask); (.NET)

VARIANT_BOOL GetObjectInfo(BSTR id, long mask,

AVSACTIVEXCTLLib.AvsObject* object); (ActiveX)

戻り値:(ActiveX) 成功した場合trueが返ります。 

(.NET) 成功した場合は取得したオブジェクト情報、失敗した場合はnullが返ります。

id:オブジェクトID

mask:どのパラメータを取得したいかをAvsObjectMaskマスクビットの組み合わせで指定します。

object (ActiveX):取得したパラメータが返ります。

解説:IDを指定してオブジェクト(注釈)情報を取得します。

5.6.105. DeleteObjectsメソッド

bool DeleteObjects(ArrayList ids); (.NET)

VARIANT_BOOL DeleteObjects(VARIANT ids); (ActiveX)

戻り値:成功した場合trueが返ります。 

ids:オブジェクトID の配列

解説:指定したIDのオブジェクト(注釈)をすべて削除します。

5.6.106. ModifyObjectsメソッド

bool ModifyObjects(ArrayList ids, long mask, AvsDotNetGuiCtl.AvsObject object); (.NET)

VARIANT_BOOL ModifyObjects(VARIANT ids, long mask,

AVSACTIVEXCTLLib.AvsObject* object); (ActiveX)

戻り値:成功した場合trueが返ります。 

ids:オブジェクトID の配列

mask:どのパラメータを変更したいかをAvsObjectMaskマスクビットの組み合わせで指定します。

object:オブジェクトのパラメータを指定します。AvsObject参照。

解説:指定したIDのオブジェクト(注釈)をすべて変更します。詳しくはCreateObjectメソッドの説明を参照してください。

5.6.107. HitTestメソッド

AvsDotNetGuiCtl.AvsHitTestResult HitTest (System.Drawing.Point point, [out] String objId); (.NET)

AVSACTIVEXCTLLib.AvsHitTestResult HitTest(long x, long y, BSTR* objId); (ActiveX)

戻り値:下記結果が返ります。

AvsHitTestResult

説明

GHR_NONE

0

Hitせず

GHR_TEXT

1

テキスト

GHR_ANCHOR

2

リンク

GHR_TEXTV

3

テキスト(縦書き)

GHR_OBJ_TOPLEFT

4

注釈 左上

GHR_OBJ_BOTTOMLEFT

5

注釈 左下

GHR_OBJ_BOTTOMRIGHT

6

注釈 右下

GHR_OBJ_TOPRIGHT

7

注釈 右上

GHR_OBJ_TOP

8

注釈 上

GHR_OBJ_LEFT

9

注釈 左

GHR_OBJ_BOTTOM

10

注釈 下

GHR_OBJ_RIGHT

11

注釈 右

GHR_OBJ_INBODY

12

注釈の中

GHR_OBJ_INTEXT

13

注釈 テキストボックスの中

GHR_OBJ_BTN

14

ポップアップ注釈のボタン

GHR_OBJ_INBODY_PART

15

テキストボックスの境界線

GHR_BADPOINT

1000

用紙外

GHR_OBJ_POINT

10000以上

多角形/折れ線注釈の点

x (ActiveX):クライアントX座標

y (ActiveX):クライアントY座標

point (.NET) :クライアント座標

objId:オブジェクトがあった場合にそのIDが入ります。

解説:指定した位置にあるものを調べます。オブジェクトが存在する場合はそのIDを返します。ただし未対応の注釈は検出できません。

5.6.108. GetNextObjectIdメソッド

String GetNextObjectId (int32 pageNo String objId); (.NET)

BSTR GetNextObjectId(long pageNo, BSTR objId); (ActiveX)

戻り値:オブジェクトID

pageNo:ページ番号

objId:オブジェクトID

解説:指定したページに存在するオブジェクトのIDを取得します。objIdに空文字列を指定すると一つ目のオブジェクトIDが取得でき、IDを指定するとその次のIDが取得できます。

5.6.109. SetHilightTextメソッド

void SetHilightText (int32 pageNo, int32 startPos, int32 endPos); (.NET)

void SetHilightText (long pageNo, long startPos, long endPos); (ActiveX)

pageNo:ページ番号

startPos:開始文字位置

endPos:終了文字位置

解説:指定したページの開始文字位置から終了文字位置までのテキストをハイライト表示します。ハイライト色は HilightTextColor プロパティで変更できます。テキスト選択、検索時のハイライトはこのメソッドで指定されるハイライトより上位に表示されます。

ページサイズの外に位置するテキストは指定してもハイライトされません。

5.6.110. ClearHilightTextメソッド

void ClearHilightText (); (.NET)

void ClearHilightText (); (ActiveX)

解説:SetHilightTextメソッドで設定されたハイライトをすべて解除します。

5.6.111. GetTextInfoメソッド

ArrayList GetTextInfo (int32 pageNo, AvsTextExtractOption option); (.NET)

戻り値:AvsTextInfoオブジェクトの配列

pageNo:ページ番号

option:テキストの抽出条件

解説:指定したページの矩形範囲に含まれるテキストについて、テキストの情報(AvsTextInfo オブジェクト)を文字ごとに配列で返します。矩形範囲はAvsExtractTextOptionのRectsフィールドで指定してください。

TEXT_SORTを指定した場合、テキストの座標に従ってソートされた順でテキストが抽出されます。また文字間や行間が認識された場合は、ATT_SpaceやATT_Newlineのテキスト情報が含まれる場合があります。通常のテキスト情報(ATT_Normal)でTextに空白や改行文字が含まれる場合があります。

TEXT_RAWを指定した場合、ページコンテンツの順番でテキストが抽出されます。この場合はテキストの座標値は利用できません。またATT_SpaceやATT_Newlineのテキスト情報は追加されません。

※座標変換により文字に回転や歪み(skew)がある場合など正しい情報が取得できない場合があります。

※縦書きや斜めに傾いている場合には正しく機能しません。

※取得できる情報やテキストの順序はGetTextInRectとは同一にはなりません。

AvsDotNetGuiCtl.AvsTextInfoメンバ

メンバ名

説明

.NET

AvsTextType

TextType

String

Text

文字

System.Drawing.Rectangle

Rect

文字のバウンディングボックス(論理座標での原点からの位置)

int32

Baseline

ベースライン位置(論理座標での原点からの高さ)単位 TWIP

int32

FontSize

フォントサイズ 単位 TWIP

String

FontName

フォント名(ベースフォント名)

Int32

PageNumber

文字が存在するページ番号

AvsWritingMode

WritingMode

文字列の方向を表す数値です。方向は現在の座標系での方向になります。(ViewCoordプロパティに依存します。)

※座標変換に0/90/180/270度以外の回転がある場合は文字列の方向が正しく取得できません。

bool

IsVertical

PDF内部のフォントが縦書き用か横書き用か

true … 縦書き

false … 横書き

※ページ回転や座標変換によりません

プロパティ

IsNewLine 型: bool (.NET) (getのみ)  テキスト情報が空白か。

IsSpace  型: bool (.NET) (getのみ)  テキスト情報が改行か。

取得可能なフィールド

   AvsTextInfoクラスの取得可能なフィールドは、取得するメソッドによって変わります。

取得メソッド

GetTextInfo

(TEXT_RAW)

GetTextInfo

(TEXT_SORT)

GetTextInfoInRect

/GetSelectedTextInfo

Text

Rect

×

〇※3

〇※3

Baseline

×

×

FontSize

×

〇※1

FontName

×

×

PageNumber

WritingMode

×

×

IsVertical

×

×

〇※2

   ※1 同じフォントであっても、座標変換の拡大縮小によって出現箇所によって実際の表示サイズはこと

なります。この拡大縮小が反映された見かけ上のサイズになります。

※2 IsNewLineフィールドは V5.0 改訂6版から廃止されました。代わりにIsNewLineプロパティ(get)

をお使いください。

※3 Rectフィールドのサイズは、GetTextInfoとGetTextInfoInRectでは必ずしも一致しません。

AvsTextType

AvsTextType

説明

ATT_Normal

0

文字(改行や空白文字が含まれる場合もあります)

ATT_Newline

1

行間から認識された改行

ATT_Space

2

文字間から認識された空白

AvsWritingMode

AvsWritingMode

説明

WM_lr_tb

0

左から右

WM_rl_tb

1

右から左

WM_tb_rl

2

上から下

WM_bt_rl

3

下から上

WM_lr_bt

4

左から右(WM_lr_tbの上下反転)

WM_rl_bt

5

右から左WM_rl_tbの上下反転)

WM_tb_lr

6

上から下(WM_tb_rlの左右反転)

WM_bt_lr

7

下から上(WM_bt_rlの左右反転)

AvsTextExtractOption

AvsDotNetGuiCtl.AvsTextExtractOptionメンバ

メンバ名

説明

.NET

AvsTextExtractType

TextType

TEXT_RAW または TEXT_SORT

float

IgnoreActualText

ActualTextを無視するか

既定値:false (無視しない)

float

TextOverlapRatio

テキストが矩形とどれくらい重なっていたら抽出対象とするか

既定値:0.3

float

OverlapAsLine

文字と文字がどれくらい重なっていると同じ行とみなすか(TEXT_SORTのみ)

既定値:0.7

float

SameTextOmitRatio

同じ文字が重なっている場合、文字と文字がどれだけ重なっていると取り除くか(TEXT_SORTのみ)

既定値:0.0(取り除かない)

float

DifferentTextOmitRatio

違う文字が重なっている場合、文字と文字がどれだけ重なっていると取り除くか(TEXT_SORTのみ)

既定値:0.0(取り除かない)

bool

DifferentTextOmitRatioApplyAtDifferentColor

DifferentTextOmitRatioを色が違う場合にのみ適用するか(TEXT_SORTのみ)

既定値:true

Int32

UnicodeToSpace

指定されたUnicodeをSpace(U+0020)に置き換えるか

既定値:0(置き換えない)

Int32

UnicodeToRemove

指定されたUnicodeをSpace(U+0020)に削除するか

既定値:0(削除しない)

ArrayList

Rects

System.Drawing.Rectangleを要素にもつ配列。

テキスト抽出の対象とする矩形領域を指定してください。複数の領域を指定できます。

ページ全体の場合は空配列を指定してください。

AvsTextExtractType

AvsTextExtractType

説明

TEXT_RAW

1

ページコンテンツにおける出現順で抽出する

TEXT_SORT

2

取得したテキストを座標でソートして抽出する

サンプルコード例

・GetTextInfoInRect は以下の対応するコードでおきかえ可能です。

//ArrayList list = pdfPageViewCtrl1.GetTextInfoInRect(pageNo, rc);

//opt.TextType = AvsTextExtractType.TEXT_SORT;

AvsTextExtractOption opt = new AvsTextExtractOption();

opt.TextType = AvsTextExtractType.TEXT_RAW;

opt.Rects.Add(rc);

ArrayList list = pdfPageViewCtrl1.GetTextInfo(pageNo, opt);

・余白から判定された文字間や行間のマークは以下で判定できます。

AvsTextInfo ti = (AvsTextInfo)list[i];

if (ti.IsNewLine) { } // 余白から判定された行間

else if (ti.IsSpace) { } // 余白から判定された文字間

else { } // 文字コードが存在する場合。空白スペース等も含む

5.6.112. GetTextInfoInRectメソッド

ArrayList GetTextInfoInRect (int32 pageNo, System.Drawing.Rectangle rect); (.NET)

戻り値:AvsTextInfoオブジェクトの配列

pageNo:ページ番号

rect:矩形範囲

解説:指定したページの矩形範囲に含まれるテキストについて、テキストの情報(AvsTextInfo オブジェクト)を文字ごとに配列で返します。

テキストが改行される場合は、その位置にIsNewLine=Trueとなる、AvsTextInfoオブジェクトが追加されます。

※座標変換により文字に回転や歪み(skew)がある場合など正しい情報が取得できない場合があります。※現在の実装では、テキストのベースラインに一定量変化があるときに改行と判定しています。縦書きや斜めに傾いている場合には正しく機能しません。

※改行位置の判定はPDF仕様では明確に既定されないため、弊社リーダーの実装依存の動作になります。このため、他社のリーダーと同一にはなりません。

※取得できる情報やテキストの順序はGetTextInfoとは同一にはなりません。

5.6.113. ClientToLogicalRect メソッド

System.Drawing.Rectangle ClientToLogicalRect (int32 pageNo System.Drawing.Rectangle rect); (.NET)

void ClientToLogical(long left, long top, long right, long bottom, long pageNo, long* left, long* top, long* right, long* bottom,); (ActiveX)

戻り値(.NET):矩形(論理座標)

left( ActiveX):矩形左上のクライアントx座標

top (ActiveX):矩形左上のクライアントy座標

right( ActiveX):矩形右下のクライアントx座標

bottom (ActiveX):矩形右下のクライアントy座標

pageNo (ActiveX/):ページ番号

left( ActiveX):矩形左上の論理x座標

top (ActiveX):矩形左上の論理y座標

right( ActiveX):矩形右下の論理x座標

bottom (ActiveX):矩形右下の論理y座標

rect (.NET):矩形(クライアント座標)

解説:クライアント座標で表現された矩形を指定したページの論理座標に変換します。

5.6.114. SetCtrlCursorメソッド

System.Windows.Forms.Cursor SetCtrlCursor (System.Windows.Forms.Cursor cursor); (.NET)

戻り値:カーソルオブジェクト または NULL

cursor:カーソルオブジェクト

解説:コントロールのカーソルを指定したカーソルに指定します。通常はコントロール自身がカーソルを状態に合わせて制御するため、CtrlStyleプロパティのAGCS_DISABLECURSORフラグをONに設定して、コントロールのカーソル制御を無効にしてください。

 なお、カーソルが変更されるのはPDFPageViewCtrlにフォーカスしている最中のみです。上位アプリケーションにフォーカスがある場合はカーソルは変更されません。別途、Cursor.Currentプロパティなどで変更する必要があります。

5.6.115. SetSmoothingメソッド

bool SetSmoothing (bool text, bool lineart, bool image,); (.NET)

VARIANT_BOOL SetSmoothing(VARIANT_BOOL text, VARIANT_BOOL lineart, VARIANT_BOOL image); (ActiveX)

戻り値:再描画が必要な場合trueを返します。

text:文字のスムージング(AntiAlias)を行います。

lineart:線画のスムージングを行います。

image:イメージのスムージングを行います。

解説:スムージングを設定します。初期値はすべてtrueです。

変更はいつでも行えます。設定変更後、必要な場合は再描画されます。

表示だけでなく、印刷、イメージ作成にも有効です。

5.6.116. SelectTextStringメソッド

void SelectTextString (LogicalPoint start, LogicalPoint end); (.NET)

start:選択の開始位置(論理座標)

end:選択の終了位置(論理座標)

解説:指定したテキストの範囲を選択状態(ハイライト)にします。

開始位置・終了位置のどちらかに文字がない場合は、選択状態になりません。

ClearSelectメソッドで選択状態を解除できます。

5.6.117. SetFocusメソッド

void SetFocus(void); (.NET)

解説:コントロールにフォーカスを設定します。.NET の Control.Focusメソッドは正しく機能しませんのでこちらを使用してください。

5.6.118. GetSelectedTextInfoメソッド

void GetSelectedTextInfo(void); (.NET)

解説:選択中のテキストについて、テキストの情報(AvsTextInfo オブジェクト)を文字ごとに配列で返します。AvsTextInfo および制限事項について、GetTextInfoInRectメソッド を参照ください。

5.6.119. FitViewToRectメソッド

void FitViewToRect(AvsDotNetGuiCtl.LogicalPoint lPos1, AvsDotNetGuiCtl.LogicalPoint lPos2); (.NET)

lPos1:左上の論理座標 (.NET)

lPos2:右下の論理座標 (.NET)

解説:二点で指定される矩形範囲を表示します。縦横比を維持して指定した矩形がコントロールウィンドウに収まる倍率で表示されます。

座標値はViewCoordの設定にあわせて論理座標またはビュー座標を指定してください。異なるPageNumberを持つLogicalPointを指定できますがPageLayoutにあった座標を指定してください。

以下の制限があります。

・最大の倍率(6400%)以上になる範囲は指定しても最大倍率でしか表示されません。

・コントロールサイズやスクロールバーの関係で表示範囲はおおよそ指定された範囲が表示されますが、指定した座標値にぴったり一致はしません。

・現在のPageLayoutで表示できない範囲の場合、意図しない表示結果になる場合があります。PageLayoutは自動で調整されません。

5.6.120. GetLicenseInfoメソッド

string GetLicenseInfo(AvsLicenseInfo type); (.NET)

type:取得するライセンス情報の種別

戻り値(.NET):ライセンス情報を表す文字列

設定値:

AvsLicenseInfo (enum値)

説明

LI_PATH

0

ライセンスファイル(pdfviewersdk.lic)の絶対パス

LI_SERIAL

1

シリアルナンバー

LI_COMPANY

2

会社名

LI_SECTION

3

部署名

LI_USERNAME

4

ユーザー名

LI_MAINTENANCE_LIMIT

5

保守期限

解説:指定されたライセンス情報を取得します。

ライセンスファイルに登録がない場合、空文字列が返る場合があります。

5.6.121. DocumentOpenedイベント

void DocumentOpened(IntPtr hPDFDocument); (.NET)

void DocumentOpened(INT64 hPDFDocument); (ActiveX)

hPDFDocument:PDFDocumentのハンドル

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

5.6.122. PageTurnedイベント

void PageTurned(int32 pageNo); (.NET)

void PageTurned(long pageNo); (ActiveX)

pageNo:ページ番号

解説:現在のページ番号が変更になったときに発行されます。

5.6.123. Zoomイベント

void Zoom(float32 ratio); (.NET)

void Zoom(single ratio); (ActiveX)

ratio:ズーム倍率

解説:ズーム倍率が変更になったときに発行されます。

5.6.124. DragDropFilesイベント

int32 DragDropFiles(BSTR[] files); (.NET)

void DragDropFiles(BSTR[] files, long* ret); (ActiveX)

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

ret(ActiveX) : デフォルトの動作(files[0]を開く)を実行する場合は0以外をセットします。 0をセットするとデフォルト動作をおこないません。

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

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

5.6.125. ObjectAddedイベント

void ObjectAdded(string objectId); (.NET)

void ObjectAdded(BSTR objectId); (ActiveX)

objectId:追加されたオブジェクトのUUID

解説:オブジェクト挿入直後に発行されます。必要ならここで選択モードを元に戻すなどします。

5.6.126. DoActionイベント

int32 DoAction(AvsDotNetGuiCtl.AvsActionType actionType, string data); (.NET)

void DoAction(AVSACTIVEXCTLLib.AvsActionType actionType, BSTR data, long* ret); (ActiveX)

戻り値 (.NET):アクションを実行する場合は1を返します。 0を返すとアクションの実行を中止します。

actionType:アクションの種類

AvsActionType

説明

AGAT_GOTO

1

現在のドキュメント

AGAT_GOTOR

2

他のドキュメント

AGAT_LAUNCH

4

他のファイルを開く

AGAT_URI

6

WebブラウザでURLを開く

AGAT_INTERNALFILE

1000

添付ファイル注釈のファイルを開く

data:表示しようとしているファイル名、URLが入ります。

ret (ActiveX) : アクションを実行する場合は1をセットします。 0をセットするとアクションの実行を中止します。

解説:アクション実行時、添付ファイル注釈のファイルを開くときに発行されます。ファイルを開くときに警告メッセージを表示するためなどに使用します。

5.6.127. DefaultObjectPropertyChangedイベント

void DefaultObjectPropertyChanged(AvsDotNetGuiCtl.AvsSelectMode type); (.NET)

void DefaultObjectPropertyChanged(AVSACTIVEXCTLLib.AvsSelectMode type ); (ActiveX)

type:設定するオブジェクトタイプ。ASM_INS_STICKYNOTE~ASM_INS_SQUIGGLYの間で指定します。※SetDefaultObjectProperty参照

解説:オブジェクトの右クリックメニューから「現在のプロパティをデフォルトとして使用」が選ばれデフォルトのオブジェクトプロパティが変更されたときに発行されます。

デフォルトプロパティをファイル等に保存する処理をおこないたい場合にこのイベントをハンドリングしてください。

5.6.128. MouseDownCイベント

int32 MouseDownC(AvsDotNetGuiCtl.AvsMouseBtnType btnType, long nFlags ,

System.Drawing.Point point); (.NET)

void MouseDownC(AVSACTIVEXCTLLib.AvsMouseBtnType btnType, long nFlags,

long x, long y, long* ret); (ActiveX)

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

btnType:マウスボタンの種類

AvsMouseBtnType

説明

AMBT_LBUTTON

0

左ボタン

AMBT_RBUTTON

1

右ボタン

AMBT_MBUTTON

2

中央ボタン

nFlags:未使用です。

point (.NET):カーソル位置のクライアント座標が入ります。

x (ActiveX):カーソル位置のクライアントX座標が入ります。

y (ActiveX):カーソル位置のクライアントY座標が入ります。

ret (ActiveX) : コントロールのデフォルト処理を実行する場合は1をセットします。 0をセットするとデフォルト処理をおこないません。

解説:マウスボタンが押されたときに発行されます。

5.6.129. MouseUpCイベント

int32 MouseUpC(AvsDotNetGuiCtl.AvsMouseBtnType btnType, long nFlags ,

System.Drawing.Point point); (.NET)

void MouseUpC(AVSACTIVEXCTLLib.AvsMouseBtnType btnType, long nFlags,

long x, long y, long* ret); (ActiveX)

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

btnType:マウスボタンの種類 AvsMouseBtnType参照。

nFlags:未使用です。

point (.NET):カーソル位置のクライアント座標が入ります。

x (ActiveX):カーソル位置のクライアントX座標が入ります。

y (ActiveX):カーソル位置のクライアントY座標が入ります。

ret (ActiveX) : コントロールのデフォルト処理を実行する場合は1をセットします。 0をセットするとデフォルト処理をおこないません。

解説:マウスボタンが離されたときに発行されます。

5.6.130. DoubleClickCイベント

int32 DoubleClickC(AvsDotNetGuiCtl.AvsMouseBtnType btnType, long nFlags ,

System.Drawing.Point point); (.NET)

void DoubleClickC(AVSACTIVEXCTLLib.AvsMouseBtnType btnType, long nFlags,

long x, long y, long* ret); (ActiveX)

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

btnType:マウスボタンの種類 AvsMouseBtnType参照。

nFlags:未使用です。

point (.NET):カーソル位置のクライアント座標が入ります。

x (ActiveX):カーソル位置のクライアントX座標が入ります。

y (ActiveX):カーソル位置のクライアントY座標が入ります。

ret (ActiveX) : コントロールのデフォルト処理を実行する場合は1をセットします。 0をセットするとデフォルト処理をおこないません。

解説:ダブルクリックされたときに発行されます。

5.6.131. MouseMoveCイベント

int32 MouseMoveC(long nFlags , System.Drawing.Point point); (.NET)

void MouseMoveC(long nFlags, long x, long y, long* ret); (ActiveX)

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

nFlags:未使用です。

point (.NET):カーソル位置のクライアント座標が入ります。

x (ActiveX):カーソル位置のクライアントX座標が入ります。

y (ActiveX):カーソル位置のクライアントY座標が入ります。

ret (ActiveX) : コントロールのデフォルト処理を実行する場合は1をセットします。 0をセットするとデフォルト処理をおこないません。

解説:マウスカーソルが移動したときに発行されます。

5.6.132. ContextMenuCイベント

int32 ContextMenuC(System.Drawing.Point point); (.NET)

void ContextMenuC(long x, long y, long* ret); (ActiveX)

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

point (.NET):カーソル位置のクライアント座標が入ります。

x (ActiveX):カーソル位置のクライアントX座標が入ります。

y (ActiveX):カーソル位置のクライアントY座標が入ります。

ret (ActiveX) : コントロールのデフォルト処理を実行する場合は1をセットします。 0をセットするとデフォルト処理をおこないません。

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

5.6.133. KeyDownCイベント

int32 KeyDownC(long nChar ); (.NET)

void KeyDownC( long nChar, long* ret); (ActiveX)

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

nChar:押されたキーの仮想キーコードです。

ret (ActiveX) : コントロールのデフォルト処理を実行する場合は1をセットします。 0をセットするとデフォルト処理をおこないません。

解説:キーが押されたときに発行されます。

5.6.134. KeyUpCイベント

int32 KeyUpC(long nChar ); (.NET)

void KeyUpC(long nChar, long* ret); (ActiveX)

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

nChar:離されたキーの仮想キーコードです。

ret (ActiveX) : コントロールのデフォルト処理を実行する場合は1をセットします。 0をセットするとデフォルト処理をおこないません。

解説:キーが離されたときに発行されます。

5.6.135. ObjectDeletedイベント

void ObjectDeleted(string objectId); (.NET)

objectId:削除されたオブジェクトのUUID

解説:オブジェクト削除直後に発行されます。この時点でオブジェクトは存在しないので、objectIdをキーにしてオブジェクトの情報を取得する事はできません。

5.6.136. ObjectResizedイベント

void ObjectResized(string objectId); (.NET)

objectId:リサイズされたオブジェクトのUUID

解説:オブジェクトがリサイズされると発行されます。引き出し線注釈の矢印部分や、多角形注釈の点など端点の移動でも発行されます。

5.6.137. ObjectMovedイベント

void ObjectMoved(string objectId); (.NET)

objectId:移動されたオブジェクトのUUID

解説:オブジェクトが移動されると発行されます。

5.6.138. EditBoxShowedイベント

void EditBoxShowed(bool showed, string objectId); (.NET)

showed: true テキスト入力ボックス表示、 false テキスト入力ボックス非表示

objectId:オブジェクトのUUID

解説:テキスト入力ボックスが表示/非表示となると発行されます。objectIdはテキスト入力が開始または終了されたテキストボックス等の注釈のIDです。

5.6.139. EditBoxTextEditedイベント

void EditBoxTextEdited(string objectId); (.NET)

objectId:オブジェクトのUUID

解説:テキスト入力ボックスのテキストが編集されると発行されます。