This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > %ZEN.Component.lookup


class %ZEN.Component.lookup extends %ZEN.Component.control

This is a specialized lookup control that provides a way to select a value from a list of options.

Property Inventory

Method Inventory


property context as %ZEN.Datatype.uri;
Context string used to determine the selection list for this component.
A context string take the form of a URL:
SearchClass is the name of a %ZEN.Portal.ContextSearch search class that contains the search to perform.
SearchName is the name of the search method to invoke within the search class.
You can omit the search class and name and use the context to pick up value from other controls on the current page. In this case the context string should start take the form:
At this time, search class and name are not supported by this control.
Property methods: contextDisplayToLogical(), contextGet(), contextIsValid(), contextLogicalToDisplay(), contextLogicalToOdbc(), contextNormalize(), contextSet()
property displayBinding as %ZEN.Datatype.string;
Optional. If this control belongs to a form that is associated with a dataController, this specifies the name of the property within the dataController that will provide the display value for this control.
Property methods: displayBindingDisplayToLogical(), displayBindingGet(), displayBindingIsValid(), displayBindingLogicalToDisplay(), displayBindingLogicalToOdbc(), displayBindingNormalize(), displayBindingSet()
property idProperty as %ZEN.Datatype.string;
Name of property within data element that supplies the id value.
Property methods: idPropertyDisplayToLogical(), idPropertyGet(), idPropertyIsValid(), idPropertyLogicalToDisplay(), idPropertyLogicalToOdbc(), idPropertyNormalize(), idPropertySet()
property imageProperty as %ZEN.Datatype.string;
Name of property within data element that supplies an image src value. If defined, and the property exists, show the image in the popup instead of the text value.
Property methods: imagePropertyDisplayToLogical(), imagePropertyGet(), imagePropertyIsValid(), imagePropertyLogicalToDisplay(), imagePropertyLogicalToOdbc(), imagePropertyNormalize(), imagePropertySet()
property lookupIcon as %ZEN.Datatype.uri [ InitialExpression = "deepsee/zoom_16.png" ];
Image to use to invoke lookup popup.
Property methods: lookupIconDisplayToLogical(), lookupIconGet(), lookupIconIsValid(), lookupIconLogicalToDisplay(), lookupIconLogicalToOdbc(), lookupIconNormalize(), lookupIconSet()
property multiSelect as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
This flag is not implemented at this time.
Property methods: multiSelectDisplayToLogical(), multiSelectGet(), multiSelectIsValid(), multiSelectLogicalToDisplay(), multiSelectLogicalToOdbc(), multiSelectLogicalToXSD(), multiSelectNormalize(), multiSelectSet(), multiSelectXSDToLogical()
property noResultsMessage as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Nothing to show!","%Utility") ];
Message to show when no results are present.
Property methods: noResultsMessageDisplayToLogical(), noResultsMessageGet(), noResultsMessageIsValid(), noResultsMessageLogicalToDisplay(), noResultsMessageLogicalToOdbc(), noResultsMessageNormalize(), noResultsMessageSet()
property ongetdata as %ZEN.Datatype.eventHandler;
ongetdata event handler: Return a javascript array of data to display in the popup. This can be any array of object or literal values.
Property methods: ongetdataDisplayToLogical(), ongetdataGet(), ongetdataIsValid(), ongetdataLogicalToDisplay(), ongetdataLogicalToOdbc(), ongetdataNormalize(), ongetdataSet()
property onshowPopup as %ZEN.Datatype.eventHandler;
onshowPopup event handler: This event is fired just before the popup is displayed.
Property methods: onshowPopupDisplayToLogical(), onshowPopupGet(), onshowPopupIsValid(), onshowPopupLogicalToDisplay(), onshowPopupLogicalToOdbc(), onshowPopupNormalize(), onshowPopupSet()
property popupLabel as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Search","%Utility") ];
Title to display within popup.
Property methods: popupLabelDisplayToLogical(), popupLabelGet(), popupLabelIsValid(), popupLabelLogicalToDisplay(), popupLabelLogicalToOdbc(), popupLabelNormalize(), popupLabelSet()
property propertyList as %ZEN.Datatype.csv;
List of property values to display in the popup list. This is a csv-list of property names.
Property methods: propertyListDisplayToLogical(), propertyListGet(), propertyListIsValid(), propertyListLogicalToDisplay(), propertyListLogicalToOdbc(), propertyListNormalize(), propertyListSet()
property separator as %ZEN.Datatype.string [ InitialExpression = "," ];
This property is not used at this time.
Property methods: separatorDisplayToLogical(), separatorGet(), separatorIsValid(), separatorLogicalToDisplay(), separatorLogicalToOdbc(), separatorNormalize(), separatorSet()
property showFilter as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Specify if there should be a filter text box within the pop up.
Property methods: showFilterDisplayToLogical(), showFilterGet(), showFilterIsValid(), showFilterLogicalToDisplay(), showFilterLogicalToOdbc(), showFilterLogicalToXSD(), showFilterNormalize(), showFilterSet(), showFilterXSDToLogical()
property size as %ZEN.Datatype.integer;
Size (width * 10 pixels) of the base (non popup) portion of this control.
Property methods: sizeDisplayToLogical(), sizeGet(), sizeIsValid(), sizeLogicalToDisplay(), sizeLogicalToOdbc(), sizeNormalize(), sizeSet()
property styleList as %ZEN.Datatype.csv;
List of CSS styles to apply to cells within the popup list. This is a csv-list of CSS styles.
Property methods: styleListDisplayToLogical(), styleListGet(), styleListIsValid(), styleListLogicalToDisplay(), styleListLogicalToOdbc(), styleListNormalize(), styleListSet()
property text as %ZEN.Datatype.string;
Display value for this control.
value contains the logical value.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textPropertyDisplayToLogical(), textPropertyGet(), textPropertyIsValid(), textPropertyLogicalToDisplay(), textPropertyLogicalToOdbc(), textPropertyNormalize(), textPropertySet(), textSet()
property textProperty as %ZEN.Datatype.string;
Name of property within data element that supplies the text value.
Property methods: textPropertyDisplayToLogical(), textPropertyGet(), textPropertyIsValid(), textPropertyLogicalToDisplay(), textPropertyLogicalToOdbc(), textPropertyNormalize(), textPropertySet()


