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






Specifies the client side (JavaScript) function that will be invoked before the update request is invoked.

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, rowObject")>
<DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked before the update request is invoked.")>
<DefaultValueAttribute()>
Public Property OnBeforeUpdate As String
Visual Basic (Usage)Copy Code
Dim instance As ClientEvents
Dim value As String
 
instance.OnBeforeUpdate = value
 
value = instance.OnBeforeUpdate
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, rowObject")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked before the update request is invoked.")]
[DefaultValueAttribute()]
public string OnBeforeUpdate {get; set;}
Delphi 
public read-write property OnBeforeUpdate: 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, rowObject")
DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked before the update request is invoked.")
DefaultValueAttribute()
public function get,set OnBeforeUpdate : 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, rowObject")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked before the update request is invoked.")]
[DefaultValueAttribute()]
public: __property string* get_OnBeforeUpdate();
public: __property void set_OnBeforeUpdate( 
   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, rowObject")]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked before the update request is invoked.")]
[DefaultValueAttribute()]
public:
property String^ OnBeforeUpdate {
   String^ get();
   void set (    String^ value);
}

Property Value

Returns return value.

Example

The sample below shows you how to display customer ID on a message box before user updating the value of the grid.
C#Copy Code
WebGrid1.LayoutSettings.ClientSideEvents.OnBeforeUpdate = "WebGrid1_BeforeUpdate";
The following is the example of the javascript function that is assigned in above event.
JScriptCopy Code
function WebGrid1_OnBeforeUpdate(controlId, tblName, rowObject) 
{ 
   var WebGrid1 = ISGetObject(controlId); 

   alert("The customer ID that you will update is "+ rowObject.KeyValue); 

   return true; 
}

Remarks

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

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.

rowObject

The new row object containing cells information.

 

The RowObject contains following properties:

gridId

The ID of the grid.

tblName

The Table's Name of the updated row.

cells

The array of cellObject containing cell information.

parentConstraints

The value of the parent keys if updated row's table is childtable.

keyValue

The value of the DataValueField for the given row. (Blank for AddRow request)

position

The position of the updated row.

 

The CellObject contains following properties:

text

The new text of the cell.

value

The new value of the cell.

columnName

The column name of the cell.

modified

The value indicates whether the cell is modified during edit mode.

oldText

The old text of the cell.

oldValue

The old value of the cell.

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.