IRuleContext - ABBYY Documentation

A context object of rules. Represents the object, at whose level the rule was created. The object implements IField interface (by means of providing access to the context field of the rule) and also has additional methods.

Methods

Definition	Description
DataSet ( dataSetName : string ) : IDataSet	Accesses the cached data set. The resulting IDataSet is available for reading only.

Properties

Name	Type	Access	Description
CheckSucceeded	bool	Read/write, Mutable (can be modified even in scripts with read-only permissions)	Specifies whether the check succeeded.
Document	IDocument	Read-only	Access to the document.
ErrorMessage	string	Read/write, Mutable (can be modified even in scripts with read-only permissions)	A message concerning a rule error.
Fields	IFields	Read-only	Collection of fields in the rule. Specified in rule settings.
FocusedField	IField	Read/write, Mutable (can be modified even in scripts with read-only permissions)	The field to be focused when clicking a rule error (the field that caused a rule error).
FocusRect	IRect	Read-only	A rectangle in screen coordinates, the executed action refers to (a rectangle of the window). Applies in the Custom Action script only.
ParentWindow	int	Read-only	A handle of the parent window. Applies in the Custom Action script only.