clientmethod adjustSize() [ Language = javascript ]
Adjust the size of the control.
clientmethod applyValue(value, text) [ Language = javascript ]
Value applied from popup.
clientmethod focus() [ Language = javascript ]
Client-side method to give input focus to this control.
clientmethod getPopupContent(group) [ Language = javascript ]
Return the content for the popup/dropdown.
clientmethod getProperty(property, key) as %String [ Language = javascript ]
Override to get current value of control.
clientmethod renderContents() [ Language = javascript ]
Client-side method to render control.
clientmethod selectPopupItem(index) [ Language = javascript ]
Select an item within the popup (used by keyboard handling).
clientmethod selectorClick() [ Language = javascript ]
User has pressed the selector button.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod showGroupHandler() [ Language = javascript ]
Notification that the popup group is displayed.
clientmethod showPopup(spec) [ Language = javascript ]
Display the dropdown popup window. spec is an object with any of the following properties:
top - top edge of popup.
left - left edge of popup.
parentDiv - if supplied, use this to place the popup.
value - current logical value.
data - array of data elements to display; can be an array of objects or literal values.
propertyList - if data contains objects, this is a csv-list of properties to display.
styleList - this is a csv-list of styles to apply to the columns in the popup.
idProperty - if data contains objects, this the name of the property supplying the id value.
textProperty - if data contains objects, this the name of the property supplying the display value.
title - title to display in popup.
applyValue - function to call a value is selected within the popup.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window