ITextEditorEvents インターフェイスの OnActivePageChanging メソッド

このメソッドはクライアント側で実装されます。Text Editor でアクティブ ページが切り替わる前に、ABBYY FineReader Engine によって呼び出されます。この処理は、Text Editor または同期されている任意のコンポーネントのグラフィカル ユーザー インターフェイスからページが変更された場合に実行されます。Text Editor の API を介してアクティブ ページが変更された場合、またはアクティブ ページが削除された場合、この処理は実行されません。

このメソッドは、新たにアクティブになるページへの参照をクライアントに渡します。このメソッドを使用すると、この操作をキャンセルできます。

​

構文

​

C++

HRESULT OnActivePageChanging(
  IFRPage*      Page,
  VARIANT_BOOL* Cancel
);

​

C#

void OnActivePageChanging(
  IFRPage   Page,
  out bool Cancel
);

​

Visual Basic .NET

Sub OnActivePageChanging( _
  Page As IFRPage, _
  ByRef Cancel As Boolean _
)

​

パラメーター

Page

[in] 新しいアクティブページを含む FRPage オブジェクトを参照します。このパラメーターには NULL を指定することもできます。これは、ドキュメント内にアクティブページが存在しないことを意味します (たとえば、すべてのページが削除されている場合) 。

Cancel

[out] プロセスを終了する必要があることを示すには、この変数を TRUE に設定します。この場合、アクティブページは変更されません。

​

戻り値

[C++ のみ] このメソッドが S_OK 以外の値を返した場合、クライアント側でエラーが発生したことを示します。この場合、Cancel パラメーターの値は無視されます。

​

注記

このメソッドのクライアント実装では、メソッド内でスローされるすべての例外を必ずキャッチして処理し、例外がメソッドの外に伝播しないようにする必要があります。例外がメソッドの外に伝播すると、予期しない結果 (プログラムの終了など) を招くおそれがあります。

​

関連項目

ITextEditorEvents