News in version
TreeGrid Gantt chart SpreadSheet Examples Documentation Download Development Licensing Prices References Contacts Buy Try it free
Documentation
Search in documentation
TreeGrid versions compatibility

Changes log (txt file) Upgrading from 9.3 to 10.0 Upgrading from 5.9 to 6.0

Creating grid

Simple examples Basic information Creating grid Deleting grid Reloading grid Rendering grid Accessing grid by API

Data & communication
Data communication with server

Communication types AJAX communication AJAX SOAP envelope Submit communication Directly included data Data from JavaScript Cross domain / local load by JSONP Sessions (AJAX) Server response (AJAX) Synchronous communication (AJAX) Caching (AJAX) API (AJAX)

Download data

Settings for data download Layout XML structure Data XML structure

Upload data

Settings for data upload API for upload XML structure sent to server

Changing data from server

XML structure of download changes XML structure of request for a cell Synchronizing data with server

Input / output data formats

Complete list of tags Internal XML format Short XML format Extra short XML format DTD XML format JSON format

Cells
Cell basics

Cell type Cell format Dynamic format Dynamic type Cell value Reading / writing attributes by API Cell HTML Range or more values in one cell Cell with link URL Cell hint Cell tooltip / title Cell popup menu

Cell editing and changing values

Cell editability Defaults list Suggest list (auto complete) Changing cell value Mass cell change Clearing cells Editing cells Controlling <input> tag by JavaScript Input validation and restrictions Side checkbox Cell selecting

Calculations - cell formulas

Basics Formulas Mathematical functions Aggregate functions Special functions for actions Custom functions

Calculations - editable cell formulas

Basics Suggest list (auto complete) Actions for choosing cells Conditional functions Lookup functions Cell reference functions Logical functions Informational functions Mathematical functions Trigonometry functions Rounding numbers Number conversions String functions Date functions Summary functions Custom functions

Cell side buttons

Introduction Right side Button Left side Icon

Cell spanning

Column span Row span Dynamic spanning

Cell style and color

Basic grid style Sizing and scaling - responsive design Dynamic cell style attributes Cell CSS class Cell background color Dynamic cell border Cell HTML style Row color alteration Cell mouse cursor

Cell types
Auto type - Auto String - Text, Lines & Pass
Number - Int & Float

Format Localization

Date and time - Date

Format Calendar component Dates dialog Localization

List & combo - Enum & Radio

Introduction Definition Related lists Enum specific Radio specific

Checkbox - Bool
Action button - Button

Introduction Basic clickable button Switch button Radio / tab button Menu button Combo switch button Combo radio / tab button Special Space rows with buttons

Panel with more buttons - Panel

Definition Standard fast panel Custom panel

HTML and special types

Html type Icon type Abs type List type Editable Link type Editable Img type DropCols type Upload File type

Columns

Column basics Column index Column visibility Column visibility menu Column selecting Column tree Column position and moving Column adding and copying Column deleting Column width Column API

Rows
Row basics

Rows by functionality Rows by position Row name Row id Row index

Default rows

Description Example of default rows Example of changing default row Attributes

Row tree

Tree attributes Actions & API for expand / collapse

Row identification

Setting row id attribute Row id attribute in tree Row id created from cell values API for row ids

Row visibility
Row adding and copying

Five ways of adding rows to grid Adding and copying restrictions Adding new empty rows Copying existing rows

Row deleting Row moving and dragging Row selecting Row height Row API Space rows
Features
Sorting rows

Sort settings Controlling sort position Comparing strings Sorting actions Sorting API

Grouping rows to tree

Group settings Creating groups Comparing strings Created group rows <D Group='1'/> User interface to choose grouping Grouping actions and API

Filtering rows

Filter settings Comparing strings User interface to choose filter Filter actions and API

Searching in rows and cells

Search settings User interface for search Search actions and API

Printing grid

Print settings Choosing items to print Page size Print API

