Intersoft WebGrid Documentation
OnCustomFilter Method
See Also  Send Feedback
ISNet.WebUI.WebGrid Namespace > WebGrid Class : OnCustomFilter Method






table
A reference to the WebGridTable object.
dataSource
A reference to the dataSource object.
filters
A reference to the WebGridGroupCollection which contains FilterColumns that need to be filter during databinding process.
Invoked when AutomaticFilter is False and filtering is needed during databinding process.

Syntax

Visual Basic (Declaration) 
Public Overridable Function OnCustomFilter( _
   ByVal table As WebGridTable, _
   ByVal dataSource As Object, _
   ByVal filters As WebGridFilterCollection _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As WebGrid
Dim table As WebGridTable
Dim dataSource As Object
Dim filters As WebGridFilterCollection
Dim value As Boolean
 
value = instance.OnCustomFilter(table, dataSource, filters)
C# 
public virtual bool OnCustomFilter( 
   WebGridTable table,
   object dataSource,
   WebGridFilterCollection filters
)
Delphi 
public function OnCustomFilter( 
    table: WebGridTable;
    dataSource: TObject;
    filters: WebGridFilterCollection
): Boolean; virtual; 
JScript 
public function OnCustomFilter( 
   table : WebGridTable,
   dataSource : Object,
   filters : WebGridFilterCollection
) : boolean;
Managed Extensions for C++ 
public: virtual bool OnCustomFilter( 
   WebGridTable* table,
   Object* dataSource,
   WebGridFilterCollection* filters
) 
C++/CLI 
public:
virtual bool OnCustomFilter( 
   WebGridTable^ table,
   Object^ dataSource,
   WebGridFilterCollection^ filters
) 

Parameters

table
A reference to the WebGridTable object.
dataSource
A reference to the dataSource object.
filters
A reference to the WebGridGroupCollection which contains FilterColumns that need to be filter during databinding process.

Return Value

Returns ReturnValue. Event will be cancelled when ReturnValue is False.

Remarks

This method allows developers to assign additional or global filters to the DataSource.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

Reference

WebGrid Class
WebGrid Members

Tasks

Walkthrough: Applying custom filtering in WebGrid

Concepts

Advanced User Interactions

©2012 Intersoft Solutions Corp. All Rights Reserved.