TIWCGJQGridCustomSearch Class
The TIWCGJQGridCustomSearch class
The TIWCGJQGridCustomSearch type exposes the following members.
| Name | Description | |
|---|---|---|
 | Create(TCollection) | |
| CreateSingle(TPersistent,string) | |
| Destroy | Represents the destructor of the TIWCGJQGridCustomSearch class. (Overrides TIWCGJSon.Destroy.) |
| Name | Description | |
|---|---|---|
 | Active | if the Custom Search will be activated |
| AutoSearch | When set to true the behavior is as follows: When the user input some value in the input element they can press enter and the search is activated. When a select box is used search is activated when the values of select is changed. When set to false we can use the button to perform the search. |
| ButtonClass | class that can be applied to the buttons |
| CGJSContainer | Represents property |
 | ClassData | Represents property |
| ClearButton | the label of the button that clears the already-entered values |
| EnableClear | enable/disable the clear button |
| EnableSearch | enable/disable the search button |
| FilterModel | The filter model should be used when gridModel is set to false filterModel [ … {label:'LableFild', name: 'colname', stype: 'select', defval: 'default_value', surl: 'someurl', sopt:{optins for the select}}, … label: the label of the field (text description) name: the name of the column - should equal of the name in colModel. Note that we search on the index of that coulmn. stype: type of input element - can be only 'text' or 'select' defval: default value for the search input element. surl: used only when stype is 'select'; this is a url from where we can get an already-constructed select element - i.e. we expect the following html content: <select> <option value='val1'> Value1 </option> <option value='val2'> Value2 </option> … <option value='valn'> ValueN </option> </select> sopt: valid options that can be applied to the element, the same as editoptions from colModel. |
| FormClass | the class that can be applied to the form |
| FormType | defines how the form should be constructed. Can be 'horizontal' or 'vertical' |
| Grid | Represents property |
| GridModel | when set to true, we use the parameters from colModel to construct the search, using the following options from colModel: name, index, edittype, editoptions, search. Additional parameters can be set in colModel to meet the needs only of this method. These specific parameters are: defval: default value for the search field this will be set as initial search. surl: valid only if edittype:'select'; url from where we can get already-constructed select element - e.g., we expect the following html content (square brackets have been substituted for angle brackets so we can see the code): <select> <option value='val1'> Value1 </option> <option value='val2'> Value2 </option> … <option value='valn'> ValueN </option> </select> Only fields with search: true are attached to the form. Hidden elements are not included. When false we should construct a filterModel (see below) to perform a search. |
| GridNames | this option works only if gridModel is true. When set to true we use the names from colNames as labels for the search fields. |
| GridToolbar | Deprecated. Use filterToolbar method instead |
| InstList | Represents property |
| IsStored | Represents property |
| JSon | Return the Interface of SuperObject (ISuperObject) (Inherited from TIWCGJSon.) |
| JSonEvents[string] | Represents property |
| List | Represents property |
| MarkSearched | when set to true, after a search every column to which search is applied is marked as searchable - e.g., in the upper left corner of the column header a marker is set to indicate that this column is part of the applied search. When we clear the values the markers disappear. Not applicable in 3.5 release |
| MemberList | Represents property |
| OnAfterClear | event which fires after clearing entered values |
| OnAfterSearch | event which fires after the search is performed |
| OnBeforeClear | event which fires before clearing entered values (i.e when clear button is clicked) |
| OnBeforeSearch | event which fires before a search |
| Owner | Represents property |
| PropCount | Represents property |
| PropIndexByName[string] | Represents property |
| PropList | Represents property |
| PropName | Represents property |
| PropNameByIndex[Integer] | Represents property |
| Region | Region where the Custom Search fields will be shown |
| SearchButton | the label of the button that performs the search. (Note - this label does not come from the language files, since the intention is to separate this method so that it can be used anywhere - i.e. without using jqGrid) |
| SObj | Represents property |
| TableClass | the class that can be applied to the table (the table is a child of form element) |
| Url | a separate url for searching values |
| Name | Description | |||
|---|---|---|---|---|
 | AddBooleanMember(string,Boolean,Boolean,Boolean) | Represents method | ||
| AddColorMember(string,TIWCGColor,Boolean,Boolean) | Represents method | ||
| AddCurrencyMember(string,Currency,Boolean,Boolean) | Represents method | ||
| AddDoubleMember(string,Double,Boolean,Boolean) | Represents method | ||
| AddDynObjListMember(string,Boolean,Boolean) | Represents method | ||
| AddEnumMember(string,string[],Byte,Boolean,Boolean) | Represents method | ||
| AddEnumSetMember(string,string[],Void,Word,Boolean,Boolean) | Represents method | ||
| AddFuncMember(string,string,string,Boolean,TIWCGJSonFuncClass,Boolean,Boolean) | Represents method | ||
| AddHTML5(TIWHTMLTag) | Represents method | ||
| AddIntegerMember(string,Integer,Boolean,Boolean) | Represents method | ||
| AddJSonMember(string,TCGJSon,Boolean,Boolean) | Represents method | ||
| AddMembers | The procedure add jquery properties.
| ||
| AddObjListMember(string,TIWCGJSonListClass,Boolean,Boolean,Boolean) | Represents method | ||
| AddObjMember(string,TIWCGJSonClass,Boolean,Boolean,Boolean) | Represents method | ||
| AddSimpleArrayMember(string,Boolean,Boolean,Boolean) | Represents method | ||
| AddStringMember(string,string,Boolean,Boolean) | Represents method | ||
| AddVariantMember(string,Variant,Boolean,Boolean) | Represents method | ||
| AfterConstruction | Represents method | ||
| Assign(TPersistent) | Represents method | ||
| CheckJSonMember(Integer) | Represents method | ||
| ConvertEnumToString(string) | Represents method | ||
| ConvertSetToString(string,TCGStringArray) | Represents method | ||
| FreeJSonObj(Integer) | Overloaded. Represents method | ||
| FreeJSonObj(string) | Overloaded. Represents method | ||
| GetBooleanValue(Integer) | Represents method | ||
| GetCGJSContainer | Represents method | ||
| GetColorValue(Integer) | Represents method | ||
| GetCurrencyValue(Integer) | Represents method | ||
| GetCustomJq(string,ISuperObject) | Represents method | ||
| GetDoubleValue(Integer) | Represents method | ||
| GetDynObjListValue(Integer) | Represents method | ||
| GetEnumAsString(Integer) | Represents method | ||
| GetEnumerValue(Integer) | Represents method | ||
| GetEnumSetValue(Integer,Pointer) | Represents method | ||
| GetFixedScript(TIWCGJSonFunc,Boolean) | Represents method | ||
| GetFuncValue(Integer) | Represents method | ||
| GetHTMLName | Represents method | ||
| GetImplComponent | Represents method | ||
| GetIntegerValue(Integer) | Represents method | ||
| GetIsStored | Represents method | ||
| GetItemIndex | Represents method | ||
| GetIWCLName | Represents method | ||
| GetJSon | Represents method | ||
| GetJSonByType(Boolean,Boolean) | Represents method | ||
| GetJSonEx(Boolean,Boolean,TIWCGResponseMemberList,Boolean) | Represents method | ||
| GetJSonValue(Integer) | Represents method | ||
| GetJSonValueObj(Integer) | Represents method | ||
| GetMemberJSon(TCGJSonMember,ISuperObject,Boolean,Boolean,string) | Represents method | ||
| GetMemberSetterHandler(TObject,TCGJSonMember) | Represents method | ||
| GetMemberSetterScriptParts(TIWCGResponseMemberList,TIWCGJScript) | Represents method | ||
| GetMembersJSon(TIWCGResponseMemberList,Boolean,Boolean) | Represents method | ||
| GetObjListValue(Integer) | Represents method | ||
| GetObjValue(Integer) | Represents method | ||
| GetOwner | Represents method | ||
| GetPropName | Represents method | ||
| GetSimpleArrayValue(Integer) | Represents method | ||
| GetStringValue(Integer) | Represents method | ||
| GetVariantValue(Integer) | Represents method | ||
| InternalGetJSon(TEachPropJSonProc,Boolean,Boolean,Void,Boolean,Boolean,TIWCGResponseMemberList,Boolean) | Represents method | ||
 | IsArray | Represents method | ||
| IsBooleanStored(Integer) | Represents method | ||
| IsColorStored(Integer) | Represents method | ||
| IsCurrencyStored(Integer) | Represents method | ||
| IsDoubleStored(Integer) | Represents method | ||
| IsEnumerStored(Integer) | Represents method | ||
| IsEnumSetStored(Integer) | Represents method | ||
| IsFuncStored(Integer) | Represents method | ||
| IsIntegerStored(Integer) | Represents method | ||
| IsJSonObjStored(string) | Represents method | ||
| IsJSonStored(Integer) | Represents method | ||
| IsObjStored(Integer) | Represents method | ||
| IsStringStored(Integer) | Represents method | ||
| IsVariantStored(Integer) | Represents method | ||
| JSonEscape | Represents method | ||
| JSonIdent | Represents method | ||
| JSonNameQuote | Represents method | ||
| ResetProps | Represents method | ||
| SetBooleanValue(Integer,Boolean) | Represents method | ||
| SetColorValue(Integer,TIWCGColor) | Represents method | ||
| SetCurrencyValue(Integer,Currency) | Represents method | ||
| SetDoubleValue(Integer,Double) | Represents method | ||
| SetDynObjListValue(Integer,TIWCGJSonDynObjList) | Represents method | ||
| SetEnumerValue(Integer,Byte) | Represents method | ||
| SetEnumSetValue(Integer,Pointer) | Represents method | ||
| SetFuncValue(Integer,TIWCGJSonFunc) | Represents method | ||
| SetIntegerValue(Integer,Integer) | Represents method | ||
| SetJSonValue(Integer,TCGJSon) | Represents method | ||
| SetObjListValue(Integer,TIWCGJSonList) | Represents method | ||
| SetObjValue(Integer,TIWCGJSon) | Represents method | ||
| SetSimpleArrayValue(Integer,TIWCGJSonSimpleArray) | Represents method | ||
| SetStringValue(Integer,string) | Represents method | ||
| SetVariantValue(Integer,Variant) | Represents method | ||
| StoreProperty(PPropInfo,TObject) | Represents method | ||
| SupportsSetter(TObject,TCGJSonMember) | Represents method |
