Class Reference
IRIS for UNIX 2019.4
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%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
3 3


Summary

Methods
%ClassIsLatestVersion %ClassName %Close %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %Extends %GetParameter
%IncrementCount %IsA %New %OriginalNamespace
%PackageName %SetModified ConvertParameter Decrypt
Encrypt EncryptBroker 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

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.
• parameter SECURITYRESOURCE = "%Development";
This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on all of the specified resources in order to view this page.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE. You can also specify or grouping using the '|' character, so 'R1,R2|R3,R3|R4' means you must have resource R1 and one of R2 or R3 and one of R3 or R4. So if you have R1,R3 it will pass, if you have R1,R4 it will not as it does not meet the R2|R3 condition. So the '|' or condition takes precedence over the ',' and condition.

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.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.