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?

%ZEN.Template.ZENReportWizard

class %ZEN.Template.ZENReportWizard extends %ZEN.Template.studioTemplate

Studio Template: New ZEN Report.

Method Inventory (Including Private)

Parameters

parameter DOMAIN = %ZEN;
Domain used for localization.
parameter HELPID = GZEN_new_report;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter TEMPLATEDESCRIPTION = Create a new Zen Report class.;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATEGROUP = Zen;
Inherited description: If this is a TEMPLATEMODE="new" then this is the name of the tab in Studio this template is dispayed on. If none specified then it displays on 'Custom' tab.
parameter TEMPLATEMODE = new;
What type of template.
parameter TEMPLATENAME = Zen Report;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = Zen Report Wizard;
Inherited description: Title of the template to show in the template window.
parameter TEMPLATETYPE = cls;
Inherited description: Comma separated list of 'CSP', 'CSR', 'MAC', 'INT', 'INC', 'BAS', 'CLS' to say what type of code this template generates; CSP, CSR, Routine, or Class code. You can also specify '*' for all types.

Methods

method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component.
method %GetDescHTML2(pSeed As %String) as %Status
Provide contents of description component.
method %OnAfterCreatePage() as %Status
Inherited description: 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.
method %OnTemplateAction() as %Status
This method is called when the template is complete. Any output to the principal device is returned to the Studio.
method CreateApplicationRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the Application dataCombo.
method CreatePackageRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
Create the result set used by the Package dataCombo.
clientmethod canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod formValidationHandler() [ Language = javascript ]
Validation handler for form built-into template.
clientmethod hasMultiplePages() [ Language = javascript ]
Inherited description: Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.
clientmethod launchQueryBuilder() [ Language = javascript ]
Launch the query builder dialog.
clientmethod nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
clientmethod onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to set focus etc.
clientmethod previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
clientmethod reportNameChanged(reportNameCtl As %String) [ Language = javascript ]
Validate name and strip space if entered.
clientmethod validateClassName() [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback