Class Reference
%CSP.StudioTemplateInsert
Server:basexml
Instance:SOAXML
User:UnknownUser
  
-
  [USER] >  [%CSP] >  [StudioTemplateInsert]
Private  Storage

abstract class %CSP.StudioTemplateInsert extends %CSP.StudioTemplateSuper

The %CSP.StudioTemplateInsert outputs the template for CSP with certain tags in front and at the end of the template so Caché Studio can recognise this template and insert it into the current document.

This is automatically set as the superclass of the final page that generates the template by the rule.

Values can be returned to Studio by setting the %session.Data("Template") subnodes, for example to set the name of the class for a new class wizard use: 

	Set %session.Data("Template","CLASS")="User.Test"
These %session.Data("Template") values must be set in the last page that generates the actual template. We provide methods to set values into this %session.Data("Template") nodes that Studio understands. These are AddToProject and SetClassName.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6


Summary

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

Subclasses
%CSP.StudioTemplateError %template.htmlcolor2 %template.htmlinput2 %template.htmlscript2
%template.htmltable2 %template.htmltag2 %template.sqltemplate2

Methods

• classmethod AddToProject(Name As %String) as %Status
Add this named item to the current project in Studio. If you have multiple items then call this method multiple times. The Name must contain the type of the item e.g. 'User.Test.cls' is a class, and 'TEST.mac' is a MAC routine.
• classmethod AddToSourceControl(Name As %String) as %Status
Add this item to source control. If you have multiple items then call this method multiple times. The Name must containt eh type of the item to add e.g. 'User.Test.cls'.
• classmethod SetClassName(Name As %String) as %Status
If you are making a new class template then Studio needs to be told the name of this class. This is done by calling this method in the final page passing the name of the class.