Skip to main content

%ZEN.Report.Display.document

class %ZEN.Report.Display.document extends %ZEN.Report.Display.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.

Property Inventory

Method Inventory

Properties

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 methods: columnCountDisplayToLogical(), columnCountGet(), columnCountIsValid(), columnCountLogicalToDisplay(), columnCountLogicalToOdbc(), columnCountNormalize(), columnCountSet()
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 methods: columnGapDisplayToLogical(), columnGapGet(), columnGapIsValid(), columnGapLogicalToDisplay(), columnGapLogicalToOdbc(), columnGapNormalize(), columnGapSet()
property endSidebarLength as %ZEN.Datatype.length [ InitialExpression = "0" ];
Specifies the amount of room available for the contents of the <endsidebar> tag.
Property methods: endSidebarLengthDisplayToLogical(), endSidebarLengthGet(), endSidebarLengthIsValid(), endSidebarLengthLogicalToDisplay(), endSidebarLengthLogicalToOdbc(), endSidebarLengthNormalize(), endSidebarLengthSet()
property footerHeight as %ZEN.Datatype.length [ InitialExpression = "0" ];
Specifies the amount of room available for the contents of the <pagefooter> tag.
Property methods: footerHeightDisplayToLogical(), footerHeightGet(), footerHeightIsValid(), footerHeightLogicalToDisplay(), footerHeightLogicalToOdbc(), footerHeightNormalize(), footerHeightSet()
property headerHeight as %ZEN.Datatype.length [ InitialExpression = "0" ];
Specifies the amount of room available for the contents of the <pageheader> tag.
Property methods: headerHeightDisplayToLogical(), headerHeightGet(), headerHeightIsValid(), headerHeightLogicalToDisplay(), headerHeightLogicalToOdbc(), headerHeightNormalize(), headerHeightSet()
property height as %ZEN.Datatype.length [ InitialExpression = "11in" ];
Specifies the height of the document.
Property methods: heightDisplayToLogical(), heightGet(), heightIsValid(), heightLogicalToDisplay(), heightLogicalToOdbc(), heightNormalize(), heightSet()
property ifexpression as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: ifexpressionDisplayToLogical(), ifexpressionGet(), ifexpressionIsValid(), ifexpressionLogicalToDisplay(), ifexpressionLogicalToOdbc(), ifexpressionNormalize(), ifexpressionSet()
property ifxpath as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: ifxpathDisplayToLogical(), ifxpathGet(), ifxpathIsValid(), ifxpathLogicalToDisplay(), ifxpathLogicalToOdbc(), ifxpathNormalize(), ifxpathSet()
property margin as %ZEN.Datatype.string;
margin attribute on fo:simple-page-master
Property methods: marginDisplayToLogical(), marginGet(), marginIsValid(), marginLogicalToDisplay(), marginLogicalToOdbc(), marginNormalize(), marginSet()
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 methods: marginBottomDisplayToLogical(), marginBottomGet(), marginBottomIsValid(), marginBottomLogicalToDisplay(), marginBottomLogicalToOdbc(), marginBottomNormalize(), marginBottomSet()
property marginLeft as %ZEN.Datatype.length [ InitialExpression = "1.25in" ];
Specifies the left margin width of the document.
Property methods: marginLeftDisplayToLogical(), marginLeftGet(), marginLeftIsValid(), marginLeftLogicalToDisplay(), marginLeftLogicalToOdbc(), marginLeftNormalize(), marginLeftSet()
property marginRight as %ZEN.Datatype.length [ InitialExpression = "1.25in" ];
Specifies the right margin width of the document.
Property methods: marginRightDisplayToLogical(), marginRightGet(), marginRightIsValid(), marginRightLogicalToDisplay(), marginRightLogicalToOdbc(), marginRightNormalize(), marginRightSet()
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 methods: marginTopDisplayToLogical(), marginTopGet(), marginTopIsValid(), marginTopLogicalToDisplay(), marginTopLogicalToOdbc(), marginTopNormalize(), marginTopSet()
property orientation as %ZEN.Datatype.string (VALUELIST = ",portrait,landscape,none") [ InitialExpression = "portrait" ];
Property methods: orientationDisplayToLogical(), orientationGet(), orientationIsValid(), orientationLogicalToDisplay(), orientationLogicalToOdbc(), orientationNormalize(), orientationSet()
property referenceOrientation as %ZEN.Datatype.integer;
value of reference-orientation in XSL-FO region-body
Property methods: referenceOrientationDisplayToLogical(), referenceOrientationGet(), referenceOrientationIsValid(), referenceOrientationLogicalToDisplay(), referenceOrientationLogicalToOdbc(), referenceOrientationNormalize(), referenceOrientationSet()
property regionAfter as %ZEN.Datatype.string;
Property methods: regionAfterDisplayToLogical(), regionAfterGet(), regionAfterIsValid(), regionAfterLogicalToDisplay(), regionAfterLogicalToOdbc(), regionAfterNormalize(), regionAfterSet()
property regionAfterColor as %ZEN.Datatype.string;
Property methods: regionAfterColorDisplayToLogical(), regionAfterColorGet(), regionAfterColorIsValid(), regionAfterColorLogicalToDisplay(), regionAfterColorLogicalToOdbc(), regionAfterColorNormalize(), regionAfterColorSet()
property regionAfterDisplayAlign as %ZEN.Datatype.string [ InitialExpression = "after" ];
Property methods: regionAfterDisplayAlignDisplayToLogical(), regionAfterDisplayAlignGet(), regionAfterDisplayAlignIsValid(), regionAfterDisplayAlignLogicalToDisplay(), regionAfterDisplayAlignLogicalToOdbc(), regionAfterDisplayAlignNormalize(), regionAfterDisplayAlignSet()
property regionAfterExtent as %ZEN.Datatype.string;
Property methods: regionAfterExtentDisplayToLogical(), regionAfterExtentGet(), regionAfterExtentIsValid(), regionAfterExtentLogicalToDisplay(), regionAfterExtentLogicalToOdbc(), regionAfterExtentNormalize(), regionAfterExtentSet()
property regionAfterName as %ZEN.Datatype.string;
Property methods: regionAfterNameDisplayToLogical(), regionAfterNameGet(), regionAfterNameIsValid(), regionAfterNameLogicalToDisplay(), regionAfterNameLogicalToOdbc(), regionAfterNameNormalize(), regionAfterNameSet()
property regionAfterOrientation as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Property methods: regionAfterOrientationDisplayToLogical(), regionAfterOrientationGet(), regionAfterOrientationIsValid(), regionAfterOrientationLogicalToDisplay(), regionAfterOrientationLogicalToOdbc(), regionAfterOrientationNormalize(), regionAfterOrientationSet()
property regionBefore as %ZEN.Datatype.string;
Property methods: regionBeforeDisplayToLogical(), regionBeforeGet(), regionBeforeIsValid(), regionBeforeLogicalToDisplay(), regionBeforeLogicalToOdbc(), regionBeforeNormalize(), regionBeforeSet()
property regionBeforeColor as %ZEN.Datatype.string;
Property methods: regionBeforeColorDisplayToLogical(), regionBeforeColorGet(), regionBeforeColorIsValid(), regionBeforeColorLogicalToDisplay(), regionBeforeColorLogicalToOdbc(), regionBeforeColorNormalize(), regionBeforeColorSet()
property regionBeforeDisplayAlign as %ZEN.Datatype.string [ InitialExpression = "inherit" ];
Property methods: regionBeforeDisplayAlignDisplayToLogical(), regionBeforeDisplayAlignGet(), regionBeforeDisplayAlignIsValid(), regionBeforeDisplayAlignLogicalToDisplay(), regionBeforeDisplayAlignLogicalToOdbc(), regionBeforeDisplayAlignNormalize(), regionBeforeDisplayAlignSet()
property regionBeforeExtent as %ZEN.Datatype.string;
Property methods: regionBeforeExtentDisplayToLogical(), regionBeforeExtentGet(), regionBeforeExtentIsValid(), regionBeforeExtentLogicalToDisplay(), regionBeforeExtentLogicalToOdbc(), regionBeforeExtentNormalize(), regionBeforeExtentSet()
property regionBeforeName as %ZEN.Datatype.string;
Property methods: regionBeforeNameDisplayToLogical(), regionBeforeNameGet(), regionBeforeNameIsValid(), regionBeforeNameLogicalToDisplay(), regionBeforeNameLogicalToOdbc(), regionBeforeNameNormalize(), regionBeforeNameSet()
property regionBeforeOrientation as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Property methods: regionBeforeOrientationDisplayToLogical(), regionBeforeOrientationGet(), regionBeforeOrientationIsValid(), regionBeforeOrientationLogicalToDisplay(), regionBeforeOrientationLogicalToOdbc(), regionBeforeOrientationNormalize(), regionBeforeOrientationSet()
property regionEnd as %ZEN.Datatype.string;
Property methods: regionEndDisplayToLogical(), regionEndGet(), regionEndIsValid(), regionEndLogicalToDisplay(), regionEndLogicalToOdbc(), regionEndNormalize(), regionEndSet()
property regionEndColor as %ZEN.Datatype.string;
Property methods: regionEndColorDisplayToLogical(), regionEndColorGet(), regionEndColorIsValid(), regionEndColorLogicalToDisplay(), regionEndColorLogicalToOdbc(), regionEndColorNormalize(), regionEndColorSet()
property regionEndDisplayAlign as %ZEN.Datatype.string [ InitialExpression = "after" ];
Property methods: regionEndDisplayAlignDisplayToLogical(), regionEndDisplayAlignGet(), regionEndDisplayAlignIsValid(), regionEndDisplayAlignLogicalToDisplay(), regionEndDisplayAlignLogicalToOdbc(), regionEndDisplayAlignNormalize(), regionEndDisplayAlignSet()
property regionEndExtent as %ZEN.Datatype.string;
Property methods: regionEndExtentDisplayToLogical(), regionEndExtentGet(), regionEndExtentIsValid(), regionEndExtentLogicalToDisplay(), regionEndExtentLogicalToOdbc(), regionEndExtentNormalize(), regionEndExtentSet()
property regionEndName as %ZEN.Datatype.string;
Property methods: regionEndNameDisplayToLogical(), regionEndNameGet(), regionEndNameIsValid(), regionEndNameLogicalToDisplay(), regionEndNameLogicalToOdbc(), regionEndNameNormalize(), regionEndNameSet()
property regionEndOrientation as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Property methods: regionEndOrientationDisplayToLogical(), regionEndOrientationGet(), regionEndOrientationIsValid(), regionEndOrientationLogicalToDisplay(), regionEndOrientationLogicalToOdbc(), regionEndOrientationNormalize(), regionEndOrientationSet()
property regionStart as %ZEN.Datatype.string;
Property methods: regionStartDisplayToLogical(), regionStartGet(), regionStartIsValid(), regionStartLogicalToDisplay(), regionStartLogicalToOdbc(), regionStartNormalize(), regionStartSet()
property regionStartColor as %ZEN.Datatype.string;
Property methods: regionStartColorDisplayToLogical(), regionStartColorGet(), regionStartColorIsValid(), regionStartColorLogicalToDisplay(), regionStartColorLogicalToOdbc(), regionStartColorNormalize(), regionStartColorSet()
property regionStartDisplayAlign as %ZEN.Datatype.string [ InitialExpression = "inherit" ];
Property methods: regionStartDisplayAlignDisplayToLogical(), regionStartDisplayAlignGet(), regionStartDisplayAlignIsValid(), regionStartDisplayAlignLogicalToDisplay(), regionStartDisplayAlignLogicalToOdbc(), regionStartDisplayAlignNormalize(), regionStartDisplayAlignSet()
property regionStartExtent as %ZEN.Datatype.string;
Property methods: regionStartExtentDisplayToLogical(), regionStartExtentGet(), regionStartExtentIsValid(), regionStartExtentLogicalToDisplay(), regionStartExtentLogicalToOdbc(), regionStartExtentNormalize(), regionStartExtentSet()
property regionStartName as %ZEN.Datatype.string;
Property methods: regionStartNameDisplayToLogical(), regionStartNameGet(), regionStartNameIsValid(), regionStartNameLogicalToDisplay(), regionStartNameLogicalToOdbc(), regionStartNameNormalize(), regionStartNameSet()
property regionStartOrientation as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Property methods: regionStartOrientationDisplayToLogical(), regionStartOrientationGet(), regionStartOrientationIsValid(), regionStartOrientationLogicalToDisplay(), regionStartOrientationLogicalToOdbc(), regionStartOrientationNormalize(), regionStartOrientationSet()
property size as %ZEN.Datatype.string;
size attribute on fo:simple-page-master
Property methods: sizeDisplayToLogical(), sizeGet(), sizeIsValid(), sizeLogicalToDisplay(), sizeLogicalToOdbc(), sizeNormalize(), sizeSet()
property startSidebarLength as %ZEN.Datatype.length [ InitialExpression = "0" ];
Specifies the amount of room available for the contents of the <pagestartsidebar> tag.
Property methods: startSidebarLengthDisplayToLogical(), startSidebarLengthGet(), startSidebarLengthIsValid(), startSidebarLengthLogicalToDisplay(), startSidebarLengthLogicalToOdbc(), startSidebarLengthNormalize(), startSidebarLengthSet()
property width as %ZEN.Datatype.length [ InitialExpression = "8.5in" ];
Specifies the width of the document.
Property methods: widthDisplayToLogical(), widthGet(), widthIsValid(), widthLogicalToDisplay(), widthLogicalToOdbc(), widthNormalize(), widthSet()
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 methods: writingModeDisplayToLogical(), writingModeGet(), writingModeIsValid(), writingModeLogicalToDisplay(), writingModeLogicalToOdbc(), writingModeNormalize(), writingModeSet()
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 methods: writingModeRegionAfterDisplayToLogical(), writingModeRegionAfterGet(), writingModeRegionAfterIsValid(), writingModeRegionAfterLogicalToDisplay(), writingModeRegionAfterLogicalToOdbc(), writingModeRegionAfterNormalize(), writingModeRegionAfterSet()
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 methods: writingModeRegionBeforeDisplayToLogical(), writingModeRegionBeforeGet(), writingModeRegionBeforeIsValid(), writingModeRegionBeforeLogicalToDisplay(), writingModeRegionBeforeLogicalToOdbc(), writingModeRegionBeforeNormalize(), writingModeRegionBeforeSet()
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 methods: writingModeRegionBodyDisplayToLogical(), writingModeRegionBodyGet(), writingModeRegionBodyIsValid(), writingModeRegionBodyLogicalToDisplay(), writingModeRegionBodyLogicalToOdbc(), writingModeRegionBodyNormalize(), writingModeRegionBodySet()
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 methods: writingModeRegionEndDisplayToLogical(), writingModeRegionEndGet(), writingModeRegionEndIsValid(), writingModeRegionEndLogicalToDisplay(), writingModeRegionEndLogicalToOdbc(), writingModeRegionEndNormalize(), writingModeRegionEndSet()
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
Property methods: writingModeRegionStartDisplayToLogical(), writingModeRegionStartGet(), writingModeRegionStartIsValid(), writingModeRegionStartLogicalToDisplay(), writingModeRegionStartLogicalToOdbc(), writingModeRegionStartNormalize(), writingModeRegionStartSet()

Methods

method %DrawPageToXSLFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, masterName As %String = "main") as %Status
Renders the dimensinos of the page for a PDF report.Proposed change - add "masterName" parameter with default value "main"
method %DrawStyleToHTML(ByRef context As %Library.String, ByRef XSL As %Library.GlobalCharacterStream, delay As %Library.GlobalCharacterStream, SectionName As %Library.String = "") 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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab