DocBook|Search
Class Reference
%CSP.StudioTemplateSuper
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%CSP] >  [StudioTemplateSuper]
Private  Storage  

class %CSP.StudioTemplateSuper extends %CSP.Page

The %CSP.StudioTemplateSuper is the superclass for all the template pages. All templates must derive from this superclass in order to work correctly.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 3


Summary

Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%OriginalNamespace %PackageName ConvertParameter Decrypt
Encrypt EscapeHTML EscapeURL HyperEventBody
HyperEventCall HyperEventFrame HyperEventHead Include
InsertHiddenField InsertHiddenFields IsEnabled IsPrivate
Link LocalizeName OnErrorSetup OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RewriteURL ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL

Subclasses
%CSP.StudioTemplateInsert %SOAP.ClientTest %Studio.SourceControl.UI
%template.htmlcolor %template.htmlinput %template.htmlscript
%template.htmltable %template.htmltablepreview %template.htmltag
%template.htmltagnew %template.sqlpreview %template.sqltemplate

Parameters

• parameter CHARSET = "UTF-8";
Make sure templates default to UTF-8
• parameter GlobalTemplate = 0;
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.

Methods

• classmethod IsEnabled() as %Boolean
Return false from this method to disable this template (for example based on the server platform)
• classmethod LocalizeName(id As %String, ByRef name As %String, ByRef description As %String) as %Status
Default code to localise the name and description of this template is to look it up in %TemplateName or TemplateName domain in localization table.
• classmethod OnErrorSetup(ByRef skipheader As %Boolean) as %Boolean
This is called before the OnPreHTTP and will handle the HyperEvent errors and setup the status line in the response for the standard errors.