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






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

Syntax

Visual Basic (Declaration) 
<ISNet.Serialization.XmlSerializableAttribute()>
<ISNet.Serialization.BinarySerializableAttribute()>
<NotifyParentPropertyAttribute(True)>
<ISNet.EventParameterAttribute("controlId, tblName, rowIndex, cellIndex")>
<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")>
<DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a cell is selected.")>
<DefaultValueAttribute()>
Public Property OnCellSelect As String
Visual Basic (Usage)Copy Code
Dim instance As ClientEvents
Dim value As String
 
instance.OnCellSelect = value
 
value = instance.OnCellSelect
C# 
[ISNet.Serialization.XmlSerializableAttribute()]
[ISNet.Serialization.BinarySerializableAttribute()]
[NotifyParentPropertyAttribute(true)]
[ISNet.EventParameterAttribute("controlId, tblName, rowIndex, cellIndex")]
[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")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a cell is selected.")]
[DefaultValueAttribute()]
public string OnCellSelect {get; set;}
Delphi 
public read-write property OnCellSelect: String;
JScript 
ISNet.Serialization.XmlSerializableAttribute()
ISNet.Serialization.BinarySerializableAttribute()
NotifyParentPropertyAttribute()
ISNet.EventParameterAttribute("controlId, tblName, rowIndex, cellIndex")
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")
DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a cell is selected.")
DefaultValueAttribute()
public function get,set OnCellSelect : String
Managed Extensions for C++ 
[ISNet.Serialization.XmlSerializableAttribute()]
[ISNet.Serialization.BinarySerializableAttribute()]
[NotifyParentPropertyAttribute(true)]
[ISNet.EventParameterAttribute("controlId, tblName, rowIndex, cellIndex")]
[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")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a cell is selected.")]
[DefaultValueAttribute()]
public: __property string* get_OnCellSelect();
public: __property void set_OnCellSelect( 
   string* value
);
C++/CLI 
[ISNet.Serialization.XmlSerializableAttribute()]
[ISNet.Serialization.BinarySerializableAttribute()]
[NotifyParentPropertyAttribute(true)]
[ISNet.EventParameterAttribute("controlId, tblName, rowIndex, cellIndex")]
[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")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a cell is selected.")]
[DefaultValueAttribute()]
public:
property String^ OnCellSelect {
   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 cell is selected.
C#Copy Code
WebGrid1.LayoutSettings.ClientSideEvents.OnCellSelect = "WebGrid1_CellSelect";
The following is the example of the javascript function that is assigned in above event.
JScriptCopy Code
function WebGrid1_OnCellSelect(controlId, tblName, rowIndex, cellIndex) 
{ 
   var WebGrid1 = ISGetObject(controlId); 

   alert("The cell that you have selected is cell number " + cellIndex)  

   return true; 
}

Remarks

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

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 cell.

rowIndex

The selected cell's rowIndex.

cellIndex

The selected cell's cellIndex.

cellElement

The selected cell'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.

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

Tasks

How-to: Display the selected cell's text using OnCellSelect

Concepts

Events

©2012 Intersoft Solutions Corp. All Rights Reserved.