Version

GridClientEvents Class Members

The following tables list the members exposed by GridClientEvents.

Protected Fields
 NameDescription
Protected FieldNumberOfPropertiesThe number of ClientEvents exposed by the control, including base class ClientEvents. If deriving from this control, a new instance of the property should be created.  
Public Properties
 NameDescription
Public PropertyAJAXResponseEvent fired when control gets AJAX response from the server. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Public PropertyAJAXResponseErrorEvent fired when control gets AJAX response from the server. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Public PropertyClickEvent fired when the left mouse button click is done over one of the grid's elements. Corresponds to the browser's Click event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
To determine which object type the event has happenned for call args.get_type();
Available types of objects are: "cell", "row", "header", "footer".
To get reference to the corresponding client side object call args.get_item();  
Public PropertyContextMenuEvent fired when the context menu is being shown for one of the grid's elements. Corresponds to the browser's ContextMenu event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
To determine which object type the event has happenned for call args.get_type();
Available types of objects are: "cell", "row", "header", "footer".
To get reference to the corresponding client side object call args.get_item();  
Public PropertyDataBindingOccurs when the control binds to a data source on the client. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
\  
Public PropertyDataBoundEvent fired after client side binding is completed. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
\  
Public PropertyDoubleClickEvent fired when the left mouse button double click is done over one of the grid's elements. Corresponds to the browser's DblClick event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
To determine which object type the event has happenned for call args.get_type();
Available types of objects are: "cell", "row", "header", "footer".
To get reference to the corresponding client side object call args.get_item();  
Public PropertyHeaderCheckBoxClickedThis is fired after an unbound checkbox field's header checkbox has been clicked and the check state has changed.  
Public PropertyHeaderCheckBoxClickingThis is fired after an unbound checkbox field's header checkbox has been clicked, but before the check state has been changed. To cancel this event call args.set_cancel(true);
\  
Public PropertyInitializeGets sets name of javascript function which is called after javascript object was created and initialized. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Public PropertyIsEmptyChecks if all properties have default values. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Public PropertyKeyDownEvent fired when the grid is in focus and a key is pressed down. Corresponds to the browser's KeyDown event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);  
Public PropertyKeyPressEvent fired when the grid is in focus and a key is pressed. Corresponds to the browser's KeyPress event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);  
Public PropertyKeyUpEvent fired when the grid is in focus and a key is released. Corresponds to the browser's KeyUp event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);  
Public PropertyMouseDownEvent fired when the mouse is pressed down over one of the grid's elements. Corresponds to the browser's MouseDown event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
To determine which object type the event has happenned for call args.get_type();
Available types of objects are: "cell", "row", "header", "footer".
To get reference to the corresponding client side object call args.get_item();  
Public PropertyMouseMoveEvent fired when the mouse pointer moves within the grid's area. Corresponds to the browser's MouseMove event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
To determine which object type the event has happenned for call args.get_type();
Available types of objects are: "cell", "row", "header", "footer".
To get reference to the corresponding client side object call args.get_item();  
Public PropertyMouseOutEvent fired when the mouse pointer leaves an element in the grid. Corresponds to the browser's MouseOut event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
To determine which object type the event has happenned for call args.get_type();
Available types of objects are: "cell", "row", "header", "footer".
To get reference to the corresponding client side object call args.get_item();  
Public PropertyMouseOverEvent fired when the mouse pointer is placed over an element in the grid. Corresponds to the browser's MouseOver event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
To determine which object type the event has happenned for call args.get_type();
Available types of objects are: "cell", "row", "header", "footer".
To get reference to the corresponding client side object call args.get_item();  
Public PropertyMouseUpEvent fired when the mouse is released over one of the grid's elements. Corresponds to the browser's MouseUp event. This is a cancelable event. The event handler gets two parameters: sender and args. The sender is a reference to the grid's client side object; the browser's event object can be obtained off the args parameter: args.get_browserEvent();
To cancel this event call args.set_cancel(true);
To determine which object type the event has happenned for call args.get_type();
Available types of objects are: "cell", "row", "header", "footer".
To get reference to the corresponding client side object call args.get_item();  
Public PropertyRowRenderedEvent fired after a row is rendered to the DOM when client side binding is enabled.  
Public PropertyRowRenderingEvent fired before a row is rendered to the DOM when client side binding is enabled.  
Protected Properties
 NameDescription
