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






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

Syntax

Visual Basic (Declaration) 
<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")>
<ISNet.EventParameterAttribute("controlId, columnObject")>
<NotifyParentPropertyAttribute(True)>
<DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be grouped by user.")>
<ISNet.Serialization.XmlSerializableAttribute()>
<DefaultValueAttribute()>
Public Property OnColumnGroup As String
Visual Basic (Usage)Copy Code
Dim instance As ClientEvents
Dim value As String
 
instance.OnColumnGroup = value
 
value = instance.OnColumnGroup
C# 
[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")]
[ISNet.EventParameterAttribute("controlId, columnObject")]
[NotifyParentPropertyAttribute(true)]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be grouped by user.")]
[ISNet.Serialization.XmlSerializableAttribute()]
[DefaultValueAttribute()]
public string OnColumnGroup {get; set;}
Delphi 
public read-write property OnColumnGroup: String;
JScript 
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")
ISNet.EventParameterAttribute("controlId, columnObject")
NotifyParentPropertyAttribute()
DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be grouped by user.")
ISNet.Serialization.XmlSerializableAttribute()
DefaultValueAttribute()
public function get,set OnColumnGroup : String
Managed Extensions for C++ 
[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")]
[ISNet.EventParameterAttribute("controlId, columnObject")]
[NotifyParentPropertyAttribute(true)]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be grouped by user.")]
[ISNet.Serialization.XmlSerializableAttribute()]
[DefaultValueAttribute()]
public: __property string* get_OnColumnGroup();
public: __property void set_OnColumnGroup( 
   string* value
);
C++/CLI 
[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")]
[ISNet.EventParameterAttribute("controlId, columnObject")]
[NotifyParentPropertyAttribute(true)]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is about to be grouped by user.")]
[ISNet.Serialization.XmlSerializableAttribute()]
[DefaultValueAttribute()]
public:
property String^ OnColumnGroup {
   String^ get();
   void set (    String^ value);
}

Property Value

Returns return value.

Example

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

   alert ("Column is Grouped"); 

   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.

columnObject

The WebGridColumn object.

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

©2012 Intersoft Solutions Corp. All Rights Reserved.