Skip to main content


class %DeepSee.Component.searchBox extends %ZEN.Component.abstractComboBox

Specialized searchBox control for DeepSee searches. This is designed for use within DeepSee components and not as a stand-alone control.

Property Inventory

Method Inventory


parameter DOMAIN = %DeepSee;
Localization domain
parameter ICONAPPLY = deepsee/ds2_checkmark_16.png;
parameter ICONCANCEL = deepsee/ds2_circlex_22.png;
parameter ICONSEARCH = deepsee/ds2_magnify_18.png;
parameter JSINCLUDES = zenCSLM.js,zenESVG.js,DeepSee.js;
parameter NAMESPACE =;
Inherited description: This is the XML namespace used for library components.


property calendar as %ZEN.Datatype.string;
The calendar being used for a time level.
Property methods: calendarDisplayToLogical(), calendarGet(), calendarIsValid(), calendarLogicalToDisplay(), calendarLogicalToOdbc(), calendarNormalize(), calendarSet()
property dataSourceName as %ZEN.Datatype.string;
Name of the DeepSee dataSource driving this dropdown.
Property methods: dataSourceNameDisplayToLogical(), dataSourceNameGet(), dataSourceNameIsValid(), dataSourceNameLogicalToDisplay(), dataSourceNameLogicalToOdbc(), dataSourceNameNormalize(), dataSourceNameSet()
property dateFormat as %ZEN.Datatype.string [ InitialExpression = "mmm d, y" ];
Optional date format to apply (using DeepSee date format).
Property methods: dateFormatDisplayToLogical(), dateFormatGet(), dateFormatIsValid(), dateFormatLogicalToDisplay(), dateFormatLogicalToOdbc(), dateFormatNormalize(), dateFormatSet()
property descriptionProperty as %ZEN.Datatype.string (XMLPROJECTION = "none");
If defined, name of description property for a level.
Property methods: descriptionPropertyDisplayToLogical(), descriptionPropertyGet(), descriptionPropertyIsValid(), descriptionPropertyLogicalToDisplay(), descriptionPropertyLogicalToOdbc(), descriptionPropertyNormalize(), descriptionPropertySet()
property displayList as %ZEN.Datatype.csv;
Optional csv-list of captions to use for dropdown
Property methods: displayListDisplayToLogical(), displayListGet(), displayListIsValid(), displayListLogicalToDisplay(), displayListLogicalToOdbc(), displayListNormalize(), displayListSet()
property displayMode as %ZEN.Datatype.string (VALUELIST = "list,calendar,custom,measure", XMLPROJECTION = "none") [ InitialExpression = "list" ];
Display mode. Controls what is displayed in the drop down area.
Property methods: displayModeDisplayToLogical(), displayModeGet(), displayModeIsValid(), displayModeLogicalToDisplay(), displayModeLogicalToOdbc(), displayModeNormalize(), displayModeSet()
property filterName as %ZEN.Datatype.string;
Logical name of the filter supplying the values.
Property methods: filterNameDisplayToLogical(), filterNameGet(), filterNameIsValid(), filterNameLogicalToDisplay(), filterNameLogicalToOdbc(), filterNameNormalize(), filterNameSet()
property firstDayOfWeek as %ZEN.Datatype.integer;
Number indicating the first day of the week in the displayed calendar. 0 = Sunday, 6 = Saturday.
Property methods: firstDayOfWeekDisplayToLogical(), firstDayOfWeekGet(), firstDayOfWeekIsValid(), firstDayOfWeekLogicalToDisplay(), firstDayOfWeekLogicalToOdbc(), firstDayOfWeekNormalize(), firstDayOfWeekSet()
property iconApply as %ZEN.Datatype.string [ InitialExpression = ..#ICONAPPLY ];
Apply icon.
Property methods: iconApplyDisplayToLogical(), iconApplyGet(), iconApplyIsValid(), iconApplyLogicalToDisplay(), iconApplyLogicalToOdbc(), iconApplyNormalize(), iconApplySet()
property iconCancel as %ZEN.Datatype.string [ InitialExpression = ..#ICONCANCEL ];
Cancel icon.
Property methods: iconCancelDisplayToLogical(), iconCancelGet(), iconCancelIsValid(), iconCancelLogicalToDisplay(), iconCancelLogicalToOdbc(), iconCancelNormalize(), iconCancelSet()
property iconSearch as %ZEN.Datatype.string [ InitialExpression = ..#ICONSEARCH ];
Search icon.
Property methods: iconSearchDisplayToLogical(), iconSearchGet(), iconSearchIsValid(), iconSearchLogicalToDisplay(), iconSearchLogicalToOdbc(), iconSearchNormalize(), iconSearchSet()
property listOfText as list of %ZEN.Datatype.string (XMLPROJECTION = "none");
List of current selected item text values.
Property methods: listOfTextBuildValueArray(), listOfTextCollectionToDisplay(), listOfTextCollectionToOdbc(), listOfTextDisplayToCollection(), listOfTextDisplayToLogical(), listOfTextGet(), listOfTextGetObject(), listOfTextGetObjectId(), listOfTextGetSwizzled(), listOfTextIsValid(), listOfTextLogicalToDisplay(), listOfTextLogicalToOdbc(), listOfTextNormalize(), listOfTextOdbcToCollection(), listOfTextSet(), listOfTextSetObject(), listOfTextSetObjectId()
property listOfValues as list of %ZEN.Datatype.string (XMLPROJECTION = "none");
List of current selected item values.
Property methods: listOfValuesBuildValueArray(), listOfValuesCollectionToDisplay(), listOfValuesCollectionToOdbc(), listOfValuesDisplayToCollection(), listOfValuesDisplayToLogical(), listOfValuesGet(), listOfValuesGetObject(), listOfValuesGetObjectId(), listOfValuesGetSwizzled(), listOfValuesIsValid(), listOfValuesLogicalToDisplay(), listOfValuesLogicalToOdbc(), listOfValuesNormalize(), listOfValuesOdbcToCollection(), listOfValuesSet(), listOfValuesSetObject(), listOfValuesSetObjectId()
property loadingMessage as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Loading...","%ZEN") ];
Localized "loading" message displayed by control.
This message is temporarily displayed while a server-side query is running.
Property methods: loadingMessageDisplayToLogical(), loadingMessageGet(), loadingMessageIsValid(), loadingMessageLogicalToDisplay(), loadingMessageLogicalToOdbc(), loadingMessageNormalize(), loadingMessageSet()
property maxRows as %ZEN.Datatype.integer [ InitialExpression = 500 ];
Maximum number of items to show.
Property methods: maxRowsDisplayToLogical(), maxRowsGet(), maxRowsIsValid(), maxRowsLogicalToDisplay(), maxRowsLogicalToOdbc(), maxRowsNormalize(), maxRowsSet()
property multiSelect as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, allow selection of multiple items.
Property methods: multiSelectDisplayToLogical(), multiSelectGet(), multiSelectIsValid(), multiSelectLogicalToDisplay(), multiSelectLogicalToOdbc(), multiSelectLogicalToXSD(), multiSelectNormalize(), multiSelectSet(), multiSelectXSDToLogical()
property onshowdropdown as %ZEN.Datatype.eventHandler;
onshowdropdown event handler: This event is fired just as the dropdown is about to be rendered.
Property methods: onshowdropdownDisplayToLogical(), onshowdropdownGet(), onshowdropdownIsValid(), onshowdropdownLogicalToDisplay(), onshowdropdownLogicalToOdbc(), onshowdropdownNormalize(), onshowdropdownSet()
property previewMode as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, then render in preview mode.
Property methods: previewModeDisplayToLogical(), previewModeGet(), previewModeIsValid(), previewModeLogicalToDisplay(), previewModeLogicalToOdbc(), previewModeLogicalToXSD(), previewModeNormalize(), previewModeSet(), previewModeXSDToLogical()
property priorText as list of %ZEN.Datatype.string (XMLPROJECTION = "none");
List of item text values from prior searches.
Property methods: priorTextBuildValueArray(), priorTextCollectionToDisplay(), priorTextCollectionToOdbc(), priorTextDisplayToCollection(), priorTextDisplayToLogical(), priorTextGet(), priorTextGetObject(), priorTextGetObjectId(), priorTextGetSwizzled(), priorTextIsValid(), priorTextLogicalToDisplay(), priorTextLogicalToOdbc(), priorTextNormalize(), priorTextOdbcToCollection(), priorTextSet(), priorTextSetObject(), priorTextSetObjectId()
property priorValues as list of %ZEN.Datatype.string (XMLPROJECTION = "none");
List of item values from prior searches.
Property methods: priorValuesBuildValueArray(), priorValuesCollectionToDisplay(), priorValuesCollectionToOdbc(), priorValuesDisplayToCollection(), priorValuesDisplayToLogical(), priorValuesGet(), priorValuesGetObject(), priorValuesGetObjectId(), priorValuesGetSwizzled(), priorValuesIsValid(), priorValuesLogicalToDisplay(), priorValuesLogicalToOdbc(), priorValuesNormalize(), priorValuesOdbcToCollection(), priorValuesSet(), priorValuesSetObject(), priorValuesSetObjectId()
property relatedFilterKeys as list of %ZEN.Datatype.string (XMLPROJECTION = "none");
List of filter key values from other filter controls. This is used to restrict the set of members displayed by this searchBox.
Property methods: relatedFilterKeysBuildValueArray(), relatedFilterKeysCollectionToDisplay(), relatedFilterKeysCollectionToOdbc(), relatedFilterKeysDisplayToCollection(), relatedFilterKeysDisplayToLogical(), relatedFilterKeysGet(), relatedFilterKeysGetObject(), relatedFilterKeysGetObjectId(), relatedFilterKeysGetSwizzled(), relatedFilterKeysIsValid(), relatedFilterKeysLogicalToDisplay(), relatedFilterKeysLogicalToOdbc(), relatedFilterKeysNormalize(), relatedFilterKeysOdbcToCollection(), relatedFilterKeysSet(), relatedFilterKeysSetObject(), relatedFilterKeysSetObjectId()
property relatedFilterSpecs as list of %ZEN.Datatype.string (XMLPROJECTION = "none");
List of filter specs from other filter controls. This is used to restrict the set of members displayed by this searchBox.
Property methods: relatedFilterSpecsBuildValueArray(), relatedFilterSpecsCollectionToDisplay(), relatedFilterSpecsCollectionToOdbc(), relatedFilterSpecsDisplayToCollection(), relatedFilterSpecsDisplayToLogical(), relatedFilterSpecsGet(), relatedFilterSpecsGetObject(), relatedFilterSpecsGetObjectId(), relatedFilterSpecsGetSwizzled(), relatedFilterSpecsIsValid(), relatedFilterSpecsLogicalToDisplay(), relatedFilterSpecsLogicalToOdbc(), relatedFilterSpecsNormalize(), relatedFilterSpecsOdbcToCollection(), relatedFilterSpecsSet(), relatedFilterSpecsSetObject(), relatedFilterSpecsSetObjectId()
property selectMode as %ZEN.Datatype.string (XMLPROJECTION = "none");
Selection mode: "","not" or "range"
Property methods: selectModeDisplayToLogical(), selectModeGet(), selectModeIsValid(), selectModeLogicalToDisplay(), selectModeLogicalToOdbc(), selectModeNormalize(), selectModeSet()
property selectType as %ZEN.Datatype.string;
The type of level that provides data for this control.
Property methods: selectTypeDisplayToLogical(), selectTypeGet(), selectTypeIsValid(), selectTypeLogicalToDisplay(), selectTypeLogicalToOdbc(), selectTypeNormalize(), selectTypeSet()
property valueList as %ZEN.Datatype.csv;
Optional csv-list of values to use for dropdown
Property methods: valueListDisplayToLogical(), valueListGet(), valueListIsValid(), valueListLogicalToDisplay(), valueListLogicalToOdbc(), valueListNormalize(), valueListSet()
property valueRequired as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, require at least one selected item.
Property methods: valueRequiredDisplayToLogical(), valueRequiredGet(), valueRequiredIsValid(), valueRequiredLogicalToDisplay(), valueRequiredLogicalToOdbc(), valueRequiredLogicalToXSD(), valueRequiredNormalize(), valueRequiredSet(), valueRequiredXSDToLogical()


method %DrawHTML()
Draw contents of search box.
method %GetDisplayValue(pValue As %String, pType As %String = "") as %String
Lookup up the display value for the combobox given a logical value.
clientmethod adjustDropdownPosition() [ Language = javascript ]
Adjust the placement and size of the dropdown box based on current screen geometry and scrolling conditions.
clientmethod applyCalendar() [ Language = javascript ]
User click on ok icon in calendar mode.
clientmethod applyChange() [ Language = javascript ]
User click on ok icon.
clientmethod applyMeasure() [ Language = javascript ]
User click on ok icon in measure mode.
clientmethod cancelChanges(close) [ Language = javascript ]
Cancel user changes.
clientmethod cbNowClick(isCB, which) [ Language = javascript ]
User click on NOW checkbox.
clientmethod dateChange(ctrl, clear) [ Language = javascript ]
User selected a new date in the calendar.
clientmethod dateFromHorolog(val, nowInfo) [ Language = javascript ]
Convert a $H to yyyy-mm-dd date.
clientmethod dateRangeChange(which) [ Language = javascript ]
User selected a new date range in the calendar(s).
clientmethod dateToHorolog(val) [ Language = javascript ]
Convert a yyyy-mm-dd date to $h.
clientmethod doSearch() [ Language = javascript ]
Perform search on drop down contents.
clientmethod findDisplayValue(value) [ Language = javascript ]
Convert value to a display value.
clientmethod inputKeyHandler(evt) [ Language = javascript ]
Intercept default behavior. Keydown within input control.
clientmethod isAnyItemSelected() [ Language = javascript ]
Test if any checkbox is selected in the dropdown list.
clientmethod itemClick(evt, idx, iscb) [ Language = javascript ]
User click on item within dropdown. iscb is true if this is a click from the checkbox.
clientmethod msrAllClick(evt, iscb) [ Language = javascript ]
User click on all checkbox within measure dropdown. iscb is true if this is a click from the checkbox.
clientmethod msrChange() [ Language = javascript ]
User change value within measure expression dropdown.
clientmethod msrKeyPress(evt) [ Language = javascript ]
User key press in measure value control.
clientmethod notClick(iscb) [ Language = javascript ]
User click on NOT (exclude members) option within dropdown.
clientmethod offsetNowChange(which) [ Language = javascript ]
User change on NOW offset input
clientmethod onEndModalHandler(zindex) [ Language = javascript ]
Notification that this component is about to stop being modal.
clientmethod rangeChange(which) [ Language = javascript ]
Change of range combo.
clientmethod rangeClick(iscb) [ Language = javascript ]
User click on Range option within dropdown.
clientmethod rememberValues() [ Language = javascript ]
Remember current values.
clientmethod removeItem(idx) [ Language = javascript ]
clientmethod resetItems(skip) [ Language = javascript ]
Unselect all options in the dropdown list. If skip is provided, do not reset it.
clientmethod resolveNowOffset(offset, type) [ Language = javascript ]
Convert NOW-offset to a readable date value given the type. If an unsupported type is entered, the function will return a localized 'NOW'+offset.
Supported types: day, month, year
clientmethod searchKeyPress(evt) [ Language = javascript ]
Keypress in search box control.
clientmethod selectCustomItem(text, val) [ Language = javascript ]
User selected a value in the custom drop down.
clientmethod updateInput() [ Language = javascript ]
Display new values in input control.
clientmethod updateTooltip() [ Language = javascript ]
Change the tooltip for the input control.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab