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?


class %CSP.UI.Portal.SQL.PrintQuery extends

This page allows to print execute query result to a printer.

Property Inventory

Method Inventory


parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter AUTONS = 1;
Switch namespace for this page:
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.SQL.PrintQuery.zen;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter DOMAIN = %Utility;
Domain used for localization.
parameter PAGENAME = PrintQuery;
Displayed name of this page.
parameter PAGETITLE = Print Query;
Display title of this page
parameter RESOURCE = %Development;
Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.


property Dialect as %ZEN.Datatype.string (ZENURL = "Dialect") [ InitialExpression = "Nothing" ];
Property methods: DialectDisplayToLogical(), DialectGet(), DialectIsValid(), DialectLogicalToDisplay(), DialectLogicalToOdbc(), DialectNormalize(), DialectSet()
property FileName as %String;
Save to file name
Property methods: FileNameDisplayToLogical(), FileNameGet(), FileNameIsValid(), FileNameLogicalToDisplay(), FileNameLogicalToOdbc(), FileNameNormalize(), FileNameSet()
property HistoryId as %String (ZENURL = "$ID1");
History Id passed in from URL.
Property methods: HistoryIdDisplayToLogical(), HistoryIdGet(), HistoryIdIsValid(), HistoryIdLogicalToDisplay(), HistoryIdLogicalToOdbc(), HistoryIdNormalize(), HistoryIdSet()
property MaxRows as %ZEN.Datatype.string (ZENURL = "MaxRows") [ InitialExpression = "1000" ];
Property methods: MaxRowsDisplayToLogical(), MaxRowsGet(), MaxRowsIsValid(), MaxRowsLogicalToDisplay(), MaxRowsLogicalToOdbc(), MaxRowsNormalize(), MaxRowsSet()
property NAMESPACE as %String (ZENURL = "$NAMESPACE");
Namespace passed in from URL.
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property ObjectSelectMode as %ZEN.Datatype.boolean (ZENURL = "ObjectSelectMode") [ InitialExpression = 0 ];
Property methods: ObjectSelectModeDisplayToLogical(), ObjectSelectModeGet(), ObjectSelectModeIsValid(), ObjectSelectModeLogicalToDisplay(), ObjectSelectModeLogicalToOdbc(), ObjectSelectModeLogicalToXSD(), ObjectSelectModeNormalize(), ObjectSelectModeSet(), ObjectSelectModeXSDToLogical()
property RuntimeMode as %ZEN.Datatype.string (ZENURL = "RuntimeMode") [ InitialExpression = "2" ];
Property methods: RuntimeModeDisplayToLogical(), RuntimeModeGet(), RuntimeModeIsValid(), RuntimeModeLogicalToDisplay(), RuntimeModeLogicalToOdbc(), RuntimeModeNormalize(), RuntimeModeSet()
property ShowRowNum as %ZEN.Datatype.boolean (ZENURL = "ShowRowNum") [ InitialExpression = 0 ];
Property methods: ShowRowNumDisplayToLogical(), ShowRowNumGet(), ShowRowNumIsValid(), ShowRowNumLogicalToDisplay(), ShowRowNumLogicalToOdbc(), ShowRowNumLogicalToXSD(), ShowRowNumNormalize(), ShowRowNumSet(), ShowRowNumXSDToLogical()
property msgSelect as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a file name.") ];
Property methods: msgSelectDisplayToLogical(), msgSelectGet(), msgSelectIsValid(), msgSelectLogicalToDisplay(), msgSelectLogicalToOdbc(), msgSelectNormalize(), msgSelectSet()
property msgValidate as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("File already exists. Overwrite the existing file?") ];
Property methods: msgValidateDisplayToLogical(), msgValidateGet(), msgValidateIsValid(), msgValidateLogicalToDisplay(), msgValidateLogicalToOdbc(), msgValidateNormalize(), msgValidateSet()


method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
classmethod DrawHTML(pText As %String(MAXLEN="")) as %Status
classmethod GetFile(Format, FileName) as %String [ ZenMethod ]
Return file name with new extension
classmethod StartExport(pHistoryId, pFileName, pDisplayMode, pRuntimeMode, pDialect, pObjectSelectMode) as %Integer [ ZenMethod ]
Prepare for background export of the file.
classmethod ValidateFile(FileName) as %Integer [ ZenMethod ]
Return 0 if file is directory; 2 if file exists.
clientmethod browseSelect() [ Language = javascript ]
User clicked the Browse button.
clientmethod doClose() [ Language = javascript ]
clientmethod doPrint() [ Language = javascript ]
Prepare to start printing
clientmethod doSave() [ Language = javascript ]
Prepare to start export
clientmethod getWildcard(value) [ Language = javascript ]
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
clientmethod show(name) [ Language = javascript ]
Show or hide the other information
clientmethod updateFileExt(Format) [ Language = javascript ]
User changed File Format. Update the file extension in the file name.

Inherited Members

Inherited Properties

Inherited Methods