MacroRuleTree Class

Represents a structure of of boolean expressions.

Inheritance Hierarchy

System.Object
  CMS.MacroEngine.MacroRuleTree

Namespace: CMS.MacroEngine
Assembly: CMS.MacroEngine (in CMS.MacroEngine.dll) Version: 13.0.131

Syntax

[SerializableAttribute]
public class MacroRuleTree

The MacroRuleTree type exposes the following members.

Constructors

	Name	Description
Public method	MacroRuleTree

Properties

	Name	Description
Public property	Children	Gets or sets the child rules.
Public property	HasPreviousSibling	Returns true if group has a previous sibling node.
Public property	IDPath	Returns IDPath of the group.
Public property	IsLeaf	Returns true if group is a leaf (expression).
Public property	Level	Returns level of the group.
Public property	Operator	Gets or sets operator of the rule.
Public property	Parameters	Gets or sets the parameters of the rule (null for internal nodes).
Public property	Parent	Gets or sets the parent.
Public property	Position	Gets or sets the relative position of the rule within the parent group.
Public property	RuleCondition	Gets or sets the associated rule K# condition.
Public property	RuleName	Gets or sets the associated rule name.
Public property	RuleParameters	Gets or sets the associated rule parameters xml definition.
Public property	RuleText	Gets or sets the associated rule text.

Methods

	Name	Description
Public method	Accept	Accepts an action that gets executed on the whole tree structure.
Public method	AddRule	Adds a new rule as a child of current node. Inserts the rule to the specified position.
Public method	AutoIndent	Performs the autoindentation of the expression (according to priority of 'or' and 'and' operators).
Public method	GetCondition	Returns the condition in K# representing this rule.
Public method Static member	GetParameterText	Processes the text of parameter (handles multivalue parameters separated with new line).
Public method	GetRoot	Returns the root of the rule tree.
Public method Static member	GetRuleCondition	Returns rule as a human readable sentence. If the expression is Rule(...) method than it uses XML for the rule, otherwise returns expression as it is.
Public method Static member	GetRuleText(MacroRuleTree, Boolean, Func<Object, Object>)	Returns rule as a human readable sentence.
Public method Static member	GetRuleText(String, Boolean, Boolean, Func<Object, Object>)	Returns rule as a human readable sentence. If the expression is Rule(...) method than it uses XML for the rule, otherwise returns expression as it is.
Public method	GetXML	Returns xml of the rule designer (to store the layout and parameters).
Protected method	GetXMLInternal	Returns xml of the rule designer (to store the layout and parameters).
Public method	Indent	Indents the node with one level.
Public method	LoadFromXml	Loads MacroRuleTree from xml definition.
Public method	MoveNode	Moves the group to given location.
Public method Static member	RemoveBrackets	Removes brackets which are not needed.
Public method	RemoveNode(Int32)	Adds given group as a new child.
Public method	RemoveNode(Int32, Boolean)	Adds given group as a new child.
Public method	ResetPositions	Sets correct positions according to current state.
Public method	SetParameterValue	Sets the parameter value.
Public method	Unindent	Unindents the node with one level.
Public method	ValidateParameters	Returns list of rules which contain required parameters with empty value.