Print / export to PDF

Introduction Client side settings Printing options Client side API Server side API Data sent from client to server

Export to Excel or CSV

Introduction Basic settings Communication with server Export API Client export Server export

Import from Excel

Basic settings Sheets manipulation

Copy & paste rows via clipboard

Copy & paste permissions Copying to clipboard Pasting from clipboard

Master - detail grids

Introduction External master - detail grids Nested master - detail grids Synchronizing grids Other attributes for master - detail

Pivot tables

Pivot attributes & API Pivot formulas

External objects (like Adobe Flash) Undo & Redo
Gantt and bar chart
Gantt objects

Gantt objects list Display settings Edit settings

Main bar

Definition of main bar and plans Main bar as Task Edit settings Main bar content and side html Tip on mouse hover Vertical position and height Style specific attributes API to manipulate Main bars Actions Side text (deprecated) Real Flow (deprecated)

Run bar

GanttRun Definition Extended definition Run bar as Task Edit settings Save format Selecting Run boxes Run box content and side html Tip on mouse hover Box identification Vertical position and height Style specific attributes Overlaid (Error) boxes Containers for more boxes Dragging - moving and resizing API to manipulate Run boxes Actions Run special formulas

Summary task

Main for Main Main for Run Editable Main Editable Run

Gantt icons - Flag & Point

Flag - icon with text Point - math points

Gantt display objects

Header - column captions Cell and column Background Vertical movable Line Mark & Progress line

Gantt zoom

Zoom options Chart size limits Zoom selection Paging in Gantt chart

Dependency, constraints & schedule

Introduction Data units Defining dependencies Dependency colors and shapes Changing dependencies Correcting dependencies Scheduling algorithm Project date constraints Task date constraints Critical path - Slack (Float)

Gantt calendars

Global base calendar Local calendar Calendar list Calendars dialog Other settings

Gantt resources

Resources list Resources assign Resources filter Resources calculations Availability chart Resource usage chart Generated resource usage chart

Gantt popup menu Gantt API
Line and XY points charts

Charts in grid cells Chart JSON definition Base chart settings Basic attributes Size Axis and caption Individual chart lines Data sources Visual settings API for standalone usage

Paging in large grids
Paging root rows

Paging types and attributes Auto adding root pages API for paging

Pager components

Side pager Side pager type Pages Side pager type Gantt Side pager type Custom Pager with navigation buttons & edit Pager as list of page indexes

Paging in tree

ChildPaging - load / render on expand MaxChildren - limit children count ChildParts - load / render on scroll

Paging columns

Paging types and attributes Auto adding column pages API for column paging

Server paging

Server paging for root rows Server communication in root paging Root paging in very large tables Server paging in tree Server communication in tree paging XML Request for Data in root paging XML Download Data in root paging XML Request for root Page / children XML Download root Page / children API for server paging

TreeGrid DLL/SO for server paging

Introduction Compatibility with TreeGrid control Using TreeGrid server DLL/SO ASP.NET C# ASP.NET VB PHP JSP Java TreeGrid server concepts Function reference Calculations

JSON menus and dialogs
JSON menu description JSON menu definition example
Menu settings

Base attributes Visual settings Key navigation Behavior Size and scroll

Menu item settings

Base attributes Clickable item Inactive caption Collapsible sub level Popup sub menu Columns Bool item Enum item Edit item

Custom menu in JavaScript

Show custom menu Custom menu position Custom menu advanced settings Custom menu JavaScript events Custom menu JavaScript methods

Calendar dialog Custom calendar & JavaScript events Custom dialog in JavaScript
Global grid settings
Grid size and scroll

Default behavior Maximize grid height and width Update size according to the content Let a user to control the grid size Widths of individual sections Other scrolling attributes and API

Media rules - responsive design
Grid cursor - Focus & hover

Focused cell and row Focused cell range Move and copy focused cells Filling cell values by dragging Tabulator navigation Key navigation Cursor look - focus & hover

