Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %CSP.RuleDoc
Private  Storage   

%CSP.RuleDoc


class %CSP.RuleDoc extends
%CSP.Page

CSP page that provides documentation viewer for CSP Rules. It expects the following input:
RULEName of rule to display.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 5


Summary


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


Parameters


• parameter ENCODED = 2;
Override ENCODED from %CSP.Page
• parameter PRIVATE = 1;
Override PRIVATE from %CSP.Page

Methods


• classmethod GetDescription(text As %String) as %String
Convert description to formatted HTML and return the string. Also used by rulemgr.csp.
• classmethod OnPage() as %Status
OnPage method to display CSP Rules
• classmethod ShowDescription(text As %String)
Convert description to formatted HTML and write it out.
• private classmethod ShowRule(rule As %String, family As %String = "csp")
Display HTML description of rule rule.
• private classmethod ShowStyleSheet()
Display the HTML Style Sheet for the lookup page.

This has to be called within the HEAD section of the document.