Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
wiki:search_config [2012/01/13 11:10] tony |
wiki:search_config [2017/12/12 17:14] (current) admin |
||
|---|---|---|---|
| Line 5: | Line 5: | ||
| There are four approaches: | There are four approaches: | ||
| * a toolbar searching | * a toolbar searching | ||
| - | * a custom searching | + | * a custom searching |
| * a single field searching | * a single field searching | ||
| * a more complex approach involving many fields and conditions - advanced searching | * a more complex approach involving many fields and conditions - advanced searching | ||
| Line 49: | Line 49: | ||
| |attr|object|attr is object where we can set valid attributes to the created element. By example: \\ attr : { title: "Some title" } \\ Will set a title of the searched element| | |attr|object|attr is object where we can set valid attributes to the created element. By example: \\ attr : { title: "Some title" } \\ Will set a title of the searched element| | ||
| |searchhidden|boolean| By default hidden elements in the grid are not searchable . In order to enable searching when the field is hidden set this option to true| | |searchhidden|boolean| By default hidden elements in the grid are not searchable . In order to enable searching when the field is hidden set this option to true| | ||
| - | |sopt|array|This option is used only in advanced single field searching and determines the operation that is applied to the element. If not set all the available options will be used. All available option are: \\ ['eq','ne','lt','le','gt','ge','bw','bn','in','ni','ew','en','cn','nc'] \\ The corresponding texts are in language file and mean the following: \\ ['equal','not equal', 'less', 'less or equal','greater','greater or equal', 'begins with','does not begin with','is in','is not in','ends with','does not end with','contains','does not contain'] \\ Note that the elements in sopt array can be mixed in any order.| | + | |sopt|array|This option is used only in advanced , single and toolbar field searching and determines the operation that is applied to the element. If not set all the available options will be used. When used in toolbar searching the first element is used. All available option are: \\ ['eq','ne','lt','le','gt','ge','bw','bn','in','ni','ew','en','cn','nc'] \\ The corresponding texts are in language file and mean the following: \\ ['equal','not equal', 'less', 'less or equal','greater','greater or equal', 'begins with','does not begin with','is in','is not in','ends with','does not end with','contains','does not contain'] \\ Note that the elements in sopt array can be mixed in any order.| |
| |defaultValue|string|If not empty set a default value in the search input element.| | |defaultValue|string|If not empty set a default value in the search input element.| | ||
| |value|mixed| The option is used only for stype select and defines the select options in the search dialogs. When set for stype select and dataUrl option is not set, the value can be a string or object. \\ If the option is a string it must contain a set of value:label pairs with the value separated from the label with a colon (:) and ended with(;). The string should not end with a (;)- editoptions:{value:"1:One;2:Two"}.If set as object it should be defined as pair value:name - editoptions:{value:{1:'One',2:'Two'}} | | |value|mixed| The option is used only for stype select and defines the select options in the search dialogs. When set for stype select and dataUrl option is not set, the value can be a string or object. \\ If the option is a string it must contain a set of value:label pairs with the value separated from the label with a colon (:) and ended with(;). The string should not end with a (;)- editoptions:{value:"1:One;2:Two"}.If set as object it should be defined as pair value:name - editoptions:{value:{1:'One',2:'Two'}} | | ||
| + | |clearSearch|boolean|When set to false the X icon at end of search field which is responsible to clear the search data is disabled. the default value is true| | ||
| <note>Note: when the dataUrl in searchoptions object is not used for the search type select, the definitions for the select are taken first from searchoptions value property and if this is not defined a editoptions value property is used- i.e editoptions:{value:"1:one;2:two",...}. See below how to use these options in different search methods.</note> | <note>Note: when the dataUrl in searchoptions object is not used for the search type select, the definitions for the select are taken first from searchoptions value property and if this is not defined a editoptions value property is used- i.e editoptions:{value:"1:one;2:two",...}. See below how to use these options in different search methods.</note> | ||
| Line 108: | Line 109: | ||
| |custom|boolean| if set to true allow definition of the custom checking rules via a custom function. See below| | |custom|boolean| if set to true allow definition of the custom checking rules via a custom function. See below| | ||
| |custom_func|function| this function should be used when a custom option is set to true. Parameters passed to this function are the value, which should be checked and the name - the property from colModel. The function should return array with the following parameters: first parameter - true or false. The value of true mean that the checking is successful false otherwise; the second parameter have sense only if the first value is false and represent the error message which will be displayed to the user. Typically this can look like this [false,"Please enter valid value"]| | |custom_func|function| this function should be used when a custom option is set to true. Parameters passed to this function are the value, which should be checked and the name - the property from colModel. The function should return array with the following parameters: first parameter - true or false. The value of true mean that the checking is successful false otherwise; the second parameter have sense only if the first value is false and represent the error message which will be displayed to the user. Typically this can look like this [false,"Please enter valid value"]| | ||
| + | |||
| + | <note warning>“The searchrules will be used only in the searching dialog, but not in the searching filter…..” according to the following link by Oleg [http://stackoverflow.com/a/9011733]</note> | ||
| === Custom Checking example=== | === Custom Checking example=== | ||
| Line 129: | Line 132: | ||
| </script> | </script> | ||
| </code> | </code> | ||
| - | |||
| ===== What you need to know ===== | ===== What you need to know ===== | ||
