This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


class %DeepSee.UI.Dialog.SendMail extends %DeepSee.UI.Dialog.standardDialog

This dialog lets the user send a dashboard via email.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.


property dashboardName as %ZEN.Datatype.string (ZENURL = "DASHBOARD");
Dashboard name.
Property methods: dashboardNameDisplayToLogical(), dashboardNameGet(), dashboardNameIsValid(), dashboardNameLogicalToDisplay(), dashboardNameLogicalToOdbc(), dashboardNameNormalize(), dashboardNameSet()
property dashboardTitle as %ZEN.Datatype.string (ZENURL = "TITLE");
Dashboard title.
Property methods: dashboardTitleDisplayToLogical(), dashboardTitleGet(), dashboardTitleIsValid(), dashboardTitleLogicalToDisplay(), dashboardTitleLogicalToOdbc(), dashboardTitleNormalize(), dashboardTitleSet()
property dashboardURL as %ZEN.Datatype.string (ZENURL = "URL");
Dashboard URL
Property methods: dashboardURLDisplayToLogical(), dashboardURLGet(), dashboardURLIsValid(), dashboardURLLogicalToDisplay(), dashboardURLLogicalToOdbc(), dashboardURLNormalize(), dashboardURLSet()


method %OnAfterCreatePage() as %Status
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod %RegisterSendTo(pSendTo As %String) as %Status
Remember this sendTo address in local list.
classmethod ClearHistory() [ ZenMethod ]
Clear the sendTo history for the current user.
classmethod DrawHelp(pSeed As %String) as %Status
classmethod SendMailViaSMTP(pSendTo As %String, pSubject As %String, pComments As %String, pURL As %String) as %String [ ZenMethod ]
Send an email message using the system-defined SMTP server.
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)