Class %DeepSee.UI.MDXCSV

class %DeepSee.UI.MDXCSV extends %CSP.Page

This page renders the results of executing a DeepSee MDX statement in csv format.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5		9

Summary

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

Parameters

• parameter CHARSET = "utf-8";

Specifies the default character set for the page. This can be overriden using the <CSP:CONTENT CHARSET=> tag, or by setting the %response.CharSet property in the OnPreHTTP method. If this parameter is not specified, then for the default charset is utf-8.

• parameter CONTENTTYPE = "text/plain";

Specifies the default content type for the page. This can be overriden using the <CSP:CONTENT TYPE=> tag, or by setting the %response.ContentType property in the OnPreHTTP method. The default value if this parameter is not set is text/html.

• parameter EXPIRES;

Required for IE!

• parameter NOCHARSETCONVERT = 1;

Specifies if we wish to turn off charset conversion for this page. Normally CSP uses the tables built into InterSystems IRIS to convert between different charset's, however if you do not have a charset available you may wish to turn this off to avoid getting the error page saying that this charset is not installed. Then the data will be output and read in using RAW mode. This can be overridden using the <CSP:CONTENT NOCHARSETCONVERT=1> tag, or by setting the %response.NoCharSetConvert property in the OnPreHTTP method.

• parameter PAGENAME = "MDXCSV";

Methods

• classmethod %EscapeHTML(pValue As %String) as %String

Format a string value for HTML output. This means escaping UNICODE characters.

• classmethod %FormatNumber(pValue As %String) as %String

Format a value for output.

• classmethod %NumberToColumn(pValue As %String) as %String

Convert a column number to a letter (A,B,AA).

• classmethod %PrintKPIResults(pKPI As %String, pCaption As %String = "", pSubCaption As %String = "") as %Status

Print out the contents of the given KPI.

• classmethod %PrintListingResults(pRS As %SQL.StatementResult, pCaption As %String = "", pSubCaption As %String = "", pListingFields As %List = "", pCubeKey As %String = "") as %Status

Print out the contents (as Excel-style HTML) of the given SQL ResultSet listing. pListingFields is option list of fields to display.

• classmethod %PrintResults(pRS As %DeepSee.ResultSet, pCaption As %String = "", pSubCaption As %String = "") as %Status

Print out the contents (as Excel-style HTML) of the given MDX result set.

• classmethod OnPage() as %Status

Event handler for PAGE event: this is invoked in order to generate the content of a csp page.

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search