Code On Time: Data Field Search Options Index

Blog

Tuesday, September 20, 2016Print Subscribe

The Search Options data field property restricts and reorders the search options available to the end user on the Advanced Search Bar.

The search options available are dependent on the field type.

Below is a table of all search options and their description.

Numeric Filters

Search Option	Text	Description
=	Equals	The search will find exact matches of the parameter
<>	Does Not Equal	The search will exclude all exact matches of the parameter
<=	Less Than	The search will include all results that are less than the parameter
>=	Greater Than	The search will include all results that are greater than the parameter
$between	Between	The search will include all results that are between two parameters
$in	Includes	The search will include all selected parameters (will open a modal window to select items)
$notin	Does Not Include	The search will exclude all selected parameters (will open a modal window to select items)

Text Filters

Search Option	Text	Description
=	Equals	The search will find exact matches of the parameter
<>	Does Not Equal	The search will exclude all exact matches of the parameter
$beginswith	Begins With	The search will find all matches that begin with the parameter
$doesnotbeginwith	Does Not Begin With	The search will exclude all matches that begin with the parameter
$contains	Contains	The search will find all matches that contain the parameter
$doesnotcontain	Does Not Contain	The search will find all matches that do not contain the parameter
$endswith	Ends With	The search will find all matches that end with the parameter
$doesnotendwith	Does Not End With	The search will exclude all matches that end with the parameter
$in	Includes	The search will include all selected parameters (will open a modal window to select items)
$notin	Does Not Include	The search will exclude all selected parameters (will open a modal window to select items)

Logical Filters

Search Option	Text	Description
$true	Yes	The search will find all results that equal “True”.
$false	No	The search will find all results that equal “False”.

Date Filters

Search Option	Text	Description
=	Equals	The search will find exact matches of the parameter
<>	Does Not Equal	The search will exclude all exact matches of the parameter
<	Less Than	The search will include all results that are less than the parameter
>	Greater Than	The search will include all results that are greater than the parameter
$between	Between	The search will include all results that are between two parameters
$in	Includes	The search will include all selected parameters (will open a modal window to select items)
$notin	Does Not Include	The search will exclude all selected parameters (will open a modal window to select items)
$tomorrow	Tomorrow	The search will find all results that match the day preceding the current date.
$today	Today	The search will find all results from the current date.
$yesterday	Yesterday	The search will find all results that match the day after the current date.
$nextweek	Next Week	The search will find all results that match the week preceding the current week.
$thisweek	This Week	The search will find all results from the current week.
$lastweek	Last Week	The search will find all results that match the week after the end of the current week.
$nextmonth	Next Month	The search will find all results that match the month preceding the current month.
$thismonth	This Month	The search will find all results from the current month.
$lastmonth	LastMonth	The search will find all results that match the month after the end of the current month.
$nextquarter	Next Quarter	The search will find results that match the quarter after the current one.
$thisquarter	This Quarter	The search will find results that match the current quarter.
$lastquarter	Last Quarter	The search will find results that match the quarter before the current one.
$nextyear	Next Year	The search will find results that match the year after the end of the current one.
$thisyear	This Year	The search will find results in the current year.
$yeartodate	Year To Date	The search will find results from the beginning of the current year up to the current date.
$lastyear	Last Year	The search will find results that match the year before the beginning of the current one.
$Past	Past	The search will find all results before the current date.
$Future	Future	The search will find all results after the current date.
$quarter1	All Dates In Period: Quarter 1	The search will find all results in the first quarter.
$quarter2	All Dates In Period: Quarter 2	The search will find all results in the second quarter.
$quarter3	All Dates In Period: Quarter 3	The search will find all results in the third quarter.
$quarter4	All Dates In Period: Quarter 4	The search will find all results in the fourth quarter.
$month1	All Dates In Period: January	The search will find all results in the month of January.
$month2	All Dates In Period: February	The search will find all results in the month of February.
$month3	All Dates In Period: March	The search will find all results in the month of March.
$month4	All Dates In Period: April	The search will find all results in the month of April.
$month5	All Dates In Period: May	The search will find all results in the month of May.
$month6	All Dates In Period: June	The search will find all results in the month of June.
$month7	All Dates In Period: July	The search will find all results in the month of July.
$month8	All Dates In Period: August	The search will find all results in the month of August.
$month9	All Dates In Period: September	The search will find all results in the month of September.
$month10	All Dates In Period: October	The search will find all results in the month of October.
$month11	All Dates In Period: November	The search will find all results in the month of November.
$month12	All Dates In Period: December	The search will find all results in the month of December.

The “All Dates In Period” search options will include intervals from five years ago to one year ahead.

There are also several modifiers that can be used to change the behavior of the data field.

Search Option	Description
$autocompleteanywhere	Auto complete in fields can be configured to search anywhere in field values, instead of using “begins with” matching.
$disableautocomplete	Text search options will no longer offer auto complete capabilities.
$disablemultiplevalues	The “Filter…” option under the column header will be removed – users will not be able to filter by multiple values.
$disablesamples	Quick filtering samples under the column header will be removed.
$quickfind	Will exclusively filter fields tagged with “$quickfind” when using Quick Find.
$quickfinddisabled	Will exclude fields tagged with “$quickfinddisabled” when using Quick Find.

Labels: Designer, User Interface, Web Application Generator