Search Options Properties

Description

Search Options Properties

 Show title

Show a title above the Search part?

To enable the 'Show/Hide of Search part' prompt, you MUST display the search title.

 Title

Specify the title to be shown above the Search part.

 Title when hidden

Specify the title to show when the Search part is hidden.

 Enable show/hide of Search part

Can the user click on the Search part's title to hide/show the Search part?

 Show/hide button icon

Specify the icon for the show/hide button. This button appears in the title bar above the row selector column.

 Show/hide button bubble help

Specify the bubble help for the icon for the show/hide button. This button appears in the title bar above the row selector column.

 Animation

Specify if the Search Part should be animated when it is shown or hidden. You can choose different effects.

 Initial state

Initial state of the Search part when the page is displayed.

 Search button label

Specify the label for the 'Search' button.

 Use icon for search button

Should an icon be used for the search button? To customize the icon, go to Grid, Properties, Customization, Customize icons.

 Orientation

Specify if the Search fields are laid out vertically or horizontally.

 Has 'Clear Search' link

Specify if the Search part has a link to clear the search criteria and show all records.

 'Clear Search' label

Specify the text to show on the 'Clear Search' link.

 'Clear Search' bubble help

Specify the text to show on the 'Clear Search' link or button.

 Use icon for clear search link

Should an icon be used for the clear search link? To customize the icon, go to Grid, Properties, Customization, Customize icons.

 Search style

The Search style defines the default search behavior for the search fields. The search style can be overwritten for individual fields using the field's Display Settings > Search style property.

Search Style
Description
1

Performs an 'Exact Match' search. A field only matches if it exactly matches the search criteria. Exact Match may or may not perform a case insensitive search -- case-sensitive matching is database specific.

2

Performs an 'Is Contained In' search. Search criteria matches if it is contained in the field.

3

Performs a 'Starts with' search. Search criteria matches if the field starts with the search criteria.

4

Performs a 'Wildcard' search. The user can enter wildcard characters in their search terms. Wildcard characters include '*', '%' or '?'. If QBE syntax is turned on you can enter multiple wildcard criteria, delimited with either a comma or && - use && to combine criteria with an AND clause.

11

Performs a case-insensitive 'Exact Match'.

12

Performs a case-insensitive 'Is Contained In' search.

13

Performs a case-insensitive 'Starts with' search.

14

Performs a case-insensitive 'Wildcard' search.

 Search rules

Specify rules when Grid supports multiple types of searches (e.g. Quick search, Alphabet button, Search Part, and Query by Example searches).

 Show single 'Keyword' search field

Instead of showing individual search fields, show a single search field. If a match is found in any of the search fields, the record is returned.

 Allow 'Query By Form' syntax

Support Alpha Five's QBF syntax. For example, the following will search for "CA" and "MA":

CA,MA

Range searches can be performed using QBF syntax. For example, to search for all values between 123 and 345:

123..345

This same syntax can be used with dates. This example will search for dates <=12/03/2014:

..12/3/2014

 QBF Operator Exceptions

The 'Query By Form' operators are: .. (two dots), , (comma), >, >=, <, <= and =. You can specify that you want to treat some of these operators as literal strings. Enter a pipe delimited list of exclusions. For example, if you enter

..|=

this indicates that the .. (two dots) operator and the = sign should be treated as literal strings, not search operators.

 Combine search criteria using

If user enters search criteria into multiple fields, combine using 'AND', or 'OR'. Select 1 for 'AND', or 2 for 'OR'.

 Keyword search field label

Specify the label for the keyword search field.

 Disable browser auto-complete feature

In most browsers, when you type into a search field, the browser will try to auto-complete your entry. You can disable this behavior in the browser.

 Toolbar position

The Search Toolbar contains the 'Search' and 'Clear Search' buttons. Specify if the toolbar should be shown above or below the search fields. The toolbar position can be set to one of the following:

Toolbar Position
Description
Above

Toolbar is shown above the search fields.

Below

Toolbar is shown below the search fields.

None

The toolbar is not shown.

If you select 'None', the toolbar is not shown. The 'None' choice is only appropriate if you are using cascading DropdownBoxes and you have set the last DropdownBox to 'Auto-Submit' the search, or you have designed a free-form search with your own custom button to submit the search. Your custom button must have this Javascript in its 'onClick' event:

{grid.object}.submitSearchForm(); return false;

 Help window

Specify if an icon should be shown in the Toolbar to open a window that displays help for this component.

 Help ID

Specify the ID of the help text to display in the window.

 Help button icon

The icon shown for the Help button.

 Help button bubble help

Specify the bubble help for the help button icon.

 Search highlighting

Specify whether, when the user does a Search, Quick Search, or QBE Search, if the search strings should be highlighted in fields in the Grid in which they were found.

Search highlighting only applies to Label controls.

 Embed search in Grid part

Specify if the search part should be embedded in the Grid part.

 Position in Grid

Specify where in the Grid the Search part should be embedded. The Search part can be embedded either Above or Below the Grid component titles.

Above titles

Search part is shown above titles.

Below titles

Search part is shown below titles.

 Has free-form layout

Specify if the embedded Search Part uses a free-form layout. If you check this you can define a single free-form region, or a free-form region above each column. If you do not check this, the standard Search Part that you have defined is embedded in the Grid (with these exceptions: the 'sort by' and 'records per page' listboxes that optionally appear in the Search Part are turned off.)

 Free-form search style

Specify if there is a free-form region above each column in the Grid for search fields, or a single free-form region with a colspan that spans all of the Grid columns.

Free-form region for each column

A free-form region is defined for each column.

Single free-form region

A single free-form region spanning all Grid columns is defined.

 Free-form search template

Specify the free-form search template.

 Display search/clear icons in row selector

Specify if 'Search' and 'Clear Search' icons should be shown in the row selector column. If you do not include these buttons here then you will need to include them in at least one of the free-form search areas above each column.

 Search button icon

Specify the icon for the search button that is displayed in the row selector column.

 Search button bubble help

Specify bubble help for the icon for the search button that is displayed in the row selector column.

 Clear search button icon

Specify the icon for the clear search button that is displayed in the row selector column.

 Clear search button bubble help

Specify the bubble help for the icon for the clear search button that is displayed in the row selector column.