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

%ZEN.Template.studioTemplate

abstract class %ZEN.Template.studioTemplate extends %ZEN.Component.page

Base class for Zen-based Studio Templates.
Zen-based Studio Templates extend this class.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter AUTOLOGOUT = 0;
Do not use AutoLogout logic for template pages.
parameter AUTONS = 1;
If auto-switch namespace to whatever $NAMESPACE is passed in
parameter CHARSET = UTF-8;
Prevent IE issues with non-UTF8 char-sets.
parameter GLOBALTEMPLATE = 1;
If this is true then even if this template is tied to a specific namespace it will be available in any namespace and it will be up to the template to make sure it looks for any specific data in the target namespace.
parameter HELPID;
DOCBOOK Topic Id that offers help for this template.
parameter RESOURCE = %Development:USE;
Users must have %Development:USE to access any Studio templates.
parameter TEMPLATEACCELERATOR;
Accelerator key for this template in Studio, 0-9.
User will press Ctrl+Shift+key to activate.
parameter TEMPLATEDESCRIPTION;
Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATEGROUP;
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 = template;
Specifies what type of template this is: 'template', 'new', or 'addin'. 'template' is the default and this creates code that is inserted into the current document, 'new' is a template that appears on the dialog when you click the new button, 'addin' is a template that appears on the addin menu which does not generate any output.
parameter TEMPLATENAME;
Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATENOOUTPUT = 0;
Set this true (1) if this template does not generate any output, only applies to 'template' types but it prevents Studio from needing to make the current file writable.
parameter TEMPLATETITLE;
Title of the template to show in the template window.
parameter TEMPLATETYPE = *;
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.
parameter VALIDATEXML = 0;
Inherited description: Validate user pages

Properties (Including Private)

property DocumentName as %ZEN.Datatype.string (ZENURL = "Name");
Name of current document within Studio.
Property methods: DocumentNameDisplayToLogical(), DocumentNameGet(), DocumentNameIsValid(), DocumentNameLogicalToDisplay(), DocumentNameLogicalToOdbc(), DocumentNameNormalize(), DocumentNameSet(), DocumentNamespaceDisplayToLogical(), DocumentNamespaceGet(), DocumentNamespaceIsValid(), DocumentNamespaceLogicalToDisplay(), DocumentNamespaceLogicalToOdbc(), DocumentNamespaceNormalize(), DocumentNamespaceSet()
property DocumentNamespace as %ZEN.Datatype.string (ZENURL = "DocumentNamespace");
Namespace of current document within Studio.
Property methods: DocumentNamespaceDisplayToLogical(), DocumentNamespaceGet(), DocumentNamespaceIsValid(), DocumentNamespaceLogicalToDisplay(), DocumentNamespaceLogicalToOdbc(), DocumentNamespaceNormalize(), DocumentNamespaceSet()
property Language as %ZEN.Datatype.string (ZENURL = "Language");
Current language within Studio (e.g., "cache").
Property methods: LanguageDisplayToLogical(), LanguageGet(), LanguageIsValid(), LanguageLogicalToDisplay(), LanguageLogicalToOdbc(), LanguageNormalize(), LanguageSet()
property Namespace as %ZEN.Datatype.string (ZENURL = "Namespace");
Current namespace within Studio.
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSet()
property Project as %ZEN.Datatype.string (ZENURL = "Project");
Current project within Studio.
Property methods: ProjectDisplayToLogical(), ProjectGet(), ProjectIsValid(), ProjectLogicalToDisplay(), ProjectLogicalToOdbc(), ProjectNormalize(), ProjectSet()
property SelectedText as %ZEN.Datatype.string (ZENURL = "SelectedText");
Current selected text within Studio.
Property methods: SelectedTextDisplayToLogical(), SelectedTextGet(), SelectedTextIsValid(), SelectedTextLogicalToDisplay(), SelectedTextLogicalToOdbc(), SelectedTextNormalize(), SelectedTextSet()
property User as %ZEN.Datatype.string (ZENURL = "User");
Current user within Studio.
Property methods: UserDisplayToLogical(), UserGet(), UserIsValid(), UserLogicalToDisplay(), UserLogicalToOdbc(), UserNormalize(), UserSVGPackageListDisplayToLogical(), UserSVGPackageListGet(), UserSVGPackageListIsValid(), UserSVGPackageListLogicalToDisplay(), UserSVGPackageListLogicalToOdbc(), UserSVGPackageListNormalize(), UserSVGPackageListSet(), UserSet()
property helpId as %ZEN.Datatype.string [ InitialExpression = ..#HELPID ];