This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%ZEN.Report.Display.item

class %ZEN.Report.Display.item extends %ZEN.Report.Display.childrenNode, %ZEN.Report.Display.tableOutput

This tag is the basic tag for displaying hard-coded values and data returned by the report.

Property Inventory

Method Inventory

Parameters

parameter DOMAIN = %ZEN;

Properties

property appendToZenLastPage as %ZEN.Datatype.string;

If the appendToLastPage attribute and special attribute are defined, the string value will be appended to the end of the %ZENLastPage string to allow the special featues reference a page-number-citation ref-id that was generate by a with the appendIdToLastPage attribue set to "true"

Property methods: appendToZenLastPageDisplayToLogical(), appendToZenLastPageGet(), appendToZenLastPageIsValid(), appendToZenLastPageLogicalToDisplay(), appendToZenLastPageLogicalToOdbc(), appendToZenLastPageNormalize(), appendToZenLastPageSet()
property breakOnLineFeed as %ZEN.Datatype.boolean;
Preserve linefeed in data
Property methods: breakOnLineFeedDisplayToLogical(), breakOnLineFeedGet(), breakOnLineFeedIsValid(), breakOnLineFeedLogicalToDisplay(), breakOnLineFeedLogicalToOdbc(), breakOnLineFeedLogicalToXSD(), breakOnLineFeedNormalize(), breakOnLineFeedSet(), breakOnLineFeedXSDToLogical()
property call as %ZEN.Datatype.string;
call - name of xsl:template to call when call is defined
Property methods: callDisplayToLogical(), callGet(), callIsValid(), callLogicalToDisplay(), callLogicalToOdbc(), callNormalize(), callSet()
property copyhtml as %ZEN.Datatype.boolean;
the item's field is well-formed html and should either be copied as html or transformed to XSL-FO
Property methods: copyhtml86DisplayToLogical(), copyhtml86Get(), copyhtml86IsValid(), copyhtml86LogicalToDisplay(), copyhtml86LogicalToOdbc(), copyhtml86LogicalToXSD(), copyhtml86Normalize(), copyhtml86Set(), copyhtml86XSDToLogical(), copyhtmlDisplayToLogical(), copyhtmlGet(), copyhtmlIsValid(), copyhtmlLogicalToDisplay(), copyhtmlLogicalToOdbc(), copyhtmlLogicalToXSD(), copyhtmlNormalize(), copyhtmlSet(), copyhtmlXSDToLogical()
property copyhtml86 as %ZEN.Datatype.boolean;
the item's field is well-formed html and should either be copied as html or transformed to XSL-FO
Property methods: copyhtml86DisplayToLogical(), copyhtml86Get(), copyhtml86IsValid(), copyhtml86LogicalToDisplay(), copyhtml86LogicalToOdbc(), copyhtml86LogicalToXSD(), copyhtml86Normalize(), copyhtml86Set(), copyhtml86XSDToLogical()
property copyxml as %ZEN.Datatype.boolean;
the item's field is xml and should be copied to the output
Property methods: copyxmlDisplayToLogical(), copyxmlGet(), copyxmlIsValid(), copyxmlLogicalToDisplay(), copyxmlLogicalToOdbc(), copyxmlLogicalToXSD(), copyxmlNormalize(), copyxmlSet(), copyxmlXSDToLogical()
property createtable as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
the item's field is well-formed xml and defines a DeepSee table in canoncial format
Property methods: createtableDisplayToLogical(), createtableGet(), createtableIsValid(), createtableLogicalToDisplay(), createtableLogicalToOdbc(), createtableLogicalToXSD(), createtableNormalize(), createtableSet(), createtableXSDToLogical()
property displayCaption as %ZEN.Datatype.boolean;
If displayCaption is 1 we display the caption of the item when the item is rendered
Property methods: displayCaptionDisplayToLogical(), displayCaptionGet(), displayCaptionIsValid(), displayCaptionLogicalToDisplay(), displayCaptionLogicalToOdbc(), displayCaptionLogicalToXSD(), displayCaptionNormalize(), displayCaptionSet(), displayCaptionXSDToLogical()
property excelFormula as %ZEN.Datatype.string;
excel formula function
Property methods: excelFormulaDisplayToLogical(), excelFormulaGet(), excelFormulaIsValid(), excelFormulaLogicalToDisplay(), excelFormulaLogicalToOdbc(), excelFormulaNormalize(), excelFormulaSet()
property excelName as %ZEN.Datatype.string;
column name instead of default which is fieldName
Property methods: excelNameDisplayToLogical(), excelNameGet(), excelNameIsValid(), excelNameLogicalToDisplay(), excelNameLogicalToOdbc(), excelNameNormalize(), excelNameSet()
property excelNumberFormat as %ZEN.Datatype.string;
if non-null is display number format of element value, only effective when mode="displayxlsx"
Property methods: excelNumberFormatDisplayToLogical(), excelNumberFormatGet(), excelNumberFormatIsValid(), excelNumberFormatLogicalToDisplay(), excelNumberFormatLogicalToOdbc(), excelNumberFormatNormalize(), excelNumberFormatSet()
property expression as %ZEN.Datatype.string;
expression that will be evaluated and put in output if "if" condition is true
Property methods: expressionDisplayToLogical(), expressionGet(), expressionIsValid(), expressionLogicalToDisplay(), expressionLogicalToOdbc(), expressionNormalize(), expressionSet()
property field as %ZEN.Datatype.string;
If the field attribute is specified, the <item> renders the value of that field in the XML data. Note: field is actually used as an XPath expression, so if you have the data:

