Bean Software Search Control Documentation   
 
 

 

 
     




Class Members

Enumerations
Properties
Methods



Enumerations:

enuDefaultOperator Represents the enumeration used for DefaultOperator property. Used if TypeOfSearch property is set to Expression. If Text property of Search Control already contains boolean operator, then DefaultOperator property has no affect to search expression.
enuIfError

Represents behavior in case that Search Control can not build Where Clause. Search Control cannot build WHERE clause if:

    - Search expression is empty string or contains only NoiseWords.
    - If SearchColumns property not contain any Column to search
enuMultipleWildCard Represents enumeration used for MultipleWildCard property.
enuSearchingLogic Represents enumeration used for SearchingLogic property.
enuSingleWildCard Represents enumeration used for SingleWildCard property.
enuSQLSyntax Represents enumeration used for SQLSyntax property.
enuTypeOfSearch Represents enumeration used for TypeOfSearch property.
enuWhatColumns Represents enumeration used for WhatColumns property.
enuWhereToSearch Represents enumeration used for WhereToSearch property. It is used with SQLSyntax with LIKE keyword only, including StandardANSISQL, MSAccessSQL, MSSQLWithLikeKeyword, MySQLWithLikeKeyword and OracleWithLikeKeyword SQL syntax.


Properties:

DefaultOperator If boolean operator between search terms is missing, value of this property is used. This property is relevant only if TypeOfSearch property is set to Expression.
IfError

Represents behavior in case that Search Control can not build Where Clause. Search Control cannot build WHERE clause if search expression is an empty string or contains only NoiseWords or SearchColumns property not contains any column to search.
KeywordAND It is a string that represents AND boolean operator in search expression. It is useful for using on non english web sites to make more visitors-friendly searching.
KeywordNOT It is a string that represents NOT boolean operator in search expression. It is useful for using on non english web sites to make searching more visitors friendly.
KeywordOR It is a string that represents OR boolean operator in search expression. It is useful for using on non english web sites to make searching more visitors friendly.
LastMessage Represents a message from the control after calling getWhereClause method. This read only property tells does control can build a valid SQL query or tells what is the problem if can not.
LicenseCode A string with your registration code that you get from Bean Software.
MaxSearchWordsNumber Limits the maximum number of search words. If Text property contains more words than this value is, first words will be included in SQL query and surplus will be ignored. Noise words are not counted.
MinSearchWordsLength Limits the minimum length of search words. Words with length that is shorter than this value are ignored.
MultipleWildCard Use the multiple wild card to replace 0 or more characters in search term. Multiple wild card could be an asterisk (*), an percent (%) or both of them. Also you can turn off wild characters functionallity.
NoiseWords Represents a collection of noise words. Noise words are words that are ignored in searching. Usually, there are common words, single characters, one digit numbers etc.
SearchColumns Represents a collection of your data table columns that you want to search. You need to add at least one string in this collection to get a valid SQL query when you call getWhereClause method.
SearchingLogic Represents a searching logic used to get more accurately search results. Search logic could be a simple boolean, sounds, "forms of" and about logic.
SingleWildCard Use the single wild card to replace one character in search term. Single wild card could be a question (?), an underscore (_) or both of them. Also you can turn off wild characters functionallity.
SQLSyntax Represents a SQL syntax of database technology used in your application. Control supports standard ANSI SQL, and also specific SQLs used on MS SQL, MySQL, Oracle and MS Access.
Text Represents a string that is visible in text box of Search Control. Value of this property is used when getWhereClause() method is called. If getWhereClause is called with SearchExpression parameter, Text property value is ignored.
TypeOfSearch Represents how search control will understand search string. It could search for any word, all words, exact phrase, boolean expression etc.
UseBackslash If UseBackslash property is set to true, then you can make escape sequence with backslash character ("\") and search for special characters, like +, -, | etc.
UseColumnsFilter If True, end users are enabled to use double dot and search terms in only specific column instead of all columns of SearchColumns property.
UseSpecialCharacters If True, special characters +, - and | will be understand as AND, OR and NOT boolean operators. This property is used only is TypeOfSearch is set to Expression. If UseSpecialCharacters is set to False, characters +, - and | are accepted as simple letters.
UseWildCards If set to true, you can use MultipleWildCard and SingleWildCard properties to replace zero or more characters in serch terms.
WhatColumns Represents a boolean operator used if SearchColumns property contains more than one column. If this property is set to AnyColumn, control will return rows that contains search terms in any of the search columns. If WhatColumns is set to AllColumns, control will return only rows that contains search terms in every search column.
WhereToSearch

Used in searching with LIKE keyword SQLSyntax . There are four values for this property:

  • BeginningOfRecord - search records that begins with search terms
  • EndOfRecord - search records that ends with search terms
  • MiddleOfRecord - search terms anywhere in the record
  • ExactRecord - returns only rows where search term is the same as a record.

Methods:

AddNoiseWord Add new word to NoiseWords collection.
AddSearchColumn Add new search column to SearchColumns collection.
getWhereClause Return WHERE clause of SQL Query to the database.
IsNoiseWord Check does specific word belong to NoiseWords collection.
RemoveAllNoiseWords Removes all words from NoiseWords collection.
RemoveAllSearchColumns Removes all items from SearchColumns collection.
RemoveNoiseWord Removes specific noise word from NoiseWords collection.
RemoveSearchColumn Removes an item from SearchColumns collection.