Home > Class Reference > ENSLIB namespace > %CSP.UI.System.AutoPageCSP
Private  Storage   

%CSP.UI.System.AutoPageCSP


abstract class %CSP.UI.System.AutoPageCSP extends %CSP.Page

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Base class used by CSP pages that work within the AutoPage framework.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 4


Summary


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

Subclasses
CSPX.AutoPageCSP

Parameters


• parameter CHARSET = "UTF-8";
Default Charset
• parameter DOMAIN = "%Utility";
Default Localization Domain
• parameter LOGINPAGE = "%CSP.Login.cls";
Name of the page to use for logins
• parameter PAGENAME;
Name of this page
• parameter PARENTPAGE;
Name of the parent page (used for the locator bar)

Methods


• classmethod GetLocator(pTitlePane As %CSP.Util.TitlePane, ByRef pAddress As %String, ByRef pBaseURL As %String = %request.URL) as %String
Get the list of items for the locator bar.
• classmethod GetPageName() as %String
Return localized version of PageName
• classmethod OnPreHTTP() as %Boolean
Event handler for PreHTTP event: this is invoked before the HTTP headers for a CSP page have been sent. All changes to the %CSP.Response class, such as adding cookies, HTTP headers, setting the content type etc. must be made from within the OnPreHTTP() method. Also changes to the state of the CSP application such as changing %session.EndSession or %session.AppTimeout must be made within the OnPreHTTP() method. It is prefered that changes to %session.Preserve are also made in the OnPreHTTP() method as this is more efficient, although it is supported in any section of the page. Return 0 to prevent OnPage from being called.
• classmethod WriteTitlePane(pTitle As %String)
Write out the title pane for this page