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






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

Syntax

Visual Basic (Declaration) 
<ISNet.EventParameterAttribute("controlId, tblName, sourceIndex, targetIndex, sourceColumn, targetColumn")>
<DefaultValueAttribute()>
<DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is being moved.")>
<ISNet.Serialization.XmlSerializableAttribute()>
<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.Serialization.BinarySerializableAttribute()>
Public Property OnColumnMove As String
Visual Basic (Usage)Copy Code
Dim instance As ClientEvents
Dim value As String
 
instance.OnColumnMove = value
 
value = instance.OnColumnMove
C# 
[ISNet.EventParameterAttribute("controlId, tblName, sourceIndex, targetIndex, sourceColumn, targetColumn")]
[DefaultValueAttribute()]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is being moved.")]
[ISNet.Serialization.XmlSerializableAttribute()]
[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.Serialization.BinarySerializableAttribute()]
public string OnColumnMove {get; set;}
Delphi 
public read-write property OnColumnMove: String;
JScript 
ISNet.EventParameterAttribute("controlId, tblName, sourceIndex, targetIndex, sourceColumn, targetColumn")
DefaultValueAttribute()
DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is being moved.")
ISNet.Serialization.XmlSerializableAttribute()
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.Serialization.BinarySerializableAttribute()
public function get,set OnColumnMove : String
Managed Extensions for C++ 
[ISNet.EventParameterAttribute("controlId, tblName, sourceIndex, targetIndex, sourceColumn, targetColumn")]
[DefaultValueAttribute()]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is being moved.")]
[ISNet.Serialization.XmlSerializableAttribute()]
[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.Serialization.BinarySerializableAttribute()]
public: __property string* get_OnColumnMove();
public: __property void set_OnColumnMove( 
   string* value
);
C++/CLI 
[ISNet.EventParameterAttribute("controlId, tblName, sourceIndex, targetIndex, sourceColumn, targetColumn")]
[DefaultValueAttribute()]
[DescriptionAttribute("Specifies the client side (JavaScript) function that will be invoked when a column is being moved.")]
[ISNet.Serialization.XmlSerializableAttribute()]
[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.Serialization.BinarySerializableAttribute()]
public:
property String^ OnColumnMove {
   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 moved.
C#Copy Code
WebGrid1.LayoutSettings.ClientSideEvents.OnColumnMove = "WebGrid1_ColumnMove";
The following is the example of the javascript function that is assigned in above event.
JScriptCopy Code
function WebGrid1_OnColumnMove(controlId, tblName, sourceIndex, targetIndex, sourceColumn, targetColumn) 
{ 
   var WebGrid1 = ISGetObject(controlId); 

   alert("The column that being moved is number "+ sourceIndex) 

   return true; 
}

Remarks

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

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 column being moved.

sourceIndex

The source column's cellIndex.

targetIndex

The target column's cellIndex.

sourceColumn

The source column's client object.

targetColumn

The target column's client 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

Reference

ClientEvents Class
ClientEvents Members

Concepts

Events

©2012 Intersoft Solutions Corp. All Rights Reserved.