FOM Reference > Formatting > Datatypes > fRules interface
  
fRules interface
PI: tbcrules, tlctrl, tlpctrl, tlsctrl
This class represents a collection of rules and is used by objects such as fParagraph and fTableCell that support one or more rules.
rules attribute
This array contains the individual objects that make up this collection of rules.
Assigning a number that is less than the current length of the rules array to the property rules.length truncates the array accordingly. Assigning a number that is equal or greater than the current length to the property rules.length has no effect.
rules
Access
read-only
Returns
fRule[]
addRule method
Add a copy of the specified rule or a new, unitialised rule object to the rules array. The newly created fRule object is returned.
addRulerule
Parameters
fRulerule
The rule to be added to the set of rules.
Returns
fRule. The newly created rule or copy of the given rule object.
clearRules method
Removes all rules in an fRules-rules[] array
clearRules
Parameters
None
Returns
void. This method does not return a value.
removeRule method
Remove the specified rule object from the rules array. The rules following the removed rule in the rules array, if any, move up an index.
Another way to delete rules is by assigning to the length property of the rules array. See documentation for the property rules.
removeRulerule
Parameters
fRulerule
The rule object to be removed.
Returns
void. This method does not return a value.