Skip to main content

What it does

Represents a rule error, format error or merging error in the document. Note. Some methods and properties of this object are not available on the Web Verification Station for checking rules locally. The methods and properties that are not supported are marked with an asterisk (*).

Methods

DefinitionDescription
GetFields() : IFieldsReturns the fields associated with the given field error.

Properties

NameTypeAccessDescription
IsWarningboolRead-onlySpecifies whether the message is a warning.
MessagestringRead-onlyThe text of the error message.
RuleNamestringRead-onlyThe name of the rule that caused the error. For format and merging errors, an empty string is returned.
RuleTags *IRuleTagsRead-onlyReturns the IRuleTags object with rule tags.
TypeTRuleErrorTypeRead-onlyThe error type.