This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).


class %ZEN.Template.AddInWizard.XMLSchemaWizard extends %ZEN.Template.AddInWizard.Template

Studio Template.
The XML Schema Wizard reads an XML schema and creates a set of corresponding classes.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter HELPID = GXML_schema_wizard_ui;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter PAGETITLE = XML Schema Wizard;
Display title of this page
parameter TEMPLATEDESCRIPTION = Creates class definitions from an XML Schema file.;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATENAME = XML Schema Wizard;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = XML Schema 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.

Properties (Including Private)

property Multiple as %ZEN.Datatype.boolean;
Property methods: MultipleDisplayToLogical(), MultipleGet(), MultipleIsValid(), MultipleLogicalToDisplay(), MultipleLogicalToOdbc(), MultipleLogicalToXSD(), MultipleNormalize(), MultipleSet(), MultipleXSDToLogical()
property Packages as %ZEN.Datatype.string;
String that contains package names delimited by comma.
Property methods: PackagesDisplayToLogical(), PackagesGet(), PackagesIsValid(), PackagesLogicalToDisplay(), PackagesLogicalToOdbc(), PackagesNormalize(), PackagesSet()
property TotalPackages as %ZEN.Datatype.integer;
Number of total Namespaces which is the same as total packages
Property methods: TotalPackagesDisplayToLogical(), TotalPackagesGet(), TotalPackagesIsValid(), TotalPackagesLogicalToDisplay(), TotalPackagesLogicalToOdbc(), TotalPackagesNormalize(), TotalPackagesSet()
property lblSchemaFile as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Enter or select the path and name of a Schema File:") ];
Property methods: lblSchemaFileDisplayToLogical(), lblSchemaFileGet(), lblSchemaFileIsValid(), lblSchemaFileLogicalToDisplay(), lblSchemaFileLogicalToOdbc(), lblSchemaFileNormalize(), lblSchemaFileSet()
property lblURL as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Enter a URL:") ];
Property methods: lblURLDisplayToLogical(), lblURLGet(), lblURLIsValid(), lblURLLogicalToDisplay(), lblURLLogicalToOdbc(), lblURLNormalize(), lblURLSet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
Load the recent list. Set last file type so that onstartHandler can hide/show fields appropriately.
classmethod %OnPreHTTP() as %Boolean
Zen page notification of an HTTP request. This method can be overwritten by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.
method %OnTemplateAction() as %Status
This method is called when the template is complete. Any output to the principal device is returned to the Studio.
(1) adding classes to the project; (2) classes may be opened if Studio's option "Open file to added project" is checked.
classmethod DrawClasses(proxy As %ZEN.proxyObject) as %Status
Draw page 4, Classes
classmethod DrawNS(proxy As %ZEN.proxyObject) as %Status
Draw page 3, namespaces
classmethod DrawPageTitle(pSeed As %String) as %Status
classmethod DrawSaving(proxy As %ZEN.proxyObject) as %Status
Draw page 5, Saving Classes
classmethod FileExists(filename) as %Boolean [ ZenMethod ]
Check if file exists
classmethod GetRecentList(filetype) as %String [ ZenMethod ]
Get recent list for URLs or Files. filetype = "FILE" or "URL".
classmethod GetSRC(filetype As %String, filename As %String, sslConfig As %String = "") as %String [ ZenMethod ]
Given the source and filename, load the file. Save the source and filename to %session.Data.
classmethod GetStatus(tab) as %ZEN.proxyObject [ ZenMethod ]
tab = 3: NS - when DrawNS is finished, Status is "Done". tab = 4: Classes - when DrawClasses is finished, Status is "Done".
classmethod PreProcess(proxy As %ZEN.proxyObject) as %String [ ZenMethod ]
For page 3, do preprocess to find out whether it is multiple
classmethod SaveLast(filetype, url, sslConfig="") as %Boolean [ ZenMethod ]
FileType is either "FILE" or "URL".
clientmethod canFinish() [ Language = javascript ]
Return true if this template can Finish (i.e., enable the Finish button).
clientmethod canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
This is implemented by subclasses.
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod changePersistent(flag) [ Language = javascript ]
clientmethod changedFileType(thisObj) [ Language = javascript ]
User changed file type. Change label. Show local FILENAME if it is a local server. OW show filename and browse button.
clientmethod doBrowse() [ Language = javascript ]
Launching a file selector window.
clientmethod drawDone(tab) [ Language = javascript ]
This method is fired up after onDrawContent is finished. Hide progress message and display error if exists.
clientmethod getIndexValues(n) [ Language = javascript ]
Go through the Index values (checkboxes) for each class. Return index names that are checked.
clientmethod getPackages() [ Language = javascript ]
Validate and return packages string. If a package name is empty, display message and return 0.
clientmethod getTypeValues() [ Language = javascript ]
Go through the Type values (radio buttons) for all classes
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 nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select OR qualifers dialog and setting the value into the appropriate field. The id of the field that needs to be updated is saved in "dialogClicked".
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
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).
This is implemented by subclasses.
clientmethod updateFile(file) [ Language = javascript ]
Load the recently used file into textbox
clientmethod updateURL(url) [ Language = javascript ]
Load the recently used url into textbox

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window