Skip to main content

What it does

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

DefinitionDescription
DataSet ( dataSetName : string ) : IDataSetAccesses the cached data set. The resulting IDataSet is available for reading only.

Properties

NameTypeAccessDescription
CheckSucceededboolRead/write, Mutable (can be modified even in scripts with read-only permissions)Specifies whether the check succeeded
DocumentIDocumentRead-onlyAccess to the document
ErrorMessagestringRead/write, Mutable (can be modified even in scripts with read-only permissions)A message concerning a rule error
FieldsIFieldsRead-onlyCollection of fields in the rule. Specified in rule settings.
FocusedFieldIFieldRead/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).
FocusRectIRectRead-onlyA rectangle in screen coordinates, the executed action refers to (a rectangle of the window). Applies in the Custom Action script only.
ParentWindowintRead-onlyA handle of the parent window. Applies in the Custom Action script only.