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

deprecatedclass %ZEN.Report.Display.document extends childrenNode

The <document> tag is used at the top-level to specify dimensions and styling for the report. The dimensions only affect the PDF report.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
52 4


Summary

Properties
afterGeneralRegionAttributes applyLevel beforeGeneralRegionAttributes children
class columnCount columnGap composite
endGeneralRegionAttributes endSidebarLength footerHeight headerHeight
height htmlstyle id ifexpression
ifxpath includeColIfExpression includeColIfXPath includeColUnlessExpression
includeColUnlessXPath level margin marginBottom
marginLeft marginRight marginTop orientation
parent referenceOrientation regionAfter regionAfterColor
regionAfterDisplayAlign regionAfterExtent regionAfterName regionAfterOrientation
regionBefore regionBeforeColor regionBeforeDisplayAlign regionBeforeExtent
regionBeforeName regionBeforeOrientation regionEnd regionEndColor
regionEndDisplayAlign regionEndExtent regionEndName regionEndOrientation
regionStart regionStartColor regionStartDisplayAlign regionStartExtent
regionStartName regionStartOrientation selectstylecond selectstylelist
size startGeneralRegionAttributes startSidebarLength style
stylecall styleparamNames styleparams tag
template unlessexpression width withinSmallmultiple
writingMode writingModeRegionAfter writingModeRegionBefore writingModeRegionBody
writingModeRegionEnd writingModeRegionStart xmlnamespace xmlnamespaceprefix
xpath xslfostyle

Methods
%AddToSaveSet %ApplyClass %ApplyLevelParameters %ClassIsLatestVersion
%ClassName %ConstructClone %DeclareLevelParameters %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawPageToXSLFO %DrawStyleToHTML
%DrawStyleToXSLFO %DrawToAnnotatedXML %DrawToHTML %DrawToXSLFO
%EndLevel %Extends %GetAbsoluteURL %GetParameter
%IncLevel %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%QuoteValue %QuoteValueEmbedded %QuoteValueL10N %RemoveFromSaveSet
%SerializeObject %SetModified %StyleHTML %StyleXSLFO
%ValidateObject ApplyClass CSPLinkToFileLink CountSpaces
DoDocForHTML GetDocForXSLFO HTMLStyle OutputId
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
XSLFOStyle insertAxis isCSPLink needsURL
parent processExclamationPoint qualify tagGet
toMilimeters


Properties