<record id='1'><customer>MegaPlex Systems</customer></record>

one would obtain the value of the id attribute with the XPath expression '@id', whereas to obtain the value of the child element customer one would use the XPath expression 'customer'.
Property methods: fieldDisplayToLogical(), fieldGet(), fieldIsValid(), fieldLogicalToDisplay(), fieldLogicalToOdbc(), fieldNormalize(), fieldSet(), fieldnameDisplayToLogical(), fieldnameGet(), fieldnameIsValid(), fieldnameLogicalToDisplay(), fieldnameLogicalToOdbc(), fieldnameNormalize(), fieldnameSet(), fieldnumDisplayToLogical(), fieldnumGet(), fieldnumIsValid(), fieldnumLogicalToDisplay(), fieldnumLogicalToOdbc(), fieldnumNormalize(), fieldnumSet()
property fieldname as %ZEN.Datatype.string;
When table uses sql, fieldname when non-null is name of field in sql
Property methods: fieldnameDisplayToLogical(), fieldnameGet(), fieldnameIsValid(), fieldnameLogicalToDisplay(), fieldnameLogicalToOdbc(), fieldnameNormalize(), fieldnameSet()
property fieldnum as %ZEN.Datatype.integer;
When table uses sql, fieldnum when non-null is number of field in sql
Property methods: fieldnumDisplayToLogical(), fieldnumGet(), fieldnumIsValid(), fieldnumLogicalToDisplay(), fieldnumLogicalToOdbc(), fieldnumNormalize(), fieldnumSet()
property formatNumber as %ZEN.Datatype.string;
Optional formatting string for a numeric output.
Number formats are specified in the format required for the XPath format-number function.
Property methods: formatNumberDisplayToLogical(), formatNumberGet(), formatNumberIsValid(), formatNumberLogicalToDisplay(), formatNumberLogicalToOdbc(), formatNumberNormalize(), formatNumberSet()
property group as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: groupDisplayToLogical(), groupGet(), groupIsValid(), groupLogicalToDisplay(), groupLogicalToOdbc(), groupNormalize(), groupSet(), grouppathDisplayToLogical(), grouppathGet(), grouppathIsValid(), grouppathLogicalToDisplay(), grouppathLogicalToOdbc(), grouppathNormalize(), grouppathSet()
property if as %ZEN.Datatype.string [ InitialExpression = "1" ];
if expression that controls output of expression
Property methods: ifDisplayToLogical(), ifGet(), ifIsValid(), ifLogicalToDisplay(), ifLogicalToOdbc(), ifNormalize(), ifSet(), ifexpressionDisplayToLogical(), ifexpressionGet(), ifexpressionIsValid(), ifexpressionLogicalToDisplay(), ifexpressionLogicalToOdbc(), ifexpressionNormalize(), ifexpressionSet(), ifxpathDisplayToLogical(), ifxpathGet(), ifxpathIsValid(), ifxpathLogicalToDisplay(), ifxpathLogicalToOdbc(), ifxpathNormalize(), ifxpathSet()
property indicateDestination as %ZEN.Datatype.string (XMLNAME = "indicate-destination") [ InitialExpression = "false" ];
indicate-destination attribute of fo:basic-link
Property methods: indicateDestinationDisplayToLogical(), indicateDestinationGet(), indicateDestinationIsValid(), indicateDestinationLogicalToDisplay(), indicateDestinationLogicalToOdbc(), indicateDestinationNormalize(), indicateDestinationSet()
property insertZeroWidthSpaces as %ZEN.Datatype.boolean (XMLNAME = "insert-zero-width-spaces");
Insert zero-width spaces after characters. This allows field to wrap when in too short a column
Property methods: insertZeroWidthSpacesDisplayToLogical(), insertZeroWidthSpacesGet(), insertZeroWidthSpacesIsValid(), insertZeroWidthSpacesLogicalToDisplay(), insertZeroWidthSpacesLogicalToOdbc(), insertZeroWidthSpacesLogicalToXSD(), insertZeroWidthSpacesNormalize(), insertZeroWidthSpacesSet(), insertZeroWidthSpacesXSDToLogical()
property isExcelAggregate as %ZEN.Datatype.boolean;
identifies this item as an excel Aggregate. Note that AGGREGATETAG parameter must be set in report for aggregate to appear!
Property methods: isExcelAggregateDisplayToLogical(), isExcelAggregateGet(), isExcelAggregateIsValid(), isExcelAggregateLogicalToDisplay(), isExcelAggregateLogicalToOdbc(), isExcelAggregateLogicalToXSD(), isExcelAggregateNormalize(), isExcelAggregateSet(), isExcelAggregateXSDToLogical()
property isExcelDate as %ZEN.Datatype.boolean;
True if Excel date field
Property methods: isExcelDateDisplayToLogical(), isExcelDateGet(), isExcelDateIsValid(), isExcelDateLogicalToDisplay(), isExcelDateLogicalToOdbc(), isExcelDateLogicalToXSD(), isExcelDateNormalize(), isExcelDateSet(), isExcelDateXSDToLogical()
property isExcelNumber as %ZEN.Datatype.boolean;
True if Excel numeric field
Property methods: isExcelNumberDisplayToLogical(), isExcelNumberGet(), isExcelNumberIsValid(), isExcelNumberLogicalToDisplay(), isExcelNumberLogicalToOdbc(), isExcelNumberLogicalToXSD(), isExcelNumberNormalize(), isExcelNumberSet(), isExcelNumberXSDToLogical()
property isExcelTime as %ZEN.Datatype.boolean;
True if Excel time field
Property methods: isExcelTimeDisplayToLogical(), isExcelTimeGet(), isExcelTimeIsValid(), isExcelTimeLogicalToDisplay(), isExcelTimeLogicalToOdbc(), isExcelTimeLogicalToXSD(), isExcelTimeNormalize(), isExcelTimeSet(), isExcelTimeXSDToLogical()
Optional hyperlink to place around the item's data.
If the link attribute begins with an exclamation point, it is interpreted as an XPath expression just as in the field attribute. This allows you to dynamically generate URLs within the XML data, and then use these customized URLs in the display.
Property methods: linkDisplayToLogical(), linkGet(), linkIsValid(), linkLogicalToDisplay(), linkLogicalToOdbc(), linkNormalize(), linkSet()
property literalSpaces as %ZEN.Datatype.boolean;
Preserve spaces in data
Property methods: literalSpacesDisplayToLogical(), literalSpacesGet(), literalSpacesIsValid(), literalSpacesLogicalToDisplay(), literalSpacesLogicalToOdbc(), literalSpacesLogicalToXSD(), literalSpacesNormalize(), literalSpacesSet(), literalSpacesXSDToLogical()
property multiline as %ZEN.Datatype.boolean;
For multi-line caption
Property methods: multilineDisplayToLogical(), multilineGet(), multilineIsValid(), multilineLogicalToDisplay(), multilineLogicalToOdbc(), multilineLogicalToXSD(), multilineNormalize(), multilineSet(), multilineXSDToLogical()
property ofString as %ZEN.Datatype.caption [ InitialExpression = " of " ];
Property methods: ofStringDisplayToLogical(), ofStringGet(), ofStringIsValid(), ofStringLogicalToDisplay(), ofStringLogicalToOdbc(), ofStringNormalize(), ofStringSet()
property paramNames as %ZEN.Datatype.list (DELIMITER = ";");
for each name here an xsl:with-param is generated with its name attribute set from here
Property methods: paramNamesDisplayToLogical(), paramNamesGet(), paramNamesIsValid(), paramNamesLogicalToDisplay(), paramNamesLogicalToOdbc(), paramNamesNormalize(), paramNamesSet()
property params as %ZEN.Datatype.list (DELIMITER = ";");
list of xpaths, xpath function calls, and XSLT function calls. for each string here an xsl:with-param is generated with its select attribute set from here
Property methods: paramsDisplayToLogical(), paramsGet(), paramsIsValid(), paramsLogicalToDisplay(), paramsLogicalToOdbc(), paramsNormalize(), paramsSet()
property placeholder as %ZEN.Datatype.boolean;
placeholder marks an aggregate as a placeholder used for alignment
Property methods: placeholderDisplayToLogical(), placeholderGet(), placeholderIsValid(), placeholderLogicalToDisplay(), placeholderLogicalToOdbc(), placeholderLogicalToXSD(), placeholderNormalize(), placeholderSet(), placeholderXSDToLogical()
property removeEmpty as %ZEN.Datatype.boolean (XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
Property methods: removeEmptyDisplayToLogical(), removeEmptyGet(), removeEmptyIsValid(), removeEmptyLogicalToDisplay(), removeEmptyLogicalToOdbc(), removeEmptyLogicalToXSD(), removeEmptyNormalize(), removeEmptySet(), removeEmptyXSDToLogical()
property reverse as %ZEN.Datatype.boolean;
reverse string in XSL-FO mode
Property methods: reverseDisplayToLogical(), reverseGet(), reverseIsValid(), reverseLogicalToDisplay(), reverseLogicalToOdbc(), reverseLogicalToXSD(), reverseNormalize(), reverseSet(), reverseXSDToLogical()
property showDestination as %ZEN.Datatype.string (XMLNAME = "show-destination") [ InitialExpression = "replace" ];
show-destination attribute of fo:basic-link
Property methods: showDestinationDisplayToLogical(), showDestinationGet(), showDestinationIsValid(), showDestinationLogicalToDisplay(), showDestinationLogicalToOdbc(), showDestinationNormalize(), showDestinationSet()
property special as %ZEN.Datatype.string (VALUELIST = ",number,page-count,page-number,page-number-of,page-number-/,page-count-with-xpath,page-number-of-with-xpath,page-number-/-with-xpath");

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 suppressDuplicates as %ZEN.Datatype.boolean;
If suppressDuplicates is 1 then an item that matches previous item is displayed as empty
Property methods: suppressDuplicatesDisplayToLogical(), suppressDuplicatesGet(), suppressDuplicatesIsValid(), suppressDuplicatesLogicalToDisplay(), suppressDuplicatesLogicalToOdbc(), suppressDuplicatesLogicalToXSD(), suppressDuplicatesNormalize(), suppressDuplicatesSet(), suppressDuplicatesXSDToLogical()
property suppressEmpty as %ZEN.Datatype.boolean;
If suppressEmpty is 1 we suppress the rendering of the item and any following break if it is empty
Property methods: suppressEmptyDisplayToLogical(), suppressEmptyGet(), suppressEmptyIsValid(), suppressEmptyLogicalToDisplay(), suppressEmptyLogicalToOdbc(), suppressEmptyLogicalToXSD(), suppressEmptyNormalize(), suppressEmptySet(), suppressEmptyXSDToLogical()
property value as %ZEN.Datatype.caption;
If the value attribute is specified, the <item> renders that as a literal value.
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()
property xmlname as %ZEN.Datatype.string;
xmlname - used to output item as having the specified xmlname when drawing to annotated xml for Excel
Property methods: xmlnameDisplayToLogical(), xmlnameGet(), xmlnameIsValid(), xmlnameLogicalToDisplay(), xmlnameLogicalToOdbc(), xmlnameNormalize(), xmlnameSet(), xmlnamespaceDisplayToLogical(), xmlnamespaceGet(), xmlnamespaceIsValid(), xmlnamespaceLogicalToDisplay(), xmlnamespaceLogicalToOdbc(), xmlnamespaceNormalize(), xmlnamespaceSet(), xmlnamespaceprefixDisplayToLogical(), xmlnamespaceprefixGet(), xmlnamespaceprefixIsValid(), xmlnamespaceprefixLogicalToDisplay(), xmlnamespaceprefixLogicalToOdbc(), xmlnamespaceprefixNormalize(), xmlnamespaceprefixSet()

Methods

method %DrawToAnnotatedXML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream) as %Status
This method outputs the stylesheet that converts the input xml to the xml with Excel annotations report, table and item should override this method. Nested tables not supported.
method %DrawToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, incell As %Boolean = 0) as %Status
Inherited description: This method outputs the necessary stylesheet information for the HTML report. Every tag should override this method.
method %DrawToXSLFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, ByRef incell As %Boolean = 0) as %Status
Inherited description: This method outputs the necessary stylesheet information for the PDF report. Every tag should override this method.
method FInsertZeroWidthSpaces(currValue As %String)
method TransformToFO(currValue As %String)
method TransformToHTML(currValue As %String)

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

Feedback