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






Specifies the client side (JavaScript) function that will be invoked when a group is being expanded.

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, tblName, groupIndex, rowPosition, rowIndex")>
<DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a group is being expanded.")>
<DefaultValueAttribute()>
Public Property OnGroupExpand As String
Visual Basic (Usage)Copy Code
Dim instance As ClientEvents
Dim value As String
 
instance.OnGroupExpand = value
 
value = instance.OnGroupExpand
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, tblName, groupIndex, rowPosition, rowIndex")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a group is being expanded.")]
[DefaultValueAttribute()]
public string OnGroupExpand {get; set;}
Delphi 
public read-write property OnGroupExpand: 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, tblName, groupIndex, rowPosition, rowIndex")
DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a group is being expanded.")
DefaultValueAttribute()
public function get,set OnGroupExpand : 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, tblName, groupIndex, rowPosition, rowIndex")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a group is being expanded.")]
[DefaultValueAttribute()]
public: __property string* get_OnGroupExpand();
public: __property void set_OnGroupExpand( 
   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, tblName, groupIndex, rowPosition, rowIndex")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a group is being expanded.")]
[DefaultValueAttribute()]
public:
property String^ OnGroupExpand {
   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.
C#Copy Code
WebGrid1.LayoutSettings.ClientSideEvents.OnGroupExpand = "WebGrid1_GroupExpand";
The following is the example of the javascript function that is assigned in above event.
JScriptCopy Code
function WebGrid1_OnGroupExpand(controlId, tblName, groupIndex, rowPosition, rowIndex) 
{ 
   var WebGrid1 = ISGetObject(controlId); 

   alert("The group index that expanded is "+ groupIndex); 

   return true; 
}

Remarks

You can specify user-defined Javascript function to respond when the a group is being expanded. The user-defined function should only contain the name of the function. For example, "DoGroupExpand".

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

gridId

The ID of the grid calling the function.

tblName

The Table's Name of the expanded group.

groupIndex

The groupIndex of the expanded group.

rowPosition

The relative row position of the expanded group.

rowIndex

The rowIndex of the expanded group.

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.