Selecting rows, cells and columns

Selecting base Selecting rows Selecting cells Selecting columns

Global settings

Status messages Configuration menus Configuration menu - options Configuration menu - columns Configuration menu - print / PDF Configuration menu - export Default toolbar Language & regional setup (Text.xml) Useful API function Help file

Animations

Animations base Row animations Column animations Cell animations Animations for undo / redo Animations for server side changes Dialog animations

Grid configuration in cookies
Mouse & key events & actions

List of event handler types TreeGrid mouse events Mouse event names Key and mouse button prefixes Touch event names Event targets Assigning event actions / callbacks Event action parameters Calling actions from JavaScript Creating custom actions Focused vs. Actual cell TreeGrid key events JavaScript API events

Mouse API event TreeGrid files
Debugging and testing

Debug window Automated testing

Filtering rows

TreeGrid documentation

TreeGrid supports filtering rows by one or more columns by setting the value to filter and filter operator to use.
It is similar to MS Excel simple filter.
TreeGrid also supports advanced filtering by any formula or special search, see Search.
Strings can be filtered case sensitive or insensitive. Can be also filtered according to actual browser language or by special settings. See comparing strings.

Filtering can be changed by a user in special Filter row by setting cell value or filter operator.
Filtering can be preset in XML in the special Filter row by setting cell value and filter operator.
Filtering can be changed by API by ChangeFilter method.
<Cfg> bool

Filtering

[1]
If rows can be filtered.
Setting it to 0 disables all filtering functions, including Search and SetFilter filters.
chg 7.0 <Cfg> bool

Filtered

[1] Saved to cookies, to not load it, set FilteredLap='1'
If basic filtering is enabled by user.
A user can enable / disable filtering by click to Filter row left panel.
Since 7.0 it affects only filters done by <Filter> rows, not the Search and SetFilter filters.
deleted 7.0 <Cfg> bool

FilterEmpty

[0]
Since 7.0 the CanFilter&2 is tested always, like FilterEmpty = 1
If set to 1 when filtering, hides all rows with CanFilter=2 (or 3) that have all children filtered/hidden.
upd 9.0 <Cfg> int

StandardFilter

[0]
Filter behavior in tree

0(Hide all not found) The filter is applied to parents before children to speed up filtering. The filter is applied to children only if the parent fulfills the condition.
 
1(Hide all not found, iterate all) The filter is applied to children before filtering parent.
Use it if parent is filtered according to visibility of its children, when uses aggregate functions. It can be much slower than 0.
 
2(Show all found) It shows all rows that fulfill the filter condition in tree. It shows all parent rows if some their children fulfill the condition.
The filter is applied to children before filtering parent.
 
3(new 9.0) (Show all found, with all children) It shows all rows that fulfill the filter condition in tree, with all their children.
The filter is applied to parent before children. The filter is applied to children only if the parent does not fulfill the condition.
new 8.1 <Cfg> bool

FilterHidden

[1]
0 - it will clear filter for column hidden from columns menu by users
1 - it will preserve the filter also after the column is hidden
new 12.1 <Cfg> int

FilterIgnoreEmpty

[0]
If the empty cells will be ignored by some filter operators. Bit array.
The setting is not applied when comparing / searching empty string.
1. bit &1Never shows empty numbers for operators <, <=, >, >=.
2. bit &2Never shows empty strings for operators <, <=, >, >=.
3. bit &4Never shows empty strings for operators not contain / not begin / not end
4. bit &8Never shows empty numbers for operator not equal
5. bit &16Never shows empty strings for operator not equal
<C> int

CanFilter

[1]
Rows can be filtered by this column.
If set to 2, it is also tested cell's CanFilter attribute.
<cell> bool

CanFilter

[1]
If the row can be filtered according to this column. Used only when the column has set CanFilter='2'.
<I> int

CanFilter

