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






Specifies the client side (JavaScript) function that will be invoked when a row is selected.

Syntax

Visual Basic (Declaration) 
<DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a row is selected.")>
<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")>
<DefaultValueAttribute()>
<NotifyParentPropertyAttribute(True)>
<ISNet.EventParameterAttribute("controlId, tblName, rowIndex, rowEl")>
Public Property OnRowSelect As String
Visual Basic (Usage)Copy Code
Dim instance As ClientEvents
Dim value As String
 
instance.OnRowSelect = value
 
value = instance.OnRowSelect
C# 
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a row is selected.")]
[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")]
[DefaultValueAttribute()]
[NotifyParentPropertyAttribute(true)]
[ISNet.EventParameterAttribute("controlId, tblName, rowIndex, rowEl")]
public string OnRowSelect {get; set;}
Delphi 
public read-write property OnRowSelect: String;
JScript 
DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a row is selected.")
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")
DefaultValueAttribute()
NotifyParentPropertyAttribute()
ISNet.EventParameterAttribute("controlId, tblName, rowIndex, rowEl")
public function get,set OnRowSelect : String
Managed Extensions for C++ 
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a row is selected.")]
[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")]
[DefaultValueAttribute()]
[NotifyParentPropertyAttribute(true)]
[ISNet.EventParameterAttribute("controlId, tblName, rowIndex, rowEl")]
public: __property string* get_OnRowSelect();
public: __property void set_OnRowSelect( 
   string* value
);
C++/CLI 
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a row is selected.")]
[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")]
[DefaultValueAttribute()]
[NotifyParentPropertyAttribute(true)]
[ISNet.EventParameterAttribute("controlId, tblName, rowIndex, rowEl")]
public:
property String^ OnRowSelect {
   String^ get();
   void set (    String^ value);
}

Property Value

Returns return value.

Example

The sample code below shows you how to display the customer's ID when users click the row.
C#Copy Code
WebGrid1.LayoutSettings.ClientSideEvents.OnRowSelect = "WebGrid1_OnRowSelect";
The following is the example of the javascript function that is assigned in above event.
JScriptCopy Code
function DoRowSelect(gridId, tblName, rowIndex) 
{ 
     var grid = wgGetGridById(gridId); 

     var selObject = grid.GetSelectedObject(); 

     var selRow = selObject.GetRowElement(); 

     document.getElementById("TextBox1").value = selRow.keyValue; 

     return true; 
}

Remarks

You can specify user-defined Javascript function to respond when the a row is selected. The user-defined function should only contain the name of the function. For example, "DoRowSelect".

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 selected row.

rowIndex

The selected row's index.

rowEl

The selected row's element.

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.

For more information you can Walkthrough: Using OnCellClick and OnRowSelect events in NewRow.

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.