IRuleContext

IRuleContext は FlexiCapture のルールスクリプト用のコンテキストオブジェクトで、文書、ルールの field、キャッシュされたデータセット、チェック結果にアクセスできます。

​

機能

ルールのコンテキストオブジェクトです。ルールが作成された階層のオブジェクトを表します。

このオブジェクトは、ルールのコンテキスト field へのアクセスを提供することで IField インターフェイスを実装しており、さらに追加のメソッドも備えています。

​

メソッド

定義	説明
DataSet ( dataSetName : string ) : IDataSet	キャッシュされたデータセットにアクセスします。返される IDataSet は読み取り専用です。

​

プロパティ

名前	型	アクセス	説明
CheckSucceeded	bool	読み取り/書き込み、変更可能 (読み取り専用権限のあるスクリプトでも変更できます)	チェックが成功したかどうかを指定します
Document	IDocument	読み取り専用	Documentにアクセスします
ErrorMessage	string	読み取り/書き込み、変更可能 (読み取り専用権限のあるスクリプトでも変更できます)	ルールエラーに関するメッセージです
Fields	IFields	読み取り専用	ルール内のfieldのコレクションです。ルール設定で指定します。
FocusedField	IField	読み取り/書き込み、変更可能 (読み取り専用権限のあるスクリプトでも変更できます)	ルールエラーをクリックしたときにフォーカスされるfield (ルールエラーの原因となったfield) です。
FocusRect	IRect	読み取り専用	実行されるアクションが参照する画面座標上の長方形 (ウィンドウの長方形) です。Custom Action スクリプトでのみ適用されます。
ParentWindow	int	読み取り専用	親ウィンドウのハンドルです。Custom Action スクリプトでのみ適用されます。