[1]
How row can be filtered (hidden) by any filter, bit array.
&1 - if row can be hidden by any filter
&2 - if row is hidden if all its children are hidden
<I> bool

Visible

[1]
If the row is displayed in grid.
The row Visible attribute can be changed also by Filter / Search and by deleting row, when deleted rows are hidden.
By API the Visible attribute can be changed by methods ShowRow / HideRow.
Collapsing / expanding children and rendering pages, child pages or child parts does not affect row Visible attribute.

The Visible attribute does not directly affect if the row is rendered in grid.
When row has Visible='0' on start, it is not rendered at all and it is rendered when it is shown for the first time.
When the already rendered row is hidden by Filter / Search or by HiddenRow, it has set display='none' and next showing just clears the CSS attribute.
The visible row can be also not rendered because of collapsed parent (in child paging) or not rendered page, child page or child part.
new 12.0 <I> bool

Hidden

[0]
The Hidden attribute is set by manual hiding and showing rows.
If set Hidden='1' the row is not shown/hidden by any filter.
chg 7.0 <cell> string

FilterValue

Cell value used for filtering and searching, useful for special non editable cells like Html, Icon, Abs, Gantt, ..., see also OnGetFilterValue event.
(Deleted in 7.0) For searching it is not used for Int and Float types and also not for SearchMethod = 2.
It is also used by FilterTextRange and FilterDateRange methods, but not by SetFilter method.
API event type

OnGetFilterValue

(TGrid grid, TRow row, string col, type val)
Called to get cell value for filtering and searching.
val is predefined value, returns val or new value.
new 7.0 API variable int

FilterCount

Count of visible variable rows after filter is applied.
It is null if the filter was not run.
new 6.7 <Cfg> bool

SaveFilters

[0]
If set to 1, saves to cookies the custom filters set by SetFilter method.
It does not affect the standard or search filters.
new 12.1 <Cfg> bool

ClearFilterOff

[0]
If set, clears the filter cell value after chosen operator off (0).

Comparing strings

You can also specify these settings for whole grid in default column <Def><D Name='C'/></Def>.
new 6.0 <C> <cell> bool

LocaleCompare

[0]
If strings are compared according to browser's locale settings. For sorting, filtering and grouping.
For Filter it affects just case sensitivity if set also CaseSensitive='0'.
If set to row cell, it affects row's children for sorting and grouping. For filter it can be set only to Filter cell and affects also all values in the column.
new 6.0 <C> <cell> bool

CaseSensitive

[1]
If strings are compared case sensitive. For sorting, filtering and grouping.
If set to row cell, it affects row's children for sorting and grouping. For filter it can be set only to Filter cell and affects also all values in the column.
chg 6.0 <C> <cell> string

WhiteChars

