Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / %CSP.Documatic.PrintClass
Private  Storage   

%CSP.Documatic.PrintClass


class %CSP.Documatic.PrintClass extends
%CSP.Documatic

This class displays a printer friendly version of the class definition.
User may click the "print" link to choose printer, etc.
Other links are disabled except the section labels, such as "Summary", where user may click to collapse the label if they do not wish to print that section.

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
DefaultNS DefinedByClose DefinedByExecute DefinedByFetch
DrawUsername Encrypt EndFmt EscapeHTML
EscapeURL FmtInternal HyperEventBody HyperEventCall
HyperEventFrame HyperEventHead ImplementedByClose ImplementedByExecute
ImplementedByFetch Include InsertHiddenField InsertHiddenFields
IsHidden IsInternal IsPrivate Link
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS ReferencedByClose ReferencedByExecute ReferencedByFetch
RenderCacheSQLStorageDef RenderCacheStorageDef RenderClassPage RenderCode
RenderDescription RenderIndexPage RenderNameSpaceList RenderNameSpacePage
RenderPackageInfo RenderPackagePage RenderStorageDef RenderStoragePage
RewriteURL ShowError ShowInternal StartTimer
StopTimer SwapNS ThrowError UnescapeHTML
UnescapeURL zzzText zzzTextHTML zzzTextJS


Parameters


• parameter CSPURL = "/csp/documatic/%CSP.Documatic.PrintClass.cls";
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
• parameter URL = "%25CSP.Documatic.PrintClass.cls";

Methods


• classmethod DrawUsername()
Draw username or server name depend on setup.
• classmethod OnPage() as %Status
Event handler for PAGE event: this is invoked in order to display a csp page. This method is called to render a class document to a browser.
• private classmethod RenderBanner(title As %String, %library As %String, class As %String) as %Status
Generate the title banner for the current page.
• private classmethod RenderPrinter()
Display Printer link
• private classmethod ServeStyleSheet() as %Status
Renders the style sheet used by the doc viewer.