Home > Class Reference > ENSLIB namespace > %ZEN.Template.WebFormWizard.Home

%ZEN.Template.WebFormWizard.Home

class %ZEN.Template.WebFormWizard.Home extends %ZEN.Template.WebFormWizard.Template

Studio Template.
Create CSP forms for Cache classes.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DOMAIN = %ZEN;
Domain used for localization.
parameter HELPID = GSTD_CreateWeb;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter PAGETITLE = Web Form Wizard;
Display title of this page
parameter TEMPLATEDESCRIPTION = Create a CSP form for a Cache class.;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATEMODE = template;
What type of template.
parameter TEMPLATENAME = Web Form Wizard;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = Web Form Wizard;
Inherited description: Title of the template to show in the template window.
parameter TEMPLATETYPE = cls,csp;
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 FullClassName as %ZEN.Datatype.string;
User selected class name
Property methods: FullClassNameDisplayToLogical(), FullClassNameGet(), FullClassNameIsValid(), FullClassNameLogicalToDisplay(), FullClassNameLogicalToOdbc(), FullClassNameNormalize(), FullClassNameSet()
property TreeTotal as %ZEN.Datatype.integer;
Property methods: TreeTotalDisplayToLogical(), TreeTotalGet(), TreeTotalIsValid(), TreeTotalLogicalToDisplay(), TreeTotalLogicalToOdbc(), TreeTotalNormalize(), TreeTotalSet()
property sId as %ZEN.Datatype.string [ InitialExpression = $select($isObject($get(%session)):%session.SessionId,1:$j) ];
Property methods: sIdDisplayToLogical(), sIdGet(), sIdIsValid(), sIdLogicalToDisplay(), sIdLogicalToOdbc(), sIdNormalize(), sIdSet()

Methods (Including Private)

method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component for tab1.
method %GetDescHTML2(pSeed As %String) as %Status
Provide contents of description component for tab2.
method %GetDescHTML3(pSeed As %String) as %Status
Provide contents of description component for tab3.
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 ConvertKeyNameToIntName(Key) as %String
*************************************************************** /// * The following methods are for generating code for a form. * /// *************************************************************** /// Check for JavaScript name identifiers. If invalid characters (including foreign language) exist in a property name, then that property name will not be used in the field name on the new generated form. Instead, a "fieldNN" name will be used where NN is the unique "findex" number.
method GetOptionsList(Layout) as %String
Build option list based on user's Settings
method GetParameterList(clsName, sIntName)
This module is called to heck if ValueList and DisplayList exist. If yes, build SELECT box.
method GetSearchList(sId, clsName) as %String
Loop through the selected properties. Add to search list if the property is searchable
classmethod PopulateAttributeList(pRoot As %String, Output pTree, ByRef pParms) as %Status
Load fields into Available/Selected list boxes. ClassMethod PopulateAttributeList(NAMESPACE, FullClassName, sId) As %Boolean [ ZenMethod ]
classmethod PopulateClassList(pRoot As