List of characters to ignore when sorting, filtering or grouping.
It can be set for example to " " (space) to ignore spaces (it means that for example "a b c" and "abc" strings are the same.
Setting this attribute can slow down sorting, grouping and filtering.
If set to row cell, it affects row's children for sorting and grouping. For filter it can be set only to Filter cell and affects also all values in the column.
upd 6.0 <C> <cell> string[*]

CharCodes

It changes characters in comparing strings for sorting, filtering and grouping.
It is first character separated array of pair of characters to replace the first character by the second when comparing strings.
For example "|y|i|Y|I|.|," - replaces 'y' by 'i', 'Y' by 'I' and '.' by ','
- it means that when comparing strings does not differ between letter 'y' and 'i', both cases and also does not differ between comma and point.
The first character must be one letter, but the second in fact can be any letter or string or even empty string, like "|a|xxx|b||c|ff"
If you use TreeGrid server DLL/SO, there must be the second character one letter only too.
Setting this attribute can slow down sorting, grouping and filtering.
If set to row cell, it affects row's children for sorting and grouping. For filter it can be set only to Filter cell and affects also all values in the column.

User interface to choose filter

User interface for filtering is shown by fixed <Filter> row. The <Filter> can be placed to <Head> or <Foot> section.
The <Filter> row is usually only one, but there can be also more filter rows placed to <Head> and / or <Foot> tags to provide more filters by one column.
The <Filter> row is standard data row with cells and can have also all standard row and cell attributes.

The default filter cell differs according to the filter cell / column type.
Text, LinesLeft filter menu shows all operators including strings. String filter is done.
Int, FloatLeft filter menu shows only basic comparing operators, not the strings. Number filter is done.
DateLeft filter menu shows only basic comparing operators, not the strings. Number filter is done, the dates are compared as numbers. Right side calendar is shown.
EnumLeft filter menu is hidden. User chooses one item from enum list to filter by. The first item in list is FilterOff. It is possible to set Range to choose more values to filter by.
RadioLeft filter menu is hidden. User chooses check one radio button to filter by. The last radio button is FilterOff. It is possible to set Range to choose more values to filter by.
BoolLeft filter menu is hidden. The check box has three states - on, off, filteroff.
PassFilter is disabled.
PanelIt is shown Filtered On / Off checkbox
LinkIt is shown Text type and filter provides string compare with link text or if missing with link url.
ImgIt is shown Text type and filter provides string compare with link url or if missing with image url.
Button, Html, Icon, Abs, Gantt, ListIt is shown Text type cell with left filter menu and the filter provides string compare for the cell values.
To not show the filter cell and filter menu, set <C CanFilter='0'/>

The predefined or actual filter is set in individual cells by the cell value and attribute Filter.
<Filter cell> type

value

Saved to cookies, to not load it, set <Cfg FilterLap='1' />
Predefined or actual filter value to filter the column by.
It is used only if Filter is set to value > 0.
<Filter cell> int

Filter

[0] Saved to cookies, to not load it, set <Cfg FilterLap='1' />
Predefined or actual filter operator to filter the column by.
Can be one of predefined filters:
Off:0 - Off
Number filter:1 - Equal, 2 - Not equal, 3 - Less than, 4 - Less than or equal, 5 - Greater than, 6 - Greater than or equal
String filter:7 - Begins with, 8 - Does not begin with, 9 - Ends with, 10 - Does not end with, 11 - Contains, 12 - Does not contain
<Filter cell> int

DefaultFilter

[1/11]
Predefined filter operator, it is automatically selected when filter is off and user changes filter cell value.
Default value is for Text, Lines, Img and Link types 11 and for other types 1. See Filter attribute.
If set to 0, no automatic selection is done.
upd 6.0 <Filter cell> string

FilterOff

[""]
Value entered to cell that automatically removes filter from the cell (sets Filter to 0).
By default it is empty string for all editable types and new value for empty value for Enum and item Off for Radio.
For Enum and Radio it can be not existing item - it is added to the list, or existing item that switches off the filter.
new 7.0 <Filter cell> bool

FilterEnumKeys

[0]
For Enum type cell. If set to 0 it filters by Enum string. If set to 1 it filters by Enum value, by key or index.
new 9.3 <Filter cell> bool

EqualFormatted

[0]
If set to 1, it equals (Filter = 1,2,3,4,5,6) numbers as formatted strings (according to the Format setting). To avoid problems with rounded values due format.
<Filter cell> bool

ShowMenu

[1/0]
If filter menu icon is visible.
You can hide it to use only DefaultFilter and Defaults button to select one value or more value to filter the column by.
By default is 0 for Bool, Enum and Radio types and 1 for all other types.
<Filter cell> int[ ]

MenuItems

[...]
Comma separated array of operators displayed in FilterMenu, can contain numbers from 0 to 12 in any order.
For possible values see Filter attribute.
Default value varies according to cell type, Bool = "0,1,2", Int, Float, Date = "0,1,2,3,4,5,6", other = "0,1,2,3,4,5,6,7,8,9,10,11,12"
new 9.0 <Filter cell> string

FilterMenu

[...]
Full JSON definition of the filter menu with operators.
It can define only menu attributes without Items (e.g. MaxHeight), in this case the Items will be created for standard filter operators.
Or it can define the menu items in Items array. The items named 0 to 12 will be set as standard filter operators, other items will be custom.
It supports extended capabilities like submenus and collapsible sections.
The menu format is standard TreeGrid menu.
For example this filter menu for column "Col1" shows operators in two columns:
<Filter ... Col1FilterMenu="{ Items:[ { Name:0 }, { Columns:2,Items:[1,2,3,4,5,6,7,8,9,10,11,12] } ] }" ... />
upd 9.1 <Filter cell> int

Range

[0]
If the cell accepts more values or value ranges to be filtered by.

If set to 1 for cell of type Int, Float and Date, it accepts more values separated by ';' and range of values separated by '~'. It can be used only for filter operators 1 (Equal) and 2 (Not equal). Other operators will fail.
It will filter all values inside the range(s), including boundaries.
For example Equal 1;3~5;9~12;16 will find cells with values 1,3,4,5,9,10,11,12,16

If set to 1 for cell of string type like Text or Lines, it accepts more values separated by ';'.
It can be used only for filter operators: 1 (Equal), 2 (Not equal), 7 (Begins), 8 (Not begin), 9 (Ends), 10 (Not end), 11 (Contains), 12 (Not contain)
To filter by empty value, set the filter cell value to ';'.
If set to 2 (new 9.1) it compares all values in range cells for operators 1 (equals at least one) and 2 (equals none).

If set to 1 for cell of type Enum or Radio, it accepts more value to be selected and to filter by.
To filter by empty value, set the filter cell value to ';'.
If set to 2 (new 9.1) it compares all values in range cells for operators 1 (equals at least one) and 2 (equals none). Only for string enums, not index enums.

If set to 1, calendar component for selecting date supports selecting more dates or range of dates by mouse drag. The date should not contain time part.
If set to 1, Defaults dialog supports selecting more values for any cell type (not only Int, Float, Date, Text, Lines).

The characters ';' and '~' can be changed by <Lang><Format ValueSeparator=';' RangeSeparator='~'/></Lange>

Filter actions and API

<Actions>

FilterOn

Attached to event OnClickPanelFiltered
Enables filtering in grid and re-filters it according to actual settings. It fails if filtering already enabled.
<Actions>

FilterOff

Attached to event OnClickPanelFiltered
Disables filtering in grid and un-filters it. It does not clear actual filter settings. It fails if filtering already disabled.
<Actions>

ShowFilterMenu ...F

Attached to event OnClickSideFilter
Shows filter operator menu in actual or focused cell.
Fails if the cell has not set Icon or Button = "Filter".
new 12.0 <Actions>

ShowFilterMenuRow ...F

Not attached to any event
Shows filter operator menu in actual or focused cell.
It shows the menu also if the operator icon is hidden by ShowMenu = 0.
Fails if the cell is not in Filter row.
new 12.0 <Actions>

FilterBy ...F

Not attached to any event
Sets the actual or focused cell value to the filter cell in the same column and filters by it using DefaultFilter.
new 12.0 <Actions>

FilterByMenu ...F

Not attached to any event
Sets the actual or focused cell value to the filter cell in the same column and shows operator menu.
new 12.0 <Actions>

FilterByMenuRow ...F

Not attached to any event
Sets the actual or focused cell value to the filter cell in the same column and shows operator menu.
It shows the menu also if the operator icon is hidden by ShowMenu = 0.
new 12.0 <Actions>

ClearFilter ...F

Not attached to any event
Clears the filter operator for the actual or focused column.
new 12.0 <Actions>

ClearFilters

Not attached to any event
Clears all the filter operators in the first filter row.
chg 7.0 API event bool

OnFilter

(TGrid grid, int type)
Called when grid will be re-filtered. You can provide own filtering and return true.
type when it is called (0 on filter change, 1 on start, 2 (since 7.0) on grouping change).
(Since 7.0) It is called for every filtering in grid (<Filter>, <Search>, SetFilter).
chg 7.0 API event void

OnFilterFinish

(TGrid grid, int type)
Called after grid was re-filtered. Called only for filtering on client.
(Since 7.0) type when it is called (0 on filter change, 1 on start, 2 on grouping change).
(Since 7.0) It is called for every filtering in grid (<Filter>, <Search>, SetFilter).
API event bool

OnRowFilter

(TGrid grid, TRow row, bool show)
Called for custom condition while filtering.
Called when filtering the row, show is the actual filter result.
Must return if the row will be visible or not.
upd 7.0 API method void

ChangeFilter

(string cols, string values, string operators, bool nofilter, bool noclear, TRow filter)
Filters grid according to given columns.
cols, values and operators are comma separated values or JavaScript arrays. All must have the same length.
cols are column names, values are values for given filter cells and operators are filter operator numbers 0 - 12, see cell attribute Filter.
If nofilter is 1, does change the filter cells but does not filter grid.
If noclear is 1, does not clear the other filter cells that are not listed in cols.
(since 7.0) filter can be the filter row to change the filter settings here, if the grid contains more filter rows. If not set, uses the first filter row.
API method void

DoFilter

(TRow row = null, string col = null)
Applies all filters (in Filter rows) to the grid.
If set row and col updates operator for this cell in Filter row.
upd 6.6 API method void

FilterTextRange

(string col, string val, string name, int show = 2)
Creates new filter and applies it to grid. Shows all rows containing any item from range val in their range value in column col.
name - (new 6.6), name of the filter to have more different filters, if row violates any filter, it is hidden.
show = 0 - set the filter only, but does not filter, 1 - filters by the filter, but does not show the changes, 2 - filter and show the changes.
new 6.6 API method void

FilterDateRange

(string col, string val, string name, int show = 2)
Creates new filter and applies it to grid. Shows all rows containing any item from date range val in their range value in column col.
The val can be for example "1/1/2010~12/31/2010 23:59:59" to show all dates from the year 2010.
name - name of the filter to have more different filters, if row violates any filter, it is hidden.
show = 0 - set the filter only, but does not filter, 1 - filters by the filter, but does not show the changes, 2 - filter and show the changes.
new 6.6 upd 6.7 API method void

SetFilter

(string name, string filter, string col, int show = 2)
Creates new filter and applies it to grid.
name - name of the filter to have more different filters, if row violates any filter, it is hidden.
filter - filter formula string, similar to cell Formula, it can use variables Grid as the grid and Row as the filtered row and also column names as values of the filtered row cells.
The filter code must return 0 to hide the row and 1 to show the row.
show = 0 - set the filter only, but does not filter, 1 - filters by the filter, but does not show the changes, 2 - filter and show the changes.
if set col, it tests row's CanFilter attribute and the cell's CanFilter attribute when the column has CanFilter='2'
To clear the filter pass empty filter parameter.
(new 6.7) The custom filters can be saved to cookies when set SaveFilters = 1.
new 10.0 API method type[ ][ ]

GetFilter

(bool spec = 0)
For spec = 0 returns all actual filters in all Filter rows in array [ [col1,value1,operator1], [col2,value2,operator2], ... ]
For spec = 1 returns all custom filters set by SetFilter method in array [ [name1,filter1,col1, [name2,filter2,col2], ... ]
new 12.0 API method int

HasFilter

( )
Returns bit array with information which filter is active. Returns:
1. bit (&1) for filter by Filter row.
2. bit (&2) for filter by SearchAction "Filter".
3. bit (&4) for filter by custom filter by SetFilter.
4. bit (&8) for filter by OnRowFilter API event. It returns it just when the OnRowFilter is defined!