Version

Selection Class Members

The following tables list the members exposed by Selection.

Public Constructors
 NameDescription
Public ConstructorSelection Constructor  
Public Properties
 NameDescription
Public PropertyAutoPostBackFlagsReturns the SelectionAutoPostBackFlags for the Selection behavior  
Public PropertyCellClickActionReturns/sets the action that will occur when a cell is clicked on the WebDataGrid.  
Public PropertyCellSelectTypeDetermines how many cells can be selected at any given time.

Note: this property relates only to the UI functionality. Cells can still be selected via the API.

None - Cells will not be selected.

Single - Only one cell can be selected at a time.

Multiple - More than one cell can be selected at the same time.

 
Public PropertyColumnSelectTypeDetermines how many columns can be selected at any given time.

Note: this property relates only to the UI functionality. Columns can still be selected via the API.

None - Columns will not be selected.

Single - Only one column can be selected at a time.

Multiple - More than one column can be selected at the same time.

 
Public PropertyEnableCrossPageSelectionSetting this property to true allows selected rows/cells from one page to be retained while the page is switched.  
Public PropertyEnabledDetermines if the behavior is enabled. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyEnableHiddenSelectionDirects the behavior to skip over hidden columns when continuous cell or column selection is being done.  
Public PropertyGridA reference to the grid the behavior belongs to. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
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. Returns the name of the object. This name is used on client to create the object.  
Public PropertyOwnerCollectionA reference to the grid behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyRowSelectTypeDetermines how many rows can be selected at any given time.

Note: this property relates only to the UI functionality. Rows can still be selected via the API.

None - Rows will not be selected.

Single - Only one row can be selected at a time.

Multiple - More than one row can be selected at the same time.

 
Public PropertySelectedCellCssClassThe CssClass that will be applied when a cell is selected.  
Public PropertySelectedCellsA collection of cells that are currently selected in the WebDataGrid.

To select a cell, use the Add method off of the Collection.

To unselect a cell, use the Remove method off of the Collection.

 
Public PropertySelectedColumnsA collection of columns that are currently selected in the WebDataGrid.

To select a column, use the Add method off of the Collection.

To unselect a column, use the Remove method off of the Collection.

 
Public PropertySelectedHeaderCssClassThe CssClass that will be applied to a column header when a column is selected.  
Public PropertySelectedRowsA collection of rows that are currently selected in the WebDataGrid.

To select a row, use the Add method off of the Collection.

To unselect a row, use the Remove method off of the Collection.

 
Public PropertySelectedRowSelectorCssClassThe CssClass that will be applied to the row selector when a row is selected.  
Public PropertySelectedRowSelectorImageCssClassThe CssClass that will be applied to the row selector image when a row is selected.  
Public PropertySelectionClientEventsList of events which are fired on client side.  
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. Returns the total number of properties on the object that should go to the client.. This should be calculated by taking the amount of Properties on the base class plus the amount of properties on this class. If you are deriving from this object and need to add additional client properties, you must override this property.  
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 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 MethodLoadSettingsCustom persistence logic for loading selection settings  
Public MethodSaveSettingsCustom persistence logic for saving selection settings  
Public MethodToStringReturns string representation of the object. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected Methods
 NameDescription
Protected MethodCreateClientEventsOverridden. Control which exposes ClientEvents must override that method and return instance of ClientEvents object.  
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 MethodGetRoleCountOverridden. The amount of Stylable roles on the behavior.  
Protected MethodGetRoleInfoOverridden. Gets the RoleInfo object at the specified index.  
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 MethodLoadClientPropsTransactionListOverridden. The Selection behavior, overrides this method to load it's collections back to the original state they were in, prior to the last postback.  
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 MethodLoadPositionalPropertyOverridden. The Selection behavior, overrides this method to update it's collections to the state they were in on the clientside. This is also where it builds it's EventList so that it knows which server events need to fire.  
Protected MethodLoadTransactionListLoads the transaction list. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadViewStateOverrides base class' method. Loads the view state of the behavior. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
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. Called when the Selection behavior is enabled.  
Protected MethodOnPartialClearCalled when the behaviors collection is being partially cleared. This is where the behavior will have to remove any controls it added to the grid's controls collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
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. Called when the Selection behavior is disabled.  
Protected MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodRegisterScriptsOverridden. Overrides the method to register script files of the selection behavior.  
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. Overridden. The Selection behavior, overrides this method to save each of it's collections as an object array so that it can be serialized 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)
Public Events
 NameDescription
Public EventCellSelectionChangedOccurs when the SelectedCells collection changes between posts to the server.  
Public EventColumnSelectionChangedOccurs when the SelectedColumns collection changes between posts to the server.  
Public EventRowSelectionChangedOccurs when the SelectedRows collection changes between posts to the server.  
See Also