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).

Home > Class Reference > %SYS namespace > %DeepSee.Report.Model.Item


class %DeepSee.Report.Model.Item extends %DeepSee.Report.Model.Stylable

This class is used by the DeepSee Report Generator.
It represents an item used in the Report Display, most commonly associated with tables.

Property Inventory


parameter XMLNAME = item;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.


property caption as %String (XMLPROJECTION = "attribute");
caption used in table
Property methods: captionDisplayToLogical(), captionGet(), captionIsValid(), captionLogicalToDisplay(), captionLogicalToOdbc(), captionNormalize(), captionSet()
property elements as list of Element (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE");
Set of captions, summaries within this item
Property methods: elementsBuildValueArray(), elementsCollectionToDisplay(), elementsCollectionToOdbc(), elementsDisplayToCollection(), elementsGet(), elementsGetObject(), elementsGetObjectId(), elementsGetSwizzled(), elementsIsValid(), elementsOdbcToCollection(), elementsSet(), elementsSetObject(), elementsSetObjectId()
property field as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Name of the field supplying data for this item.
Property methods: fieldDisplayToLogical(), fieldGet(), fieldIsValid(), fieldLogicalToDisplay(), fieldLogicalToOdbc(), fieldNormalize(), fieldSet()
property special as %String (XMLPROJECTION = "attribute");

If the special attribute is specified, the renders a pre-definied piece of dynamic data. Possible values are currently:

  • number : gives the record number within the group.
  • page-number : inserts the page number within a PDF report. Is rendered as '##' in HTML.
  • page-count : inserts the number of pages within a PDF report. It is rendered as '##' in HTML.
  • page-number-of : inserts the page number in the form '2 of 18'. It is rendered as '## of ##' in HTML.
  • page-number-/ : inserts the page number in the form '2/18'. It is rendered as '##/##' in HTML.
Property methods: specialDisplayToLogical(), specialGet(), specialIsValid(), specialLogicalToDisplay(), specialLogicalToOdbc(), specialNormalize(), specialSet()
property tagBegin as %String [ InitialExpression = "<item" ];
Property methods: tagBeginDisplayToLogical(), tagBeginGet(), tagBeginIsValid(), tagBeginLogicalToDisplay(), tagBeginLogicalToOdbc(), tagBeginNormalize(), tagBeginSet()
property tagEnd as %String [ InitialExpression = "</item>" ];
Property methods: tagEndDisplayToLogical(), tagEndGet(), tagEndIsValid(), tagEndLogicalToDisplay(), tagEndLogicalToOdbc(), tagEndNormalize(), tagEndSet()
property value as %String (XMLPROJECTION = "attribute");
literal for display
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()
property visible as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
if visible="false" then not included in display but included in Report Definition generated XML
Property methods: visibleDisplayToLogical(), visibleGet(), visibleIsValid(), visibleLogicalToDisplay(), visibleLogicalToXSD(), visibleNormalize(), visibleSet(), visibleXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods