Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Report] >  [UI] >  [pageSetupControl]
Private  Storage   

class %DeepSee.Report.UI.pageSetupControl extends %ZEN.Component.control

Page setup control

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 17 33


Summary

Properties
%condition %import %includeFiles %page
%resource align aux bottomPrompt
clientType composite containerStyle controlClass
controlStyle dataBinding disabled dragEnabled
dropEnabled editFooterReserve editHeaderReserve enclosingClass
enclosingStyle error footerPrompt headerPrompt
height hidden hint hintClass
hintStyle id index invalid
invalidMessage label labelClass labelDisabledClass
labelStyle landscapeOption leftPrompt marginsPrompt
name omitFirstPagePrompt omitLastPagePrompt onafterdrag
onbeforedrag onblur onchange onclick
ondblclick ondrag ondrop onfocus
onhide onkeydown onkeypress onkeyup
onmousedown onmouseout onmouseover onmouseup
onrefresh onshow onsubmit ontouchend
ontouchmove ontouchstart onupdate onvalidate
orientationPrompt originalValue pageSizePrompt parent
portraitOption readOnly required requiredMessage
rightPrompt runningHeadersPrompt showLabel slice
stockDefaultColor tabIndex title topPrompt
tuple valign value visible
width window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetForm %GetParameter
%GetXMLName %IsA %IsModified %MakeId
%Name %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnDrawEnclosingDiv %OnDrawObjectProperties
%OnObjectSynch %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveFromSaveSet %Self
%SerializeObject %SetDefaultValues %SetModified %ValidateObject
GetCustomStock GetStockPaperOptions XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType autoCount autoIncDec
buildStockArray computeBodyAreaSize configureHeadersCB constrainDragX
constrainDragY countDownCB countUpCB dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler endDrag exposeComponent findElement
fireOnUpdateEvent focus formatValue getDisabled
getDragData getEnclosingDiv getForm getHidden
getHintElement getInvalidReason getLabelElement getPixelToPointRatioH
getPixelToPointRatioV getProperty getReadOnly getSettings
getStdStockDetails getType getValue indexDragElement
initializePaperSelector initializeSpinners initializeValueObject invokeSuper
isModified isOfType isValid makeId
normalizeValue onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onStartModalHandler onchangeHandler onloadHandler onunloadHandler
onupdateHandler refreshContents render renderContents
renderSVG select selectOrientationCB selectPaperCB
setDisabled setDragLineDisplay setHidden setOverlayMode
setProperty setQuantumUnit setReadOnly setUnitsString
setValue setValueDisplay startDrag startProgressBar
stopCountCB stopProgressBar sysName unformatValue
updateAvatar updateConstraints updatePagePreview validate
validationHandler


Parameters

• parameter INCLUDEFILES = "zenCSLM.js";
CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.

Properties

• property bottomPrompt as %ZEN.Datatype.caption [ InitialExpression = "Bottom:" ];
• property editFooterReserve as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property editHeaderReserve as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property footerPrompt as %ZEN.Datatype.caption [ InitialExpression = "Footer:" ];
• property headerPrompt as %ZEN.Datatype.caption [ InitialExpression = "Header:" ];
• property landscapeOption as %ZEN.Datatype.caption [ InitialExpression = "Landscape" ];
• property leftPrompt as %ZEN.Datatype.caption [ InitialExpression = "Left:" ];
• property marginsPrompt as %ZEN.Datatype.caption [ InitialExpression = "Margins:" ];
• property omitFirstPagePrompt as %ZEN.Datatype.caption [ InitialExpression = "Omit on first page" ];
• property omitLastPagePrompt as %ZEN.Datatype.caption [ InitialExpression = "Omit on last page" ];
• property orientationPrompt as %ZEN.Datatype.caption [ InitialExpression = "Orientation:" ];
• property pageSizePrompt as %ZEN.Datatype.caption [ InitialExpression = "Page size:" ];
• property portraitOption as %ZEN.Datatype.caption [ InitialExpression = "Portrait" ];
• property rightPrompt as %ZEN.Datatype.caption [ InitialExpression = "Right:" ];
• property runningHeadersPrompt as %ZEN.Datatype.caption [ InitialExpression = "Running Headers:" ];
• property stockDefaultColor as %ZEN.Datatype.caption [ InitialExpression = "White" ];
• property topPrompt as %ZEN.Datatype.caption [ InitialExpression = "Top:" ];

Methods

• method %DrawHTML()
The %DrawHTML method draws the initial HTML for this component.
• method GetCustomStock() as %ZEN.Datatype.string [ ZenMethod ]
• method GetStockPaperOptions() as %ZEN.Datatype.string [ ZenMethod ]
• method autoCount(prefix, time) [ Language = javascript ]
• method autoIncDec(prefix) [ Language = javascript ]
• method buildStockArray() [ Language = javascript ]
• method computeBodyAreaSize() [ Language = javascript ]
• method configureHeadersCB(who, which) [ Language = javascript ]
• method constrainDragX(mgr, wrapper, newX) [ Language = javascript ]
• method constrainDragY(mgr, wrapper, newY) [ Language = javascript ]
• method countDownCB(prefix) [ Language = javascript ]
• method countUpCB(prefix) [ Language = javascript ]
• method endDrag(mgr, wrapper) [ Language = javascript ]
• method getPixelToPointRatioH() [ Language = javascript ]
• method getPixelToPointRatioV() [ Language = javascript ]
• method getStdStockDetails(name) [ Language = javascript ]
Return the topology record associated with the given (localized) stock name
• method indexDragElement(node) [ Language = javascript ]
• method initializePaperSelector() [ Language = javascript ]
• method initializeSpinners() [ Language = javascript ]
• method initializeValueObject(v) [ Language = javascript ]
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method selectOrientationCB(who) [ Language = javascript ]
• method selectPaperCB(who) [ Language = javascript ]
Set the point size of the page based on the logical name of the physical paper type Note that the nominal page width and height always assume a portrait orientation
• method setDragLineDisplay(prefix, value) [ Language = javascript ]
• method setQuantumUnit(n) [ Language = javascript ]
Set the quantum unit for incrementing and decrementing spinners. This is effectively the decimal convertion from points to whatever units are associated with the selected paper size
• method setUnitsString(prefix, str) [ Language = javascript ]
Set the displayed units to the given string within the given spinner object, identified by prefix
• method setValueDisplay(prefix, v) [ Language = javascript ]
Set the value of one of the many spinners, identified by prefix code. The internal value is in points, however the display value is coverted to either millimeters or inches depending on paper selection
• method startDrag(engine, wrapper) [ Language = javascript ]
• method stopCountCB(prefix) [ Language = javascript ]
• method updateAvatar() [ Language = javascript ]
• method updateConstraints() [ Language = javascript ]
• method updatePagePreview() [ Language = javascript ]
• method validate(prefix, e) [ Language = javascript ]
Confirm that the entered number meets the current contraints applicable to the given spinner, identified by prefix code.


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