Version

ColumnFixing Class Members

The following tables list the members exposed by ColumnFixing.

Public Constructors
 NameDescription
Public ConstructorColumnFixing ConstructorDefault constructor for the ColumnFixing Behavior  
Public Properties
 NameDescription
Public PropertyAutoAdjustCellsControls whether the cell height of the unfixed columns needs to be kept in sync with the cell height of the fixed columns. If this property is not turned on then the cell style may not be applied to the whole cell area of the cells of unfixed columns. However, turning this property on, will significantly slow down the grid and this property should only be turned on for grid which do not have many rows.

True - adjust cell height.

False - do not adjust cell height (Default).

 
Public PropertyCellCssClassThe name of the CSS style class that will be applied to fixed columns cells (to both the left and right fixed columns)  
Public PropertyColumnFixingClientEventsHolds client side event definitions for the column fixing.  
Public PropertyColumnSettingsReturns the ColumnFixingSettings collection.  
Public PropertyEnabledDetermines if the behavior is enabled. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyFixButtonAlignmentIndicate whether the fix button/pin is located to the left or to the right of the header caption.  
Public PropertyFixedColumnsReturns a FixedColumnInfoCollection collection, which contains the columns which are currently fixed  
Public PropertyFixLocationThe direction to which all columns are fixed to unless otherwise specified in the ColumnSetting object for the column

Left - the columns will be fixed to the left edge of the grid

Right - the columns will be fixed to the right edge of the grid

 
Public PropertyFooterCssClassThe name of the CSS style class that will be applied to fixed columns footers (to both the left and right fixed columns)  
Public PropertyGridA reference to the grid the behavior belongs to. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyHasFixedStateChangedHandledIndicates if the fixed state changed event is handled.  
Public PropertyHeaderCssClassThe name of the CSS style class that will be applied to fixed columns headers (to both the left and right fixed columns)  
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. Overriden. Keeps the behavior name.  
Public PropertyOwnerCollectionA reference to the grid behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Public PropertyPinButtonThe button object that will be displayed in the grid's column header for unfixed column, which are allowed to be fixed through the UI.  
Public PropertySeparatorCssClassName of the CSS style class that will be applied to the separator/divider line that separates the fixed columns from the regular columns  
Public PropertyShowFixButtonsBoolean property, which determines if the pin buttons for fixing columns are shown next to the header caption.

True - the buttons are shown, this is the default

False - the buttons are not shown and columns can be fixed only programmatically.

 
Public PropertyShowLeftSeparatorBoolean property which controls whether the separator line is shown between the columns that are fixed on the left hand-side of the grid and the rest of the grid columns.

True - show the separator (Default)

False - do not show the separator

 
Public PropertyShowRightSeparatorBoolean property which controls whether the separator line is shown between the columns that are fixed on the right hand-side of the grid and the rest of the grid columns.

True - show the separator (Default)

False - do not show the separator

 
Public PropertyUnpinButtonThe button object that will be displayed in the grid's column header for fixed column, which are allowed to be unfixed through the UI.  
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 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 MethodCopyToCopies properties from the current object into the passed in object (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
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 column fixing settings  
Public MethodOnFixedStateChangedFires the FixedStateChanged event. Called by the column fixing whenever a column is fixed or unfixed.  
Public MethodSaveSettingsCustom persistence logic for saving column fixing settings  
Public MethodToStringReturns string representation of the object. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
Protected Methods
 NameDescription
Protected MethodColumnFixing_FilterItemXmlAttributesAdds xml attributes to filter cells when column fixing is on  
Protected MethodCreateCaptionRowUnfixedMatch  
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. Returns A RoleInfo corresponding to an item in the WebDataGridRowSelectorRoles enumeration.  
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 MethodLoadClientCollectionsTransactionListOverridden. Reads the TransactionList and repopulates the collections of the control.  
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 column fixing 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 filtering.  
Protected MethodOnCallbackCreatedOverridden. Overrides base class' method. Called when an asynchronous request is initiated by the filtering  
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 ColumnFixing 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 behavior is being unloaded. This is usually a good place to unhook all of the internal event handlers.  
Protected MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodRegisterScriptsOverridden. The method is called by the framework to register any 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 MethodSaveViewStateOverridden. Save data modified at run time.  
Protected MethodShouldSerializeColumnSettingsDetermines if the ColumnSettings 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 EventFixedStateChangedEvent that is fired every time a columns is fixed or unfixed by the user.  
See Also