This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Caché & Ensemble 2018.1.5 > Class Reference > ENSLIB namespace > %CSP.RuleBlock


class %CSP.RuleBlock extends %CSP.Rule

The %CSP.RuleBlock class is the super class of all rule generated classes for block structured tags, e.g. csp:if, that represent elements within the DOM model.

Property Inventory

Method Inventory


property Container as %CSP.RuleBlock;
The object instance for the containing block or "".
Property methods: ContainerGet(), ContainerGetSwizzled(), ContainerIsValid(), ContainerNewObject(), ContainerSet()
property EndLabel as %String;
The label used for the end of this block, e.g. the /csp:if clause for csp:if or after the loop for csp:while
Property methods: EndLabelDisplayToLogical(), EndLabelGet(), EndLabelIsValid(), EndLabelLogicalToDisplay(), EndLabelLogicalToOdbc(), EndLabelNormalize(), EndLabelSet()
property NextLabel as %String;
The label used for the next block, e.g. the csp:else clause for csp:if or the next iteration for csp:while
Property methods: NextLabelDisplayToLogical(), NextLabelGet(), NextLabelIsValid(), NextLabelLogicalToDisplay(), NextLabelLogicalToOdbc(), NextLabelNormalize(), NextLabelSet()


method GetCurrentBlock() as %CSP.RuleBlock
Get current block without creating a new one.
method GetNewLabel() as %String
Get a new block label.
method NewBlock()
Get a new block and associated labels for this nested code block.
method RemoveBlock()
Remove the this nested block.

Inherited Members

Inherited Properties

Inherited Methods