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 >

class extends %ZEN.Component.listControl

A select list control.
This control is based on the HTML select element.
Setting readOnly to true has the same effect as disabling this component; this is the standard HTML behavior for select controls.

Property Inventory

Method Inventory


parameter DEFAULTCONTROLCLASS = select;
Inherited description: The default css class used for the main element within this control. This is overridden by subclasses.


property emptyText as %ZEN.Datatype.caption;
The text to be displayed in the "empty" item displayed if showEmpty is true. The default is "".
Property methods: emptyTextDisplayToLogical(), emptyTextGet(), emptyTextIsValid(), emptyTextLogicalToDisplay(), emptyTextLogicalToOdbc(), emptyTextNormalize(), emptyTextSet()
property showEmpty as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true (the default), insert an extra row with the value of emptyText at the top of the dropdown, unless required is true.
Property methods: showEmptyDisplayToLogical(), showEmptyGet(), showEmptyIsValid(), showEmptyLogicalToDisplay(), showEmptyLogicalToOdbc(), showEmptyLogicalToXSD(), showEmptyNormalize(), showEmptySet(), showEmptyXSDToLogical()
property size as %ZEN.Datatype.integer (MINVAL = 0);
Number of rows in the select control.
Property methods: sizeDisplayToLogical(), sizeGet(), sizeIsValid(), sizeLogicalToDisplay(), sizeLogicalToOdbc(), sizeNormalize(), sizeSet()


method %DrawHTML()
Inherited description: Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
clientmethod getOptionText(idx) [ Language = javascript ]
Return the display text for the given item (0-based) in the dropdown list.
clientmethod getOptionValue(idx) [ Language = javascript ]
Return the logical value of the given item (0-based) in the dropdown list.
clientmethod getSelectedIndex(idx) [ Language = javascript ]
Return the index of the current selected item (0-based) in the select component. Returns -1 is no item is selected.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window