StudioTemplateInsert Class Reference

The <CLASS>CSP.StudioTemplateInsert</CLASS> outputs the template for CSP with certain tags in front and at the end of the template so Studio can recognise this template and insert it into the current document. More...

Inheritance diagram for StudioTemplateInsert:

Collaboration diagram for StudioTemplateInsert:

Static Public Member Functions
_.Library.Status	AddToProject (_.Library.String Name)
	Add this named item to the current project in Studio. More...
_.Library.Status	AddToSourceControl (_.Library.String Name)
	Add this item to source control. More...
_.Library.Status	SetClassName (_.Library.String Name)
	If you are making a new class template then Studio needs to be told the. More...
Static Public Member Functions inherited from StudioTemplateSuper
_.Library.Boolean	IsEnabled ()
	Return false from this method to disable this template (for example based on the server platform)
_.Library.Status	LocalizeName (_.Library.String id, _.Library.String name, _.Library.String description)
	Default code to localise the name and description of this template is to look it up in TemplateName. More...
_.Library.Boolean	OnErrorSetup (_.Library.Boolean skipheader)
	This is called before the OnPreHTTP and will handle the HyperEvent errors and. More...
Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...
_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...
_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...
_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.
_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...
_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...
_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...
	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...
_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...
_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...
_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).
_.Library.String	Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ)
	Tranforms the link specified by link into a URL and returns it as a string. More...
_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...
_.Library.Status	OnPage ()
	Event handler for PAGE event: this is invoked in order to More...
	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...
	OnPostHTTP ()
	Event handler for POSTPAGE event: this is invoked after the data. More...
_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.
_.Library.Boolean	OnPreHTTP ()
	Event handler for PreHTTP event: this is invoked before. More...
_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on this page. More...
_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...
_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.
_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.
	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.
	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...
	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...
	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.
_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.
_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Static Public Attributes
	SECURITYRESOURCE = None
	The <CLASS>CSP.StudioTemplateInsert</CLASS> outputs the template for CSP with certain tags in front and at the end of the template so Studio can recognise this template and insert it into the current document. More...
Static Public Attributes inherited from StudioTemplateSuper
	CHARSET = None
	The <CLASS>CSP.StudioTemplateSuper</CLASS> is the superclass for all the template pages. More...
	GlobalTemplate = None
	If this is true then even if this template is tied to a specific namespace it. More...
Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...
	CONTENTTYPE = None
	Specifies the default content type for the page. More...
	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...
	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...
	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...
	CSPURL = None
	This parameter is used to make sure that if multiple. More...
	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...
	DOMAIN = None
	The default domain for csp:text, span and div tags. More...
	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...
	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...
	EXPIRES = None
	Specified the default value for the response.Expires. More...
	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...
	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...
	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...
	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...
	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...
	UseSession = None
	This parameter controls the CSP session support. More...

Detailed Description

The <CLASS>CSP.StudioTemplateInsert</CLASS> outputs the template for CSP with certain tags in front and at the end of the template so 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 <method>AddToProject</method> and <method>SetClassName</method>.

Member Function Documentation

AddToProject()

_.Library.Status AddToProject ( _.Library.String  Name )

static

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.

AddToSourceControl()

_.Library.Status AddToSourceControl ( _.Library.String  Name )

static

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'.

SetClassName()

_.Library.Status SetClassName ( _.Library.String  Name )

static

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.

Member Data Documentation

SECURITYRESOURCE

SECURITYRESOURCE = None

static

The <CLASS>CSP.StudioTemplateInsert</CLASS> outputs the template for CSP with certain tags in front and at the end of the template so 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 <method>AddToProject</method> and <method>SetClassName</method>.