Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%ZEN] >  [Report] >  [Display] >  [item]
Private  Storage   

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

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 39 6


Summary

Properties
appendToZenLastPage applyLevel blockContainerProperty breakOnLineFeed
call caption children class
colcount colspan composite copyhtml
copyhtml86 copyxml createtable crosstabDataGroup
crosstabFooterDataField crosstabFooterFormatNumber crosstabFooterGroup crosstabHeaderDataField
crosstabHeaderGroup crosstabHeaderGroupLabels crosstabHeaderGroupTooLongText crosstabHeaderLabelDataField
crosstabHeaderMatchField crosstabRowGroup crosstabTruncationHeight crosstabTruncationWidth
displayCaption excelFormula excelName excelNumberFormat
expression field fieldname fieldnum
foblock formatNumber group grouppath
hasFooter hasHeader htmlstyle id
if ifexpression ifxpath includeBlockContainer
includeColIfExpression includeColIfXPath includeColUnlessExpression includeColUnlessXPath
indicateDestination insertZeroWidthSpaces isExcelAggregate isExcelDate
isExcelNumber isExcelTime level linefeedTreatment
link literalSpaces multiline ofString
paramNames params placeholder removeEmpty
reverse rowspan selectstylecond selectstylelist
showDestination special style stylecall
styleparamNames styleparams suppressDuplicates suppressEmpty
tag template tooLongText truncate
truncationHeight truncationWidth unlessexpression value
width withinSmallmultiple xmlname xmlnamespace
xmlnamespaceprefix xpath xslfostyle

Methods
%AddToSaveSet %ApplyClass %ApplyLevelParameters %BeginGroup
%BeginGroupNoInc %ClassIsLatestVersion %ClassName %ConstructClone
%DeclareLevelParameters %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawCellFO %DrawCellFO1 %DrawCellToHTML %DrawCellToHTML1
%DrawFooterFO %DrawFooterToAnnotatedXML %DrawFooterToHTML %DrawHeaderFO
%DrawHeaderToHTML %DrawSort %DrawStyleToHTML %DrawToAnnotatedXML
%DrawToHTML %DrawToXSLFO %EndGroup %EndLevel
%Extends %FooterWidth %GetAbsoluteURL %GetParameter
%HeaderWidth %IncLevel %IsA %IsModified
%New %NormalizeObject %ObjectModified %OldWidth
%OriginalNamespace %PackageName %QuoteValue %QuoteValueEmbedded
%QuoteValueL10N %RemoveFromSaveSet %SerializeObject %SetModified
%StyleHTML %StyleXSLFO %ValidateObject %Width
ApplyClass CSPLinkToFileLink CountSpaces DoDocForHTML
FInsertZeroWidthSpaces GetDocForXSLFO HTMLStyle OutputId
TransformToFO TransformToHTML XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType XSLFOStyle hasFooterGet
hasHeaderGet insertAxis isCSPLink needsURL
parent processExclamationPoint qualify tagGet

Subclasses
%ZEN.Report.Display.caption %ZEN.Report.Display.summary

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 breakOnLineFeed as %ZEN.Datatype.boolean;
Preserve linefeed in data
• property call as %ZEN.Datatype.string;
call - name of xsl:template to call when call is defined
• 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 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 copyxml as %ZEN.Datatype.boolean;
the item's field is xml and should be copied to the output
• 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 displayCaption as %ZEN.Datatype.boolean;
If displayCaption is 1 we display the caption of the item when the item is rendered
• property excelFormula as %ZEN.Datatype.string;
excel formula function
• property excelName as %ZEN.Datatype.string;
column name instead of default which is fieldName
• property excelNumberFormat as %ZEN.Datatype.string;
if non-null is display number format of element value, only effective when mode="displayxlsx"
• property expression as %ZEN.Datatype.string;
expression that will be evaluated and put in output if "if" condition is true
• 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 fieldname as %ZEN.Datatype.string;
When table uses sql, fieldname when non-null is name of field in sql
• property fieldnum as %ZEN.Datatype.integer;
When table uses sql, fieldnum when non-null is number of field in sql
• 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 group as %ZEN.Datatype.string(XMLPROJECTION="NONE");
• property if as %ZEN.Datatype.string [ InitialExpression = "1" ];
if expression that controls output of expression
• property indicateDestination as %ZEN.Datatype.string(XMLNAME="indicate-destination") [ InitialExpression = "false" ];
indicate-destination attribute of fo:basic-link
• 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 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 isExcelDate as %ZEN.Datatype.boolean;
True if Excel date field
• property isExcelNumber as %ZEN.Datatype.boolean;
True if Excel numeric field
• property isExcelTime as %ZEN.Datatype.boolean;
True if Excel time field
• property link as %ZEN.Datatype.string;
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 literalSpaces as %ZEN.Datatype.boolean;
Preserve spaces in data
• property multiline as %ZEN.Datatype.boolean;
For multi-line caption
• property ofString as %ZEN.Datatype.caption [ InitialExpression = " of " ];
Example: <item special="page-number-of" />.
This will give something like "1 of 9".
Example (z is of in Polish): <item special="page-number-of" ofString=" z " />.
This will give something like "1 z 9".
• 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 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 placeholder as %ZEN.Datatype.boolean;
placeholder marks an aggregate as a placeholder used for alignment
• property removeEmpty as %ZEN.Datatype.boolean(XMLPROJECTION="NONE") [ InitialExpression = 0 ];
• property reverse as %ZEN.Datatype.boolean;
reverse string in XSL-FO mode
• property showDestination as %ZEN.Datatype.string(XMLNAME="show-destination") [ InitialExpression = "replace" ];
show-destination attribute of fo:basic-link
• 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 suppressDuplicates as %ZEN.Datatype.boolean;
If suppressDuplicates is 1 then an item that matches previous item is displayed as empty
• 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 value as %ZEN.Datatype.caption;
If the value attribute is specified, the <item> renders that as a literal value.
• property xmlname as %ZEN.Datatype.string;
xmlname - used to output item as having the specified xmlname when drawing to annotated xml for Excel

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
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, ByRef ignoreId=0) as %Status
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)


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.