Grid Component Search Part

IN THIS PAGE

Description

A guide to all of the options available in the grid component search part.

Hide Grid Part Options

 Hide Grid when no search active

If no search is active, should the 'Grid' part of the component be hidden? If you check this option, the initial load of the component will be faster.

 Text to display when grid is hidden

Specify the text be be shown in place of the Grid part when no search is active

Search Options

 Show title

Show a title above the Search part? (Note: 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 requery showing 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

Specify the type of search to perform. 1 = 'Exact Match' (may or may not be case sensitive - depends on the database), 2 = 'Is Contained In', 3 = 'Starts with' 4 = 'Wildcard' - user must explicitly enter wildcard characters '*', '%' 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). For databases that are case-sensitive, you can use 11, 12, 13 or 14 for case-insensitive versions of the 1, 2, 3, or 4 option.

 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: CA,MA to search for "CA" and "MA", 123..345 to search for >=123 and <=345, ..12/3/2004 to search for dates <=12/3/2004.

 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 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. 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

Help button icon property

 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. NOTE: 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.

  • Above titles

  • 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 excpetions: 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

  • Single free-form region

 Free-form search template

Specify the free-form search template.

 Display search/clear icons in row selector

Specify if 'Search' and 'Clear Search' icons shold 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.

Save and Load Searches

 Allow user to save search criteria

Specify if the user can save search criteria in the Search Part form. The search criteria are saved in the Repository. To configure the Repository, go to Project Properties on the Web Projects Control Panel.

 Allow user to load search criteria

Specify if the user can load previously saved search criteria into the Search Part form. The search criteria are loaded from the Repository. To configure the Repository, go to Project Properties on the Web Projects Control Panel.

 Load search prompt

Specify the prompt to display on the dialog where the user is prompted for the name of the saved search to load.

 Save search prompt

Specify the prompt to display on the dialog where the user is prompted for the name to give the search criteria when they are saved to the Repository.

 Load search button bubble-help

Specify button bubble-help

 Execute search on load

When loading a saved search, should it be immediately executed?

 Save search button bubble-help

Specify button bubble-help

 Listbox heading

Specify the text to show above the listbox where the existing saved searches are shown.

 Listbox height

Specify the height of the listbox that shows the existing saved searches. Use CSS syntax (e.g. 1in, 100px, etc.)

 Dialog width

Specify the approximate width of the dialog. Use CSS syntax (e.g. 2in, 300px, etc).

 Auto-load choices

When the user opens the dialog to load/save a search, should the list of existing saved searches be populated, or should this be deferred until the user explicitly requests that the list be populated.

 Prompt to load text

Specify the text for the prompt to populate the listbox showing existing saved searches.

 Load search button

Load search button property

 Save search button

Save search button property

 Cancel button

Cancel button property

 Warning message - blank name

Specify the warning message to show if the user tries to save search criteria without specifying the name to assign to the save criteria.

 Warning message - duplicate name

Specify the error message to show if the user tries to save search criteria using a duplicate name.

Sort Options

 Include 'Sorting' listbox

Specify whether the Search part includes a listbox to allow users to select the sort order for the data.

 Label for 'Sorting' listbox

Specify the label for the 'Sorting' listbox.

 Label position

Specify the position for the label for the 'Sorting' listbox.

  • Left

  • Above

 Inline style for 'Sorting' label

Specify the inline style for the row label.

 'Sort' listbox default

Specify the option to show in the listbox when the user has not selected a value.

 Use column headings in sort listbox

Specify if column headings should be used listbox instead of field names.

 'Order' listbox options

Specify the choices that appear in the 'Order' listbox. The first option is for Ascending order, and the second option is for Descending order.

 'Order' listbox default

Specify the option to show in the 'Order' listbox when the user has not selected a value.

Records per Page Listbox Options

 Include 'Records per Page' listbox

Include a listbox that allows the user to select how many records should be displayed on each page if a search returns more than one record.

 Label for 'Records per Page' listbox

Specify the label for the 'Records per Page' listbox.

 Label position

Specify the position for the label for the 'Records per Page' listbox.

  • Left

  • Above

 Inline style for 'Records per Page' label

Specify the inline style for the row label.

 'Records per Page' listbox choices

Specify the choices that appear in the 'Records per Page' listbox. Enter a comma delimited list of values. For example: 1,5,10

 'Records per Page' listbox default

Specify the option to show in the listbox when the user has not selected a value.

Freeform Edit Regions

 Above search part

You can enter any HTML to appear above the Search part of the component.

 Below search part

You can enter any HTML to appear below the Search part of the component.

 Left of search part

You can enter any HTML to appear left of the Search part of the component.

 Right of search part

You can enter any HTML to appear right of the Search part of the component.

Customization

 Inline style

Specify the inline style for the Search part's tag.

 Table tag attributes

Specify optional attributes to insert into the Search part's tag.

Javascript - Other

 Watch events

Watch events are executed whenever a value in a 'watched' control in the Search part is changed.