Filter: Difference between revisions

From BR Wiki
Jump to navigation Jump to search
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Grid and list]] filter search fields are available as of BR! [[4.3]].
Grid and list '''filter''' search fields are available as of BR! [[4.3]] for [[grids and lists]].


A new field type is defined (similar to SEARCH):
A new field type is defined (similar to [[SEARCH]]):
 
[[image:Filter.png|900px]]


  RINPUT FIELDS "nn,nn,15/FILTER 10,leading-attributes,row,col,grid column to search [, filter-type] [, CASE]": string-value
  RINPUT FIELDS "nn,nn,15/FILTER 10,leading-attributes,row,col,grid column to search [, filter-type] [, CASE]": string-value
For example:
RINPUT FIELDS "4,50,15/FILTER 10,,10,10,2,ALL": Findfield$
This example combines a filter box (which will search everything in the list) and the rinput fields for a list selection:
rinput fields "4,8,78/FILTER 30,/w:w,5,6,Fullrow,all;5,6,list 21/80,rowsub,selone": foundvar$,selection


===Parameters===
===Parameters===
Line 9: Line 19:
'''nn and nn''' are the row and column to position the field on the screen.
'''nn and nn''' are the row and column to position the field on the screen.


The '''15/ and 10''' in this example are standard notation for a 15 column field where the operator can enter 10 characters.  
'''Size/''' and '''Characters''' signifies how large the filter field will be in columns, and how many characters can be entered into it. In the example, '''15/ and 10''' provide a 15 column field where the operator can enter 10 characters.  


'''Leading attributes''' can be any attributes desired (optional).  
'''Leading attributes''' can be any attributes desired (optional).  
Line 15: Line 25:
'''Row and col''' are the starting row and column of the grid or list you wish to search.
'''Row and col''' are the starting row and column of the grid or list you wish to search.


'''Grid column to search''' is the number of the grid column the filter will test against. See [[#Tip|tip]] below.
'''Grid column to search''' is the number of the grid column the filter will test against. FULLROW can be used here to searchall the columns in each row.  


====Filter Types====
====Filter Types====
*LEADING - Filter searching is done left justified using only leading characters (default).
*LEADING - Filter searching is done left justified using only leading characters (default).
*WORD - Each word is leading matched.
*WORD - Each word is leading matched.
*ALL - The entire string is searched for a match similar to POS.
*ALL - The entire string is searched for a match (similar to [[POS]]).
 


'''CASE''' may optionally be used to make all searching case sensitive. Case insensitivity is the default.
'''CASE''' may optionally be used to make all searching case sensitive. Case insensitivity is the default.


'''String-value''' is the variable name.  
'''String-value''' is the variable name which will apply to whatever the operator enters into the field for searching.
 
For both FILTER and [[Srch]], the up and down arrows now affect only the selection bar in the grid/list being presented.
 
====Note====
 
* MASK can be used to query the Filter display, with a value of 1.


For both FILTER and [[SRCH|SEARCH]] the up and down arrows now affect only the selection bar in the grid/list being presented.
====See Also====


===Tip===
* [[Filter_Delimiters]]
To make all items in the list or grid searchable with the filter, a programmer may wish to add a 'secret' undisplayed column which contains all the information from each row, then by designating this column in the FILTER syntax, the operator will be able to search all the information at once.


<noinclude>
<noinclude>
[[Category:GUI]]
[[Category:Widget]]
[[Category:Grid and List]]
[[Category:Grid and List]]
</noinclude>
</noinclude>

Latest revision as of 16:15, 3 November 2015

Grid and list filter search fields are available as of BR! 4.3 for grids and lists.

A new field type is defined (similar to SEARCH):

RINPUT FIELDS "nn,nn,15/FILTER 10,leading-attributes,row,col,grid column to search [, filter-type] [, CASE]": string-value

For example:

RINPUT FIELDS "4,50,15/FILTER 10,,10,10,2,ALL": Findfield$

This example combines a filter box (which will search everything in the list) and the rinput fields for a list selection:

rinput fields "4,8,78/FILTER 30,/w:w,5,6,Fullrow,all;5,6,list 21/80,rowsub,selone": foundvar$,selection

Parameters

nn and nn are the row and column to position the field on the screen.

Size/ and Characters signifies how large the filter field will be in columns, and how many characters can be entered into it. In the example, 15/ and 10 provide a 15 column field where the operator can enter 10 characters.

Leading attributes can be any attributes desired (optional).

Row and col are the starting row and column of the grid or list you wish to search.

Grid column to search is the number of the grid column the filter will test against. FULLROW can be used here to searchall the columns in each row.

Filter Types

  • LEADING - Filter searching is done left justified using only leading characters (default).
  • WORD - Each word is leading matched.
  • ALL - The entire string is searched for a match (similar to POS).


CASE may optionally be used to make all searching case sensitive. Case insensitivity is the default.

String-value is the variable name which will apply to whatever the operator enters into the field for searching.

For both FILTER and Srch, the up and down arrows now affect only the selection bar in the grid/list being presented.

Note

  • MASK can be used to query the Filter display, with a value of 1.

See Also