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

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


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

This dialog lets the user save a DeepSee worksheet.

Property Inventory (Including Private)

Method Inventory (Including Private)


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


property worksheetDescription as %ZEN.Datatype.string (MAXLEN = 32000, ZENURL = "DESC");
Worksheet description.
Property methods: worksheetDescriptionDisplayToLogical(), worksheetDescriptionGet(), worksheetDescriptionIsValid(), worksheetDescriptionLogicalToDisplay(), worksheetDescriptionLogicalToOdbc(), worksheetDescriptionNormalize(), worksheetDescriptionSet()
property worksheetKeywords as %ZEN.Datatype.string (MAXLEN = 32000, ZENURL = "WORDS");
Worksheet keywords.
Property methods: worksheetKeywordsDisplayToLogical(), worksheetKeywordsGet(), worksheetKeywordsIsValid(), worksheetKeywordsLogicalToDisplay(), worksheetKeywordsLogicalToOdbc(), worksheetKeywordsNormalize(), worksheetKeywordsSet()
property worksheetLocked as %ZEN.Datatype.boolean (ZENURL = "LOCKED") [ InitialExpression = 0 ];
Worksheet locked state.
Property methods: worksheetLockedDisplayToLogical(), worksheetLockedGet(), worksheetLockedIsValid(), worksheetLockedLogicalToDisplay(), worksheetLockedLogicalToOdbc(), worksheetLockedLogicalToXSD(), worksheetLockedNormalize(), worksheetLockedSet(), worksheetLockedXSDToLogical()
property worksheetName as %ZEN.Datatype.string (ZENURL = "WORKSHEET");
Worksheet name.
Property methods: worksheetNameDisplayToLogical(), worksheetNameGet(), worksheetNameIsValid(), worksheetNameLogicalToDisplay(), worksheetNameLogicalToOdbc(), worksheetNameNormalize(), worksheetNameSet()
property worksheetOwner as %ZEN.Datatype.string (MAXLEN = 255, ZENURL = "OWNER");
Worksheet owner.
Property methods: worksheetOwnerDisplayToLogical(), worksheetOwnerGet(), worksheetOwnerIsValid(), worksheetOwnerLogicalToDisplay(), worksheetOwnerLogicalToOdbc(), worksheetOwnerNormalize(), worksheetOwnerSet()
property worksheetPublic as %ZEN.Datatype.boolean (ZENURL = "PUBLIC") [ InitialExpression = 0 ];
Worksheet public state.
Property methods: worksheetPublicDisplayToLogical(), worksheetPublicGet(), worksheetPublicIsValid(), worksheetPublicLogicalToDisplay(), worksheetPublicLogicalToOdbc(), worksheetPublicLogicalToXSD(), worksheetPublicNormalize(), worksheetPublicSet(), worksheetPublicXSDToLogical()
property worksheetResource as %ZEN.Datatype.string (MAXLEN = 255, ZENURL = "RESOURCE");
Worksheet resource.
Property methods: worksheetResourceDisplayToLogical(), worksheetResourceGet(), worksheetResourceIsValid(), worksheetResourceLogicalToDisplay(), worksheetResourceLogicalToOdbc(), worksheetResourceNormalize(), worksheetResourceSet()


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 WorksheetExists(pName As %String) as %Integer [ ZenMethod ]
Test if the given worksheet already exists.
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)