Version

Sorting Class Members

The following tables list the members exposed by Sorting.

Public Constructors
 NameDescription
Public ConstructorSorting ConstructorDefault constructor.  
Public Properties
 NameDescription
Public PropertyAscendingImageAltTextAlternate text of the ascending order image.  
Public PropertyAscendingImageUrlA url to the ascending order image that appears in the header after a column is sorted. If nothing is assigned to the property the image with the name "igg_sortAsc.gif" from current Application Styling images directory is used.  
Public PropertyColumnSettingsReturns the SortingColumnSettings collection.  
Public PropertyDescendingImageAltTextAlternate text of the descending order image.  
Public PropertyDescendingImageUrlA url to the descending order image that appears in the header after a column is sorted. If nothing is assigned to the property the image with the name "igg_sortDesc.gif" from current Application Styling images directory is used.  
Public PropertyEnableCellMergingDefines whether to merge cells in a sorted column that have the same value  
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 PropertyHasColumnSortedHandledIndicates if the sorted columns event is handled.  
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 "Sorting" for the sorting behavior.  
Public PropertyOwnerCollectionA reference to the grid behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertySortSQL-like sort expression. Before adding the column name to the sort expression EncodeColumnName method should be called on it.  
Public PropertySortedColumnsCollection of currently sorted columns.  
Public PropertySortingClientEventsHolds client side event definitions for the sorting.  
Public PropertySortingModeDefines sorting mode - single or multi column sorting. In the multi column sorting mode the Ctrl key should be held to sort on multiple columns.  
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 number of properties for the client state supported by the sorting behavior.  
Protected PropertyRequiresDataBindingOverridden. Returns true that this behavior requires data binding  
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 MethodCloneOverridden. Create clone  
Public MethodCopyToOverridden. Copies properties from the current object into the passed in object  
Public MethodEncodeColumnNameThis method will encode the column name based on the datasource and should be called for each column before adding it to the Sort expression.  
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 MethodOnColumnSortedFires the ColumnSorted event. Called by the sorting whenever a column is sorted.  
Public MethodOnRemovedFromCollectionOverridden. Cleaning up after the behavior by clearing sorted columns  
Public MethodToStringReturns string representation of the object. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected Methods
 NameDescription
Protected MethodClearSelectionClears selected rows and cells collections of ISelection behaviors  
Protected MethodCreateClientEventsOverridden. Overrides base class' method. Returns an instance of SortingClientEvents.  
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 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 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. Overrides the base class' method. Loads transactions specific to the sorting behavior.  
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 MethodOnActionOverridden. Overrides base class' method. Handles processing of the sorting.  
Protected MethodOnCallbackCreatedOverridden. Overrides base class' method. Called when an asynchronous request is initiated by the sorting - a column is being sorted and the sorting is in the AJAX mode.  
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 base behavior's GridBehavior.OnLoad method. Hooks up all of the internal events from inside of the method.  
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. Overrides base class' method. Unhooks all of the internal event handlers previously hooked by the sorting.  
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 sorting 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 MethodSaveClientObjectsSaves all objects that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
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 MethodSaveViewStateOverridden. Overrides base class' method. Saves extra information into the view state.  
Protected MethodShouldSerializeColumnSettingsDetermines if the ColumnSettings should be serialized.  
Protected MethodShouldSerializeSortDetermines if Sort property should be serialized.  
Protected MethodTrackViewStateOverridden. Overrides base class' method. Enables the view state tracking for the behavior.  
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 EventColumnSortedEvent that is fired every time a columns is sorted by the user.  
See Also