WebExpressionPrompt

The WebExpressionPrompt allows users to build generic expressions as an answer to the prompt. The prompt designer defines the expression type such as metric qualification, attribute form qualification, or a hierarchical prompt. The possible expression types are the following subsets from the EnumDSSXMLExpressionType: DSSXmlFilterSingleMetricQual, DSSXmlFilterAttributeIDQual, DSSXmlFilterAttributeDESCQual, and DSSXmlFilterAllAttributeQual.  From an API standpoint, any expression can be built as an answer to an expression prompt without considering the expression type specified by the prompt designer..

The prompt designer can optionally provide the Origin property that is typically used in obtaining a list of objects that can be used in building the expression. The Origin property can be a WebSearch, WebFolder, WebAttribute, WebDimension, or WebMetric. In case of a search object, the user can modify the search criterion that is used in generating the available object list. The search object can also be used to incrementally fetch the available object list. If the Origin property is missing, the WebExpressionPrompt object sets the Origin property to be a search object that returns all the objects of type dimension and folder under the system folder Data Explorer. This is considered as the all hierarchies prompt. The users can then modify the search object as they wish. For example, they can search for all objects of type dimension in the project root.

The expression prompt also exposes an optional property DefaultForm. In case of expression prompts of type attribute form qualification, the prompt designer can optionally indicate a default attribute form that the GUI highlights when presenting available forms for an attribute. In this case, the Origin property is of type WebAttribute, which indicates that there is only one attribute that can be used to build the expression. The application shows this form as highlighted if the user does not explicitly highlight any other attribute form.