<search>
Mechanism to search record data. This tag is specifically meant to add search capabilities to the display view of a board.
This tag is more flexible and allows searching across multiple fields, the use of multiple search tags, and searching over ranges. When multiple search tags are used, the criteria from all the active search tags must be met.
When this tag is combined with the <searchbutton> and <clearsearchbutton> tags, you can set up a more customized look.
Attribute | Allowed Values | Requirements | Description |
---|---|---|---|
showcalendar |
(false|true)false |
Implied |
Displays the calendar control, allowing easy date entry when searching datetime fields. The default is set to false. |
slowclear |
(false|true)false |
Implied |
Displays the local Clear Search button, allowing users to clear filters. For backwards compatibility, the default is set to false. Add this button using one of the following two methods:
|
field |
%fieldname |
Optional |
Name of the field; use child <field> tags for multiple fields. |
range |
(false|true)false |
Implied |
Searches a range of values entered via two text boxes. The default is set to false. If set to true, a second text box appears to allow both a "from" and "to" value to be specified. |
rangetext |
(CDATA) "to" |
Optional |
Text that appears between the range's from and to text boxes. The default is set as to. |
cleartext |
(CDATA) "Clear Search" |
Implied |
Text that appears in the local Clear Search button. The default is set to Clear. |
searchtext |
(CDATA) "Search" |
Implied |
Text that appears in the local Search button. The default is set to Search. |
exact |
(false|true)false |
Implied |
Whether the search is an exact match or just contains the search string. If true, the entire string must be present in the record; the entire word or the first part of the word must be matched. |
searchgroup |
Text |
Optional |
Enables multiple search tags to be combined into a single group, allowing users to retrieve records that meet any of the specified conditions. This feature expands the search scope by applying the OR logical operator. |
Example
<search field="description" exact="false" range="false" rangetext="false"
showcalendar="false" showclear="true" searchtext="Find">
<field name="Priority"/><field name="Name"/><field name="Status"/>
</search>
<clearsearchbutton/>
<field>
Use child <field> tags to include more than one field in the <search> tag. You can allow your users to search by values that reside in child records by adding the table attribute to the <field> tag and specifying the appropriate table as the value.