Intersoft WebGrid Documentation
OnColumnFilter Property
See Also  Example Send Feedback
ISNet.WebUI.WebGrid Namespace > ClientEvents Class : OnColumnFilter Property






Specifies the client side (JavaScript) function that will be invoked when a column is about to be filtered by user.

Syntax

Visual Basic (Declaration) 
<ISNet.Serialization.XmlSerializableAttribute()>
<ISNet.Serialization.BinarySerializableAttribute()>
<EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ISNet.WebUI.Design.ClientSideEventEditor, ISNet.WebUI.Design")>
<NotifyParentPropertyAttribute(True)>
<ISNet.EventParameterAttribute("controlId, tableObject")>
<DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be filtered by user.")>
<DefaultValueAttribute()>
Public Property OnColumnFilter As String
Visual Basic (Usage)Copy Code
Dim instance As ClientEvents
Dim value As String
 
instance.OnColumnFilter = value
 
value = instance.OnColumnFilter
C# 
[ISNet.Serialization.XmlSerializableAttribute()]
[ISNet.Serialization.BinarySerializableAttribute()]
[EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ISNet.WebUI.Design.ClientSideEventEditor, ISNet.WebUI.Design")]
[NotifyParentPropertyAttribute(true)]
[ISNet.EventParameterAttribute("controlId, tableObject")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be filtered by user.")]
[DefaultValueAttribute()]
public string OnColumnFilter {get; set;}
Delphi 
public read-write property OnColumnFilter: String;
JScript 
ISNet.Serialization.XmlSerializableAttribute()
ISNet.Serialization.BinarySerializableAttribute()
EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ISNet.WebUI.Design.ClientSideEventEditor, ISNet.WebUI.Design")
NotifyParentPropertyAttribute()
ISNet.EventParameterAttribute("controlId, tableObject")
DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be filtered by user.")
DefaultValueAttribute()
public function get,set OnColumnFilter : String
Managed Extensions for C++ 
[ISNet.Serialization.XmlSerializableAttribute()]
[ISNet.Serialization.BinarySerializableAttribute()]
[EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ISNet.WebUI.Design.ClientSideEventEditor, ISNet.WebUI.Design")]
[NotifyParentPropertyAttribute(true)]
[ISNet.EventParameterAttribute("controlId, tableObject")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be filtered by user.")]
[DefaultValueAttribute()]
public: __property string* get_OnColumnFilter();
public: __property void set_OnColumnFilter( 
   string* value
);
C++/CLI 
[ISNet.Serialization.XmlSerializableAttribute()]
[ISNet.Serialization.BinarySerializableAttribute()]
[EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ISNet.WebUI.Design.ClientSideEventEditor, ISNet.WebUI.Design")]
[NotifyParentPropertyAttribute(true)]
[ISNet.EventParameterAttribute("controlId, tableObject")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be filtered by user.")]
[DefaultValueAttribute()]
public:
property String^ OnColumnFilter {
   String^ get();
   void set (    String^ value);
}

Example

The following is the example on how to assign a javascript function to the client side event when a column is filtered.
C#Copy Code
WebGrid1.LayoutSettings.ClientSideEvents.OnColumnFilter = "WebGrid1_ColumnFilter";
The following is the example of the javascript function that is assigned in above event.
JScriptCopy Code
function WebGrid1_OnColumnFilter(controlId, tableObject) 
{ 
   var WebGrid1 = ISGetObject(controlId); 

   alert ("Column is Filtered"); 

   return true; 
}

Remarks

The user-defined function should only contain the name of the function. For example, "HandleEventFunction".

The function can be defined in either inline or linked JavaScript files and can accept following parameters:

controlId

The ID of the grid calling the function.

tableObject

The WebGridTable object which filtering will be invoked to. You can enumerate the FilteredColumns in clientside by accessing tableObject.FilteredColumns collection.

Note that you should include the return value of your function. Returning a true value means that default behavior will be processed. Otherwise, the default behavior will be skipped.

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

ClientEvents Class
ClientEvents Members

Concepts

Events

©2012 Intersoft Solutions Corp. All Rights Reserved.