• property afterGeneralRegionAttributes as %ZEN.Datatype.string;
This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote
• property beforeGeneralRegionAttributes as %ZEN.Datatype.string;
This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote
• property columnCount as %ZEN.Datatype.integer(XMLNAME="column-count");
specifies that the fo:region-body is multicolumn. The column-count property indicates the number of columns on every page instance formatted using the simple-page-master to which this region-body belongs.
• property columnGap as %ZEN.Datatype.length(XMLNAME="column-gap");
If column-count is greater than 1, a value may be specified for the column-gap property. The value is either an explicit length or a percentage of the inline-progression-dimension of the content rectangle of the region-body.
• property endGeneralRegionAttributes as %ZEN.Datatype.string;
This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote
• property endSidebarLength as %ZEN.Datatype.length [ InitialExpression = "0" ];
Specifies the amount of room available for the contents of the <endsidebar> tag.
• property footerHeight as %ZEN.Datatype.length [ InitialExpression = "0" ];
Specifies the amount of room available for the contents of the <pagefooter> tag.
• property headerHeight as %ZEN.Datatype.length [ InitialExpression = "0" ];
Specifies the amount of room available for the contents of the <pageheader> tag.
• property height as %ZEN.Datatype.length [ InitialExpression = "11in" ];
Specifies the height of the document.
• property ifexpression as %ZEN.Datatype.string(XMLPROJECTION="NONE");
• property ifxpath as %ZEN.Datatype.string(XMLPROJECTION="NONE");
• property margin as %ZEN.Datatype.string;
margin attribute on fo:simple-page-master
• property marginBottom as %ZEN.Datatype.length [ InitialExpression = "1in" ];
Specifies the bottom margin of the document. This does not include the space left for the footer.
• property marginLeft as %ZEN.Datatype.length [ InitialExpression = "1.25in" ];
Specifies the left margin width of the document.
• property marginRight as %ZEN.Datatype.length [ InitialExpression = "1.25in" ];
Specifies the right margin width of the document.
• property marginTop as %ZEN.Datatype.length [ InitialExpression = "1in" ];
Specifies the top margin of the document. This does not include the space left for the header.
• property orientation as %ZEN.Datatype.string(VALUELIST=",portrait,landscape,none") [ InitialExpression = "portrait" ];
extent property
• property referenceOrientation as %ZEN.Datatype.integer;
value of reference-orientation in XSL-FO region-body
• property regionAfter as %ZEN.Datatype.string;
Properties of fo:region-after
• property regionAfterColor as %ZEN.Datatype.string;
• property regionAfterDisplayAlign as %ZEN.Datatype.string [ InitialExpression = "after" ];
display-align property
• property regionAfterExtent as %ZEN.Datatype.string;
extent property
• property regionAfterName as %ZEN.Datatype.string;
• property regionAfterOrientation as %ZEN.Datatype.integer [ InitialExpression = 0 ];
orientation property
• property regionBefore as %ZEN.Datatype.string;
Properties of fo:region-before
• property regionBeforeColor as %ZEN.Datatype.string;
• property regionBeforeDisplayAlign as %ZEN.Datatype.string [ InitialExpression = "inherit" ];
display-align property
• property regionBeforeExtent as %ZEN.Datatype.string;
extent property
• property regionBeforeName as %ZEN.Datatype.string;
• property regionBeforeOrientation as %ZEN.Datatype.integer [ InitialExpression = 0 ];
orientation property
• property regionEnd as %ZEN.Datatype.string;
Properties of fo:region-end
• property regionEndColor as %ZEN.Datatype.string;
• property regionEndDisplayAlign as %ZEN.Datatype.string [ InitialExpression = "after" ];
display-align property
• property regionEndExtent as %ZEN.Datatype.string;
extent property
• property regionEndName as %ZEN.Datatype.string;
• property regionEndOrientation as %ZEN.Datatype.integer [ InitialExpression = 0 ];
orientation property
• property regionStart as %ZEN.Datatype.string;
Properties of fo:region-start
• property regionStartColor as %ZEN.Datatype.string;
• property regionStartDisplayAlign as %ZEN.Datatype.string [ InitialExpression = "inherit" ];
display-align property
• property regionStartExtent as %ZEN.Datatype.string;
extent property
• property regionStartName as %ZEN.Datatype.string;
extent property
• property regionStartOrientation as %ZEN.Datatype.integer [ InitialExpression = 0 ];
orientation property
• property size as %ZEN.Datatype.string;
size attribute on fo:simple-page-master
• property startGeneralRegionAttributes as %ZEN.Datatype.string;
This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote
• property startSidebarLength as %ZEN.Datatype.length [ InitialExpression = "0" ];
Specifies the amount of room available for the contents of the <pagestartsidebar> tag.
• property width as %ZEN.Datatype.length [ InitialExpression = "8.5in" ];
Specifies the width of the document.
• property writingMode as %ZEN.Datatype.string(VALUELIST=",lr-tb,rl-tb,tb-rl,lr,rl,tb,inherit",XMLNAME="writing-mode");
writing-mode XML attribute. It has the following possible values. Note that not all XSL-FO renderers will support all possible values.
lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
Note this places a writing-mode on fo:simple-page-master.
The semantics of writing-mode on simple-page-master differs from page-sequence. Specifically, on simple-page-master, it is used to interpret the meaning of before, after, start, end with respect to resolving the placement of page regions. However, it does not affect the writing-mode trait of reference areas generated by page-sequence. In the latter case, it is the writing-mode on page-sequence that counts.
To place a writing-mode on page-sequence use the writing-mode in the report or section element
• property writingModeRegionAfter as %ZEN.Datatype.string(VALUELIST=",lr-tb,rl-tb,tb-rl,lr,rl,tb,inherit",XMLNAME="writing-mode-region-after");
writing-mode XML attribute on the region-after. It has the following possible values. Note that not all XSL-FO renderers will support all possible values.
lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
• property writingModeRegionBefore as %ZEN.Datatype.string(VALUELIST=",lr-tb,rl-tb,tb-rl,lr,rl,tb,inherit",XMLNAME="writing-mode-region-before");
writing-mode XML attribute on the region-before. It has the following possible values. Note that not all XSL-FO renderers will support all possible values.
lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
• property writingModeRegionBody as %ZEN.Datatype.string(VALUELIST=",lr-tb,rl-tb,tb-rl,lr,rl,tb,inherit",XMLNAME="writing-mode-region-body");
writing-mode XML attribute on the region-body. It has the following possible values. Note that not all XSL-FO renderers will support all possible values.
lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
• property writingModeRegionEnd as %ZEN.Datatype.string(VALUELIST=",lr-tb,rl-tb,tb-rl,lr,rl,tb,inherit",XMLNAME="writing-mode-region-end");
writing-mode XML attribute on the region-end. It has the following possible values. Note that not all XSL-FO renderers will support all possible values.
lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
• property writingModeRegionStart as %ZEN.Datatype.string(VALUELIST=",lr-tb,rl-tb,tb-rl,lr,rl,tb,inherit",XMLNAME="writing-mode-region-start");
writing-mode XML attribute on the region-start. It has the following possible values. Note that not all XSL-FO renderers will support all possible values.
lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit

Methods

• method %DrawPageToXSLFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, masterName As %String = "main") as %Status
Renders the dimensions of the page for a PDF report.Proposed change - add "masterName" parameter with default value "main"
• method %DrawStyleToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream) as %Status
Outputs the style information contained in its <class> children for an HTML report.
• method %DrawStyleToXSLFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, SectionName As %String = "") as %Status
Outputs the style information contained in its <class> children for a PDF report.
• classmethod toMilimeters(length As %String) as %String


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