RuleDisabled

Tinderbox Icon


Attribute Data Type:   boolean
Attribute Default Value:   false
Atrribute Group:   General
Atrribute Purpose:   Action code
Attribute Inherited from Preferences?     No
Attribute Read-Only?   No

New to v5.8.0, a Boolean attribute, $RuleDisabled, allows the rule for a specific note to be disabled. $RuleDisabled is inherent to a note. Atypically for inheritance in Tinderbox, it is not inherited from a note's prototype (unlike most other attributes) - partly because a primary use is suppressing code running in prototypes.

$RuleDisabled is convenient when a rule may make significant changes to the note (or other parts of the document). Setting such a rule via a prototype can be problematic as the intent is only to rule to rule in notes inheriting the rule. Thus it can be useful to suppress $Rule activation in prototypes. Previously, this meant placing the Rule in an 'if($Prototype)' test which was cumbersome and meant every inheriting note had to run the addition if test adding load to the action code cycle. That workaround can be discarded and the attribute set to false in the Prototype. Because, atypically, this attribute isn't inherited from a prototype, the prototype's setting doesn't affect the Display Expression in notes using the prototype.

A similar control is supplied for display expressions: $DisplayExpressionDisabled.


Possible relevant notes (via "Similar Notes" feature):

Up: Boolean Attributes

A Tinderbox Reference File : Attributes : Attribute Data Types : Boolean Attributes : RuleDisabled

Quicklinks: Attributes | Action Codes | Export Codes | Designators | Date Formats | aTbRef Site Map

[Last updated: 16 May 2012, using v5.11.1]


Search:

Google search aTbRef for:  


Creative Commons Licence

aTbRef by Mark Anderson is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.

[See aTbRef CC licence Attribution & Waiver info]

Made with Tinderbox