CheckRulesResult Class

[This is preliminary documentation and is subject to change.]

This class summarizes the outcome when checking the rules on an entire tree of TmplItem inherited classes

Inheritance Hierarchy

SystemObject
CSC.SC.TOPICA4.TemplateCheckRulesResult

Namespace: CSC.SC.TOPICA4.Template
Assembly: CSC.SC.TOPICA4.Template (in CSC.SC.TOPICA4.Template.dll) Version: 4.30.6239.27196

Syntax

public class CheckRulesResult

The CheckRulesResult type exposes the following members.

Constructors

	Name	Description
	CheckRulesResult	Default constructor

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetFirstFailedFieldId	Get the id of the first failed template item field
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetFirstFailedFieldId	Get/Set id of first field which failed error checking. Set only has effect if field is not already set
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Properties

	Name	Description
	Completed	Is the form which we are checking the rules for completed? When any rule on a TmplItem derived class on the form creates error or warning message the form is not completed.
	Errors	Get/set error count
	Exceptions	Get/set exception count
	Informations	Get/set information count
	MessageCollection	A collection of messages reporting on the outcome of the rule checking (error, info, warning etc. texts)
	Warnings	Get/set warning count