Rule

Rule class

Represents a single validation rule in a diagram validation rule set.

Constructors

NameDescription
RuleConstructor.

Properties

NameTypeDescription
RuleFilterRuleValueSpecifies the logical expression that determines whether the validation rule should be applied to a target object.
RuleTestRuleValueSpecifies the logical expression that determines whether the target object satisfies the validation rule
IDlongSpecifies the unique identifier of the validation rule.
NameUStringSpecifies the universal name of the validation rule.
CategoryStringSpecifies the text displayed in the Category column of the Issues window. Default is an empty string.
DescriptionStringthe description of the validation rule that appears in the user interface. Default is “Unknown”.
RuleTargetintSpecifies the type of object to which the validation rule applies. The value of the property is VisRuleTargetsValue inte
IgnoredintSpecifies whether the validation rule is currently ignored. Default is False. The value of the property is BOOL integer

Rule()

Constructor.

Rule.RuleFilter property

Specifies the logical expression that determines whether the validation rule should be applied to a target object.

Type: RuleValue

Rule.RuleTest property

Specifies the logical expression that determines whether the target object satisfies the validation rule

Type: RuleValue

Rule.ID property

Specifies the unique identifier of the validation rule.

Type: long

Rule.NameU property

Specifies the universal name of the validation rule.

Type: String

Rule.Category property

Specifies the text displayed in the Category column of the Issues window. Default is an empty string.

Type: String

Rule.Description property

the description of the validation rule that appears in the user interface. Default is “Unknown”.

Type: String

Rule.RuleTarget property

Specifies the type of object to which the validation rule applies. The value of the property is VisRuleTargetsValue integer constant.

Type: int

Rule.Ignored property

Specifies whether the validation rule is currently ignored. Default is False. The value of the property is BOOL integer constant.

Type: int