asposediagram.api

asposediagram.api

Class Rule

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

Constructor Summary
Rule()
Constructor.
 
Property Getters/Setters Summary
methodgetCategory()
method
setCategory(value)
           Specifies the text displayed in the Category column of the Issues window. Default is an empty string.
methodgetDescription()
method
setDescription(value)
           the description of the validation rule that appears in the user interface. Default is "Unknown".
methodgetID()
method
setID(value)
           Specifies the unique identifier of the validation rule.
methodgetIgnored()
method
setIgnored(value)
           Specifies whether the validation rule is currently ignored. Default is False. The value of the property is BOOL integer constant.
methodgetNameU()
method
setNameU(value)
           Specifies the universal name of the validation rule.
methodgetRuleFilter()
method
setRuleFilter(value)
           Specifies the logical expression that determines whether the validation rule should be applied to a target object.
methodgetRuleTarget()
method
setRuleTarget(value)
           Specifies the type of object to which the validation rule applies. The value of the property is VisRuleTargetsValue integer constant.
methodgetRuleTest()
method
setRuleTest(value)
           Specifies the logical expression that determines whether the target object satisfies the validation rule
 

    • Constructor Detail

      • Rule

        Rule()
        Constructor.

    • Property Getters/Setters Detail

      • getRuleFilter/setRuleFilter : RuleValue 

        RuleValue getRuleFilter() / setRuleFilter(value)
        Specifies the logical expression that determines whether the validation rule should be applied to a target object.

      • getRuleTest/setRuleTest : RuleValue 

        RuleValue getRuleTest() / setRuleTest(value)
        Specifies the logical expression that determines whether the target object satisfies the validation rule

      • getID/setID : long 

        long getID() / setID(value)
        Specifies the unique identifier of the validation rule.

      • getNameU/setNameU : String 

        String getNameU() / setNameU(value)
        Specifies the universal name of the validation rule.

      • getCategory/setCategory : String 

        String getCategory() / setCategory(value)
        Specifies the text displayed in the Category column of the Issues window. Default is an empty string.

      • getDescription/setDescription : String 

        String getDescription() / setDescription(value)
        the description of the validation rule that appears in the user interface. Default is "Unknown".

      • getRuleTarget/setRuleTarget : int 

        int getRuleTarget() / setRuleTarget(value)
        Specifies the type of object to which the validation rule applies. The value of the property is VisRuleTargetsValue integer constant.

      • getIgnored/setIgnored : int 

        int getIgnored() / setIgnored(value)
        Specifies whether the validation rule is currently ignored. Default is False. The value of the property is BOOL integer constant.