Class %CSP.UI.Portal.SQL.PrintQuery

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

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

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	12	20

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	Dialect	FileName	FirstFailed
Foreground	HistoryId	InvalidParam	IsEMSReadOnly
MaxRows	NAMESPACE	ObjectSelectMode	RuntimeMode
ShowRowNum	ValidationErrorMsg	align	aux
backgroundTimerInterval	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	containerStyle
cssLevel	dialogTitle	disabled	disabledStyle
dragAndDrop	dragEnabled	dropEnabled	enclosingClass
enclosingStyle	error	groupClass	groupStyle
height	hidden	hideApplyButton	hideCancelButton
hint	hintClass	hintStyle	id
index	label	labelClass	labelDisabledClass
labelPosition	labelStyle	layout	msgSelect
msgValidate	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	parent
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddToSaveSet	%ApplyURLParms	%Attr
%BindExport	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%DrawAutoLogout
%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML	%DrawHTMLPage
%DrawJSStrings	%DrawObjectDefinitions	%DrawTitle	%EnclosingDivId
%EndBackgroundMethod	%EndScript	%Eval	%EvalC
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetLinks
%GetPageName	%GetParameter	%GetValueById	%GetValueByName
%GetXMLName	%IsA	%IsModified	%Link
%LinkCSS	%LinkScript	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnAfterCreatePage	%OnBeforeCreatePage	%OnCreateApplication	%OnCreatePage
%OnDetermineCSSLevel	%OnDrawEnclosingDiv	%OnDrawHTMLBody	%OnDrawHTMLHead
%OnDrawHTMLMeta	%OnDrawObjectProperties	%OnFinishBackgroundTask	%OnGetSubtitle
%OnGetTitle	%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch
%OnPreHTTP	%OnSubmit	%OnUseSoftModals	%OnZENDeserialize
%OriginalNamespace	%PackageName	%QuoteValue	%QuoteValueL10N
%RemoveChild	%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet
%RunBackgroundMethod	%Self	%SerializeObject	%SetBackgroundMethodStatus
%SetErrorById	%SetErrorByName	%SetModified	%SetValueById
%SetValueByName	%SetValuesByName	%StartScript	%ValidateObject
%ZENVersion	ConvertParameter	Decrypt	DrawHTML
Encrypt	EscapeHTML	EscapeURL	EvalResult
GetFile	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
Link	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RewriteURL	ShowError
StartExport	StartQuery	StartQueryExecution	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
ValidateFile	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
adjustSize	browseSelect	btnApply	btnOK
cancelPopup	childrenMutated	correctIELayering	createComponent
createComponentNS	ctrlKeyDown	deleteComponent	dialogApply
dialogCancel	dialogFinish	dialogTitleGet	disableButtons
doClose	doPrint	doSave	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	endModal	exposeComponent	findElement
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
getChildIndex	getComponent	getComponentById	getDialogValue
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getOpener	getProperty	getSettings	getType
getWildcard	gotoPage	invokeSuper	isOfType
launchPopupWindow	makeId	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	ondialogCancel	ondialogFinish	ondialogStart
ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler
onlayoutHandler	onloadHandler	onlogoutHandler	onoverlayHandler
onresizeHandler	onunloadHandler	onupdateHandler	popupActionHandler
refreshContents	removeChild	render	renderContents
renderSVG	resetMsg	setComponentId	setHidden
setOverlayMode	setProperty	setPropertyAll	setTraceOption
show	showMsg	startModal	startProgressBar
stopProgressBar	updateFileExt	validateRequired

Parameters

• 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";

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";

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:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

• property Dialect as %ZEN.Datatype.string(ZENURL="Dialect") [ InitialExpression = "Nothing" ];

• property FileName as %String;

Save to file name

• property Foreground as %ZEN.Datatype.boolean(ZENURL="Foreground") [ InitialExpression = 0 ];

Whether to execute the SQL query in the foreground [Passed in from URL]

• property HistoryId as %String(ZENURL="$ID1");

History Id passed in from URL.

• property MaxRows as %ZEN.Datatype.string(ZENURL="MaxRows") [ InitialExpression = "1000" ];

• property NAMESPACE as %String(ZENURL="$NAMESPACE");

Namespace passed in from URL.

• property ObjectSelectMode as %Integer(ZENURL="ObjectSelectMode") [ InitialExpression = 0 ];

• property RuntimeMode as %ZEN.Datatype.string(ZENURL="RuntimeMode") [ InitialExpression = "2" ];

• property ShowRowNum as %ZEN.Datatype.boolean(ZENURL="ShowRowNum") [ InitialExpression = 0 ];

• property msgSelect as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please enter a file name.") ];

• property msgValidate as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("File already exists. Overwrite the existing file?") ];

Methods

• 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 %OnFinishBackgroundTask(pTaskID As %String) as %Status

This server-side callback method is called whenever the client calls to monitor the current background task and the task is complete. Typically a subclass uses this to send back JavaScript to update the page.

• method %OnGetSubtitle() as %String

Get the (localized) subtitle string for the dialog.

• method %OnGetTitle() as %String

Get the (localized) title string for the dialog.

• classmethod %OnMonitorBackgroundTask(pTaskID As %String, pStatus As %String, pPercentComplete As %Float)

This server-side callback method is called whenever the client calls to monitor the current background task. Typically a subclass uses this to send back JavaScript to update a progress bar.

• method 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.

• method StartQuery(pSQL As %String, foreground As %Boolean = 0) as %Boolean [ ZenMethod ]

• classmethod StartQueryExecution(pRunInBackground As %Boolean = 1, pQueryID As %Integer, pRuntimeMode As %String, pDialect As %String, pObjectSelectMode As %Integer, pShowRowNum As %Boolean, pMaxRows As %Integer) as %Status

• classmethod ValidateFile(FileName) as %Integer [ ZenMethod ]

Return 0 if file is directory; 2 if file exists.

• method browseSelect() [ Language = javascript ]

User clicked the Browse button.

• method doClose() [ Language = javascript ]

• method doPrint() [ Language = javascript ]

Prepare to start printing

• method doSave() [ Language = javascript ]

Prepare to start export

• method getWildcard(value) [ Language = javascript ]

• method 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.

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method show(name) [ Language = javascript ]

Show or hide the other information

• method updateFileExt(Format) [ Language = javascript ]

User changed File Format. Update the file extension in the file name.


[USER] > [%CSP] > [UI] > [Portal] > [SQL] > [PrintQuery]		Private Storage