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?

%DeepSee.UI.Dialog.GetList

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

This dialog lets the user add or edit a list for definition.
An existing list (delimited by comma) may be passed in.
If WHAT is not 'MemberList' this this dialog only provide one textarea for you to edit one field.

Property Inventory

Method Inventory

Parameters

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

Properties

property ELEMENT as %ZEN.Datatype.string (ZENURL = "ELEMENT");
Property methods: ELEMENTDisplayToLogical(), ELEMENTGet(), ELEMENTIsValid(), ELEMENTLogicalToDisplay(), ELEMENTLogicalToOdbc(), ELEMENTNormalize(), ELEMENTSet()
property Expression as %ZEN.Datatype.string (ZENURL = "VALUE");
Property methods: ExpressionDisplayToLogical(), ExpressionGet(), ExpressionIsValid(), ExpressionLogicalToDisplay(), ExpressionLogicalToOdbc(), ExpressionNormalize(), ExpressionSet()
property WHAT as %ZEN.Datatype.string (ZENURL = "WHAT");
Property methods: WHATDisplayToLogical(), WHATGet(), WHATIsValid(), WHATLogicalToDisplay(), WHATLogicalToOdbc(), WHATNormalize(), WHATSet()
property cubeName as %ZEN.Datatype.string (ZENURL = "CUBE");
Cube name.
Property methods: cubeNameDisplayToLogical(), cubeNameGet(), cubeNameIsValid(), cubeNameLogicalToDisplay(), cubeNameLogicalToOdbc(), cubeNameNormalize(), cubeNameSet()
property itemNumber as %ZEN.Datatype.integer [ InitialExpression = "1" ];
Property methods: itemNumberDisplayToLogical(), itemNumberGet(), itemNumberIsValid(), itemNumberLogicalToDisplay(), itemNumberLogicalToOdbc(), itemNumberNormalize(), itemNumberSet()
property lblProperty as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Enter a data source Property:") ];
Property methods: lblPropertyDisplayToLogical(), lblPropertyGet(), lblPropertyIsValid(), lblPropertyLogicalToDisplay(), lblPropertyLogicalToOdbc(), lblPropertyNormalize(), lblPropertySet()
property msgHasEmpty as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("There is at least one empty field. Proceed?") ];
Property methods: msgHasEmptyDisplayToLogical(), msgHasEmptyGet(), msgHasEmptyIsValid(), msgHasEmptyLogicalToDisplay(), msgHasEmptyLogicalToOdbc(), msgHasEmptyNormalize(), msgHasEmptySet()

Methods

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.
clientmethod addItem() [ Language = javascript ]
Add a new row
clientmethod clearItem(itemNumber) [ Language = javascript ]
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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.

Inherited Members

Inherited Properties

Inherited Methods

Feedback