Search property

The attributes defined in the Search node will be displayed at runtime as a string to make text searches in the entity’s fields. The instance specifies the fields on which the search has to be performed.

Having the grid defined above, the search fields will be PropertyName and PropertyAddress. The implementation is an OR, that is to say, it returns any record that has that string in a field.

Run-time/Design-time

This property and associated node properties apply only at design-time.

Description

The criteria used for the default attributes added by GeneXus to the search are as follows:

1) It isn’t a “foreign” attribute (that is, FK, or inferred by FK).
2) It isn’t based on an enumerated domain.
3) It is of Character data type or variations (VarChar, LongVarChar)
4) It doesn’t belong to any of the following domains: Audio, Component, Feed, Geolocation, Phone, Video.
5) Therefore, the following predefined domains are included in the search: Address, Email, Html, Url

The ones not included by default, except for the Audio and Video domains, can be added to the Search.

All characters can be used to make a search.

Search node

Defines search criteria applied to the grid.

For adding new criteria you must:

1. On the Search label, right-click, select Add > Attribute.
2. Select the attribute will participate in the search criteria.
3. Set those properties that satisfy your requirements.

To remove an attribute from the Search, select the item, right-click, option Delete (or Delete key).

The Search node defines a set of properties for customizing the searching behavior.

Each node under a Search node will have two properties. 

Advanced Search node

Allows defining some filters for an advanced search. All the filters that have an entered value take part in the query, and an AND is applied among all filters. Those filters that don’t have entered values or the value is “All” when combos are involved, are not applied.

Process for adding or deleting filters are analogous to Search node.

This node has one property for indicating a display name when filtering.

A set of properties are available for customizing those filters defined over the selected attributes.

Notes: 

Depending on the data type, the kind of data entry offered to the user in order to filter:

• Value
  A value is requested and filtered with that attribute and value (there is an implied condition according to the data type).
   
• Range
  Two values are requested, and the attribute must be in that range (e.g.: the Listing Date filter on the example). If only one of the values in the range is entered (minimum or maximum), the records selected are those with the greater than or equal to condition, or lower than or equal to the entered value. The default instance adds this type of filters for all the attributes of Date type.
   
• Combo
  A value is selected from a fixed list, usually given by an enumerated domain (e.g.: the Operation filter). The search returns all the records that meet the condition of greater than or equal to the entered value. If only the records that met the equality condition are to be obtained, the Custom Condition property has to be configured with this value:

  <attribute> = <variable> when not <variable>.IsEmpty() 

  The default instance includes this type of filters for all the attributes based on an enumerated domain.
   
• Dynamic Combo 
  A value is selected from a dynamic list (given by another attribute). In GeneXus, they are dynamic combos (or prompts). The default instance includes this type of filters for all the attributes which are foreign keys.

Example

Based on the grid displayed during the introduction, the runtime behavior of such control will be as follows.

Notes

• Break By property on the Search node is available:
  - for iOS as of GeneXus 15 Upgrade 8.
  - for Android as of GeneXus 15 Upgrade 11
  previous versions only considers their respective default values.

Scope

Sample

This example is available on RealEstate.