Protected PropertyAdditionalClientState (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyCollectionData (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyDelayLoadingClientCollectionsCustomizes the client collections loading. If true the collections will be loaded after view state has been loaded. If false the collections will be loaded in RunBot.HandleOnInit. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyIsTrackingViewStateThis method returns a boolean value which indicates whether ViewState is being tracked for the object. Once viewstate is being tracked, all property changes are roundtripped from server to client and back within the ViewState hidden field. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyOwnerGet reference to owner. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Protected PropertyPropCountThis property is used to track the number of properties this object is sending to ClientState. Each derived class overrides this property to indicate the new total of properties. The number consists of the PropCount value of the base class plus the number of ClientState properties utilized by each derived class. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyTransactionLists (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyViewStateProperty to return the ViewState bag for the object. If none exist, then one is created. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public Methods
 NameDescription
Public MethodCloneClones the object (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public MethodIsDirtyOverloaded. This method determines if the property with the specified Id within the ViewState bag is dirty and needs to be sent to and from the client. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public MethodToStringString formatted for visual designer. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Protected Methods
 NameDescription
Protected MethodAddNamesAdd additional properties the base ClientEvents. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Protected MethodCreateNewInstanceCreates a new instance of the current type using the default constructor. Derived classes may override the method if there is no parameterless constructor or any other custom logic applies. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodFlushEmpties the positional and occasional property stringBuffers and converts them to a string representation that can be written to the response stream. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodGetClientEventNameListGet list of property names which should be used on client. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Protected MethodGetClientPropertiesArray (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodGetPropertyGet value of a property. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Protected MethodLoadAdditionalClientStateThis method is called when additional information is passed from the client, via the _saveAdditionalClientState javascript method (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientCollectionsLoads the Collections that were sent down to the client, back into the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientCollectionsTransactionListReads the TransactionList and repopulates the collections of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsLoads the Objects that were sent down to the client, back into the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsTransactionListReads the Transaction List and repopulates the objects of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientPropsTransactionListReads the Transaction List and repopulates the properties of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateThis method takes the state from the client and loads the control's Properties, Objects, and Collections, that were sent down to the client on the last post. It also stores the TransactionLists for the Properties, Objects, and Collections. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateFromViewStateChecks to see if ClientState was saved into Viewstate, if so, then it loads. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadCollectionsStateFromViewStateLoads the saved into view state client collections and deserializes the string as it came from the client side. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperty (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertiesLoads client state properties from the client (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertyLoad positional property at index (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadTransactionListLoads the transaction list. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadViewStateThis method loads the data contained in the state parameter into the ViewState bag for the object. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodOnPropertyChangeOverloaded. Virtual method that is called whenever a server state property within the object has been changed. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodPostBackActionOverridden. This method is called for each ClientEvent property. Logic should be placed here to determine if a particular client event should cause a PostBack.  
Protected MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodResetClientStateResets the positional and occasional property stringBuffers to initial empty values. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientCollectionsSaves all Collections that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientObjectsSaves all objects that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientPropertiesOverloaded. Virtual method that serializes the ClientState properties of the object to a JSON stream that will be accessed from the client. The FullAddress property of the Object is also accessed in this process to identify the object being serialized to JSON. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientStateToViewStateIf the control is not visible, we don't want to loose our ClientState during the next postback, so lets store it in ViewState. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveCollectionsStateToViewStateSaves the client collections state as string into the view state. This way we can skip the expensive serialization on the client side and not send them at all. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveViewStateThis method saves the property settings in the ViewState bag to the ViewState hidden field on the page for roundtripping between the server and client. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSetPropertySet value of a property with validation for illegal characters. (Inherited from Infragistics.Web.UI.Framework.ClientEventsBase)
Protected MethodTrackViewStateThis method turns on ViewState tracking for the object (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteAdditionalClientPropertiesIf an object needs to render additional information that needs to be accessed on the client, this is where they can add this information. Note that each object that they need to render should be prefixed with a Comma because the information is being rendered inside of a javascript array. This method is called by WriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientCollections (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientObjects (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientOnlyPropertyStores the property in hashtable, that will be rendered down to the client. Client only properties only get sent down to the client, they do not get sent back to the server. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientStateResponsible for rendering javascript array of all client properties, events, objects and collections Calls helper methods to render each in turn. That method is called to render parameter for initialization (constructor) java-script function. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWritePositionalPropertyWrites the passed in property value at the current position of the ClientState serialization. The property is serialized to the positional properties string of the ClientState string. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
See Also