<Table>.InputSearch (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Table functions

Prefix syntax

InputSearch

Presentation

Example

Effect of the function

Use conditions

See also

<Table>.InputSearch (Function)

In french: <Table>.SaisieLoupe

Enables input in the the search area in the column title of the Table or Treeview Table control.

In WINDEV:
In Android:

This function has the same effect as when the user clicks the search icon. It can start a search or implement a filter on the control.

To cancel a filter started by <Table>.InputSearch, simply use <Table>.DisableFilter.

Remark: This function is ignored if the specified Table control uses a non-proportional scrollbar ("Proportional scrollbar" unchecked in the "Details" tab of the control description window). For more details on the magnifier, see Characteristics of columns in a Table control.

Example

// Switches the COL_Name column to edit mode
COL_NAME.InputSearch()

Syntax

<Column>.InputSearch([<Type of filter or search> [, <Initial value>]])

<Column>: Control name

Name of column that will be switched to search mode. The function has no effect if this operation cannot be performed on this column (non-key column for example).
The name of the column can be given directly or in the following format: <Table control>.<Column>.
The column used must be a "Searchable" column ("General" tab of the column description).

<Type of filter or search>: Optional Integer constant

Type of filter to apply or type of search to perform:
filterContains Displays the rows whose value for the specified column "Contains" the characters specified in <Initial value>.
filterDifferent Displays the rows whose value for the specified column "differs" from the characters specified in <Initial value>.
filterDoesNotContain Displays the rows whose value for the specified column "does not contain" the characters specified in <Initial value>.
filterDoesNotEndWith Displays the rows whose value for the specified column "does not end with" the characters specified in <Initial value>
filterDoesNotStartWith Displays the rows whose value for the specified column "Does not start with" the characters specified in <Initial value>.
filterEndsWith Displays the rows whose value for the specified column "ends with" the characters specified in <Initial value>.
filterEqual Displays the rows whose value for the specified column "is equal" to the characters specified in <Initial value>.
filterGreater Displays the rows whose value for the specified column "is greater" than the characters specified in <Initial value>.
filterGreaterOrEqual Displays the rows whose value for the specified column "is greater than or equal to" the characters specified in <Initial value>.
filterLess Displays the rows whose value for the specified column "is less" than the characters specified in <Initial value>.
filterLessOrEqual Displays the rows whose value for the specified column "is less than or equal to" the characters specified in <Initial value>.
filterStartsWith Displays the rows whose value for the specified column "Starts with" the characters specified in <Initial value>.
searchDefault
(Default value) Sorts the table according to the specified column and switches the column to search mode.
searchStartsWith Sorts the table according to the specified column, switches the column to search mode and fills the edit control of the column with the characters specified in <Initial value>. Displays the rows from the ones for which the value of the specified column "starts with" the characters specified in <Initial value>.

This parameter is not available.

<Initial value>: Optional character string

Initial value that must be specified in the input area of search mode.
This parameter is not available.

Remarks

Effect of the function

This function will have no effect if the switch to search mode cannot be performed. For example, the search mode will not be enabled:

If the column was not defined as column with search (description window of the control).
If the column is not associated with a key item.

Use conditions

This function is available on:

a Table or TreeView Table control based on a data file.
a Table or TreeView Table control populated programmatically.
a Table control in "Browser" mode.

The TreeView Table control is not available.

Component: wd280obj.dll