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 > EnsPortal.Dialog.SearchCriteria


class EnsPortal.Dialog.SearchCriteria extends EnsPortal.Dialog.standardDialog

Property Inventory

Method Inventory


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter RESOURCE = %Ens_MessageHeader:USE;
User needs USE permissions on the %Ens_MessageHeader resource to view this page.


property critDisabled as %ZEN.Datatype.boolean (ZENURL = "DISABLED") [ InitialExpression = 0 ];
Property methods: critDisabledDisplayToLogical(), critDisabledGet(), critDisabledIsValid(), critDisabledLogicalToDisplay(), critDisabledLogicalToOdbc(), critDisabledLogicalToXSD(), critDisabledNormalize(), critDisabledSet(), critDisabledXSDToLogical()
property headerClass as %ZEN.Datatype.className [ InitialExpression = "Ens.MessageHeader" ];
Property methods: headerClassDisplayToLogical(), headerClassGet(), headerClassIsValid(), headerClassLogicalToDisplay(), headerClassLogicalToOdbc(), headerClassNormalize(), headerClassSet()
property propClass as %ZEN.Datatype.className (ZENURL = "PROPCLASS");
Property methods: propClassDisplayToLogical(), propClassGet(), propClassIsValid(), propClassLogicalToDisplay(), propClassLogicalToOdbc(), propClassNormalize(), propClassSet()
property propType as %ZEN.Datatype.string (VALUELIST = ",Header,Body,SearchTable,VDocSegment,VDocPath,OR", ZENURL = "PROPTYPE") [ InitialExpression = "Header" ];
Property methods: propTypeDisplayToLogical(), propTypeGet(), propTypeIsValid(), propTypeLogicalToDisplay(), propTypeLogicalToOdbc(), propTypeNormalize(), propTypeSet()
property tipAddCondition as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Add a condition") ];
Property methods: tipAddConditionDisplayToLogical(), tipAddConditionGet(), tipAddConditionIsValid(), tipAddConditionLogicalToDisplay(), tipAddConditionLogicalToOdbc(), tipAddConditionNormalize(), tipAddConditionSet()
property tipAddValue as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Add a display value") ];
Property methods: tipAddValueDisplayToLogical(), tipAddValueGet(), tipAddValueIsValid(), tipAddValueLogicalToDisplay(), tipAddValueLogicalToOdbc(), tipAddValueNormalize(), tipAddValueSet()
property tipHelp as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Display message search help") ];
Property methods: tipHelpDisplayToLogical(), tipHelpGet(), tipHelpIsValid(), tipHelpLogicalToDisplay(), tipHelpLogicalToOdbc(), tipHelpNormalize(), tipHelpSet()
property tipRemoveCondition as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Remove this condition") ];
Property methods: tipRemoveConditionDisplayToLogical(), tipRemoveConditionGet(), tipRemoveConditionIsValid(), tipRemoveConditionLogicalToDisplay(), tipRemoveConditionLogicalToOdbc(), tipRemoveConditionNormalize(), tipRemoveConditionSet()
property tipRemoveValue as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Remove this value") ];
Property methods: tipRemoveValueDisplayToLogical(), tipRemoveValueGet(), tipRemoveValueIsValid(), tipRemoveValueLogicalToDisplay(), tipRemoveValueLogicalToOdbc(), tipRemoveValueNormalize(), tipRemoveValueSet()


method %OnAfterCreatePage() as %Status
Inherited description: Avoid writing out the session cookie if we are in a Studio session.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog.
classmethod GetHelpURL() as %String [ ZenMethod ]
Return a link to the search filter documentation. We use Link() to ensure we include the server prefix.
classmethod GetOptions(pContextSearch As %String, pParms As %ZEN.proxyObject, pTopOptions As %ZEN.proxyObject, pOptions As %ZEN.proxyObject) as %String [ ZenMethod ]
Wrapper method around %ZEN.Portal.ContextSearch which ensures that we avoid using search keys. It returns the results to the client in %ZEN.proxyObject instances.
clientmethod addCondition(draw, displayOnly) [ Language = javascript ]
Add a Condition to the current Term. draw indicates whether the conditions should be redrawn.
clientmethod adjustSize() [ Language = javascript ]
Adjust size and position of components on this page, provided resize handling is not disabled.
clientmethod buildConditionArray() [ Language = javascript ]
Rebuild the local Condition array based on the Conditions in the Message Viewer window. Note that the local array contains clones of the parent data to ensure that discarded changes don't affect the original values.
clientmethod changeClass(newVal) [ Language = javascript ]
Method to reinitialise the conditions when the class type is changed. newVal is the new class name.
clientmethod changeCondition(index, property, newVal) [ Language = javascript ]
Utility method to change properties of the local conditions. index is the index of the condition; property is the name of the property; newVal is the new value.
clientmethod changeEnabled(newVal) [ Language = javascript ]
clientmethod changePropType(newVal) [ Language = javascript ]
Method to reinitialize the local conditions list and display when the property type is changed. newVal is the new property type.
clientmethod drawClassSelector() [ Language = javascript ]
Helper method to draw the class selection component, which is generally an "HTML-selector", but may also be a disabled text box when we are performing a Header search.
clientmethod drawConditions() [ Language = javascript ]
Render the current list of conditions on the client.
clientmethod drawSelector(htmlArray, inputId, value, onchange, size, title) [ Language = javascript ]
Helper method to create an HTML-based selector component which behaves much like the core %ZEN.Portal.selector component.
clientmethod getDialogValue() [ Language = javascript ]
Insert the criteria into the parent's Filter object.
clientmethod getJoins(htmlFormat, selected) [ Language = javascript ]
Return the supported joins in an array. The htmlFormat flag indicates whether the values should be returned as an array of <option> elements. selected contains the value of the currently selected value, if any.
clientmethod getOperators(htmlFormat, selected) [ Language = javascript ]
Return the supported operators in an array. The htmlFormat flag indicates whether the values should be returned as an array of <option> elements. selected contains the value of the currently selected value, if any.
clientmethod hideAllOptions(checkVisible) [ Language = javascript ]
Helper method to ensure that all selector modals are hidden.
clientmethod hideOptions(inputName) [ Language = javascript ]
Hide the selector modal for a specified input control.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when a popup page has specified this component as its parent and fires an action.
popupName is the name of the popup window sending the action.
action is the name of the action.
value is the value associated with the action.
clientmethod ondialogFinish(action) [ 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. Set a flag to indicate that the changes should be applied.
clientmethod ondialogStart() [ Language = javascript ]
Ensure that we have been opened from the Message Viewer.
clientmethod onresizeHandler() [ Language = javascript ]
Ensure that we hide any modal divs to avoid nasty geometry problems.
clientmethod onunloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
clientmethod pickOption(inputName, pickedValue) [ Language = javascript ]
Callback to ensure that we pick up the chosen value and hide the modal div containing the options.
clientmethod removeCondition(index) [ Language = javascript ]
Remove a condition from the local conditions list.
clientmethod showFinder(type, position, condition) [ Language = javascript ]
Helper method to load a finder dialog for picking VDoc information. type specifies the property type, which should be either 'VDocPath' or 'VDocSegment'. position indicates whether it is the first or second part of the property. condition is the index of the condition being changed.
clientmethod showHelp() [ Language = javascript ]
Open the search filter documentation in a new window .
clientmethod showOptions(inputName) [ Language = javascript ]
Display the options for a selector based on the name of the input control passed in inputName. This also hides all other visible selector modals, and will hide this control if it was already visible. The method will also check whether we have enough information to fetch the contents. If not, we report an error and return.
clientmethod updateVDocValues(index) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods