Copyright © 2021 by K4.org
  (v.0.48.124)

When activated, this creates a new model rule and adds to the model tree. To add child rules, use UIAddModelButton.

Index

Rules

controlType

controlType: String

Internal Use Only.

Flags : Cached (Note this is uncached)

Expression : "AddModelRuleButton"

dataType

dataType: String

The dataType of the rule.

Flags : Cached, Parameter (Note this is uncached)

Expression : "Number"

flags

flags: Array

The rule flags to be set on the rule.

Flags : Cached, Parameter (Note this is uncached)

Expression : ["Cached"]

instantUpdate

instantUpdate: Boolean

If true, bypasses the normal "update on OK" behavior of UIForm, and will update the UI as soon as a change is made.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

ownerRefChain

ownerRefChain: String

The reference chain to the owner of the new rule.

Flags : Cached, Required, Parameter, Spec (Note this is uncached)

Expression : ``

ruleBody

ruleBody: String

This must be a string containing the body of the rule. So if you want the rule be some expression, you need to put the expression in quotes. If you want the rule to return a string, your expression should return a string, but it still must be in quotes, because it is the contents of the body string that is evaluated. You can use single quotes inside of double quotes to keep the outer and inner strings clear.

Flags : Cached, Parameter (Note this is uncached)

Expression : "0"

example

"42" // will return the number 42 when evaluated

example

"'My String'" // will return the string "My String" when evaluated

ruleDefinition

ruleDefinition: Any

This is the complete rule definition for the new rule. It can be provided directly, or collected from the other parameters.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : { name: this.ruleName, body: this.ruleBody, dataType: this.dataType, flags: this.flags }

ruleName

ruleName: String

The name of the new rule. Note that if this name is the same as an existing rule (on the same parent), this new rule will replace the existing rule. It is up to the rule author to ensure that names are unique.

Flags : Cached, Required, Parameter (Note this is uncached)

Expression : ``