Version

RowEditingTemplate Class Members

The following tables list the members exposed by RowEditingTemplate.

Public Constructors
 NameDescription
Public ConstructorRowEditingTemplate ConstructorDefault constructor.  
Public Properties
 NameDescription
Public PropertyCancelButtonThe ID of the button object on the Row Edit Template that will cancel changes and close the template area.  
Public PropertyClientBindingsMap of get/set value JavaScripts and corresponding columns in the grid.  
Public PropertyDropDownZIndexThe DropDownZIndex allows the programmer to set the z-index of the of the RowEditTemplate to ensure that the RowEditTemplate will show up on top of the Grid.  
Public PropertyEditModeActionsReturns the action that will cause the cell to enter editmode.  
Public PropertyEnabledDetermines if the behavior is enabled. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyEnableInheritanceThis property will have an affect only for WebHierarchicalDataGrid and when set to true will enable the behavior for child bands.  
Public PropertyGridA reference to the grid the behavior belongs to. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyHasRowEditingTemplateIndicates whether the bahavior has its template assigned and instantiated.  
Public PropertyIndexIndex of the behavior inside of the behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyIsEmptyChecks if ViewState has any property with not a default value. This property should be overriden by extended class when additional subobjects are supported. IsEmpty will then check each subobject and return a value based on the check of those objects plus itself. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public PropertyNameOverridden. Holds name of the behavior. It's "RowEditing" for the edit row template behavior.  
Public PropertyOKButtonThe ID of the button object on the Row Edit Template that will accept changes and close the template area.  
Public PropertyOwnerCollectionA reference to the grid behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyRowEditingClientEventsHolds client side event definitions for the edit row template.  
Public PropertyTemplateReference to the behavior's template.  
Public PropertyTemplateContainerReference to the behavior's template container.  
Protected Properties
 NameDescription
Protected PropertyAdditionalClientState (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyCollectionData (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyControlRunBotReturns reference to the Grid's runbot (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
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 PropertyPropCountOverridden. The number of properties for RowEditingTemplate  
Protected PropertyRequiresDataBindingIndicates if the behavior requires data binding when added or removed from grid's behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
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 MethodClearBehaviorColumnInfoClears the client bindings collection  
Public MethodCloneOverridden. Create clone of the object  
Public MethodCopyToOverridden. Copies properties from the current object into the passed in object  
Public MethodGetTemplateNamesGets names of the templates supported by the edit row template behavior.  
Public MethodInstantiateTemplatesThe method is called by the framework to intstantiate the behavior's templates.  
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 MethodToStringReturns string representation of the object. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected Methods
 NameDescription
Protected MethodCreateClientBindingsCreates and returns an instance of the client bindings object. Can be overriden in an inherited class and a substitude object can be returned.  
Protected MethodCreateClientEventsOverridden. Overrides base class' method. Returns an instance of RowEditingClientEvents.  
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 MethodGetClientPropertiesArray (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodGetRoleCountIndicates how many app styling roles the functionality supports. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodGetRoleInfoGets reference to a role info by its index. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
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 MethodLoadClientCollectionsOverridden. Loads the Collections that were sent down to the client, back into the control.  
Protected MethodLoadClientCollectionsTransactionListReads the TransactionList and repopulates the collections of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsOverridden. Loads the Objects that were sent down to the client, back into the control.  
Protected MethodLoadClientObjectsTransactionListOverridden. Reads the Transaction List and repopulates the objects of the control.  
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 MethodLoadViewStateOverridden. Load data modified at run time.  
Protected MethodMultiInstancesAllowedIndicates whether functionality can be added into the functionality collection multiple times. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodOnActionCalled in a response to an action that happened on the client. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodOnCallbackCreatedCalled when an asynchrohous request is initiated by the behavior. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodOnCallbackRenderCalled when the behavior needs to returns its response to an asynchrohous request. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodOnItemCommandCalled for every behavior to give it a chance to handle the command bubbled from inside of the child controls collection of the grid. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodOnLoadOverridden. Overrides the parent class' method. Hooks up to the grid's behavior events at that point.  
Protected MethodOnPartialClearOverridden.   
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 MethodOnUnloadOverridden. Overrides the parent class' method. Frees all event handler of the behavior.  
Protected MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodRegisterScriptsOverridden. Overrides base class' method. Called by the framework for the edit row behavior to provide its script references.  
Protected MethodResetClientStateResets the positional and occasional property stringBuffers to initial empty values. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientCollectionsOverridden. Saves all Collections that should go to the client into a javascript array.  
Protected MethodSaveClientObjectsOverridden. Saves all objects that should go to the client into a javascript array.  
Protected MethodSaveClientPropertiesOverloaded. Overridden. Saves extra properties to send to the client.  
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 MethodSaveViewStateOverrides base class' method. Saves the view state of the behavior. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodTrackViewStateOverrides base class' method. Enables the view state tracking for the behavior. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected MethodWriteAdditionalClientPropertiesCalled by the framework for the behavior to add its additional client roperties. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
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