Filtering Class Members

The following tables list the members exposed by Filtering.

Public Constructors

	Name	Description
	Filtering Constructor	Constructor for Filtering beahvior.

Public Properties

	Name	Description
	Alignment	Determines the location of the filter row. Top - It will appear in the header of the grid. Bottom - It will appear in the footer of the grid.
	AnimationDurationMs	The duration of the animation that the filter rule dropdown will play while its displaying or hiding in milliseconds
	AnimationEnabled	Determines whether the filter rule dropdown will play an animation while it is displaying or hiding
	AnimationType	The type of animation that the filter rule dropdown will play when it is displaying or hiding.
	BeforeFilterItemApplyTemplateHandled	Indicates whether the BeforeFilterItemApplyTemplate event is handled
	BeforeFilterItemMatchTemplateHandled	Indicates whether the BeforeFilterItemMatchTemplate event is handled
	CaseSensitive	Controls whether filtering will be case sensitive or not.
	ColumnFilters	Returns a ColumnFilters collection.
	ColumnSettings	Returns a ColumnFilteringSettings collection.
	EditCellCssClass	Returns/sets the css class used to style the editable cell. (Inherited from Infragistics.Web.UI.GridControls.EditableBehaviorBase)
	EditModeActions	Returns the action that will cause the cell to enter editmode. (Inherited from Infragistics.Web.UI.GridControls.EditableBehaviorBase)
	Enabled	Overridden. Determines if the behavior is enabled.
	EnableInheritance	This property will have an affect only for WebHierarchicalDataGrid and when set to true will enable the behavior for child bands. (Inherited from Infragistics.Web.UI.GridControls.EditableBehaviorBase)
	FilterButtonCssClass	Used to set the look and feel of the filter button.
	Filtered	Indicated whether the grid data is currently filtered.
	FilteredHeaderButton	The button object that will be displayed in the grid's column header for showing the filter drop down for when FilterType is ExcelStyleFilter after the column has a filter applied.
	FilterHeaderButton	The button object that will be displayed in the grid's column header for showing the filter drop down for when FilterType is ExcelStyleFilter before the column has a filter applied.
	FilteringClientEvents	List of events which are fired on client side.
	FilteringCssClass	Used to set the look and feel of the filter row
	FilterItemXmlAttributesHandled	Indicates whether the FilterItemXmlAttributes event is handled
	FilterRowSelectorImageCssClass	The CSS Class that will be applied to the ImageArea of the RowSelector of the Filter Row. This class is available for setting the BackgroundImage of the RowSelector.
	FilterRuleDropDownCssClass	Used to set the look and feel of the filter rule dropdown
	FilterRuleDropDownHoverItemCssClass	Used to set the look and feel of the filter rule dropdown hovered over item
	FilterRuleDropDownItemCssClass	Used to set the look and feel of the filter rule dropdown item
	FilterRuleDropDownListCssClass	Used to set the look and feel of the list elements for excel style filter rule dropdown
	FilterRuleDropDownSelectedItemCssClass	Used to set the look and feel of the filter rule dropdown selected item
	FilterRuleDropdownZIndex	Sets/Gets the Z-Index of the filter rule dropdown element.
	FilterType	Indicates what type of filtering will be enabled. RowFilter - allows one filtering condition per column, where you specify a rule (Equals, GreaterThan, ect) and a value. ExcelStyleFilter - in this mode you get a list of unique values in that column which can be (un)selected by checkboxes.
	Grid	A reference to the grid the behavior belongs to. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
	HasDataFilteredHandled	Indicates if the data filtered event is handled.
	HasDataFilteringHandled	Indicates if the data filtering event is handled.
	HasPopulateUniqueFilterValuesHandled	Indicates if the PopulateUniqueFilterValues event is handled.
	Index	Index of the behavior inside of the behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
	IsEmpty	Checks 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)
	Name	Overridden. Overriden. Keeps the behavior name.
	NullValueText	The text in the filter dropdown for null values when FilterType is ExcelStyleFilter.
	OwnerCollection	A reference to the grid behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
	UniqueDataValues	Property that stores the UniqueDataValues
	UniqueValueCasing	Indicates how the text of the unique value is displayed if filter type is RowFilter and filtering is not case sensitive.
	Visibility	Used to determine whether the user interface is visible for Filtering behavior. Hidden - filter row will not be visible Visible - filter row will be visible

Protected Properties

	Name	Description
	AdditionalClientState	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	CollectionData	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	ColumnSettingName	Return ColumnSettingName (Inherited from Infragistics.Web.UI.GridControls.EditableBehaviorBase)
	ControlRunBot	Returns reference to the Grid's runbot (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
	DelayLoadingClientCollections	Customizes 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)
	HasColumnSettings	Returns true if the private column settings object is not null (Inherited from Infragistics.Web.UI.GridControls.EditableBehaviorBase)
	IsTrackingViewState	This 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)
	PropCount	Overridden. 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.
	RequiresDataBinding	Indicates if the behavior requires data binding when added or removed from grid's behavior collection. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
	TransactionLists	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	ViewState	Property to return the ViewState bag for the object. If none exist, then one is created. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)

Public Methods

	Name	Description
	ApplyFilter	Filters the data in WebDataGrid
	ClearBehaviorColumnInfo	Clears the ColumnFilters collection. This method will be called when the grid's datasource is switched from the designer
	Clone	Overridden. Create clone
	CopyTo	Overridden. Copies properties from the current object into the passed in object
	CreateColumnSettings	Overridden. Creates and initializes an instance of the ColumnSettingCollection object
	IsDirty	Overloaded. 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)
	OnBeforeFilterItemApplyTemplate	Raises the BeforeFilterItemApplyTemplate event.
	OnBeforeFilterItemMatchTemplate	Raises the BeforeFilterItemMatchTemplate event.
	OnDataFiltered	Fires the DataFiltered event. Called by filtering whenever a data has been filtered.
	OnDataFiltering	Fires the DataFiltering event. Called by filtering whenever a data is about to be filtered. Cancelable envet
	OnFilterItemXmlAttributes	Raises the FilterItemXmlAttributes event.
	RenderCellValue	Returns the value as a string (Inherited from Infragistics.Web.UI.GridControls.EditableBehaviorBase)
	ToString	Returns string representation of the object. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)

Protected Methods

	Name	Description
	BehaviorEvents_PreRender	Overridden. Handles the PreRender event
	ClearSelection	Removes any selected rows or cells from the SelectedCellCollection and SelectedRows Collection
	CreateClientEvents	Overridden. Control which exposes ClientEvents must override that method and return instance of ClientEvents object.
	CreateNewInstance	Creates 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)
	Flush	Empties 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)
	GetClientPropertiesArray	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	GetRoleCount	Overridden. The amount of Stylable roles on the behavior.
	GetRoleInfo	Overridden. Gets the RoleInfo object at the specified index.
	LoadAdditionalClientState	This method is called when additional information is passed from the client, via the _saveAdditionalClientState javascript method (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientCollections	Overridden. Loads the Collections that were sent down to the client, back into the control.
	LoadClientCollectionsTransactionList	Reads the TransactionList and repopulates the collections of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientObjects	Overridden. Loads the Objects that were sent down to the client, back into the control.
	LoadClientObjectsTransactionList	Overridden. Reads the Transaction List and repopulates the objects of the control.
	LoadClientProperties	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientPropsTransactionList	Reads the Transaction List and repopulates the properties of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadClientState	This 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)
	LoadClientStateFromViewState	Checks to see if ClientState was saved into Viewstate, if so, then it loads. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadCollectionsStateFromViewState	Loads 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)
	LoadOccasionalProperties	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadOccasionalProperty	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadPositionalProperties	Loads client state properties from the client (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadPositionalProperty	Load positional property at index (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadTransactionList	Loads the transaction list. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	LoadViewState	Overridden. Load data modified at run time.
	MultiInstancesAllowed	Indicates whether functionality can be added into the functionality collection multiple times. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
	OnAction	Overridden. Overrides base class' method. Handles processing of filtering.
	OnCallbackCreated	Overridden. Overrides base class' method. Called when an asynchronous request is initiated by the filtering
	OnCallbackRender	Called when the behavior needs to returns its response to an asynchrohous request. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
	OnItemCommand	Called 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)
	OnLoad	Overridden. Called when the Filtering behavior is enabled.
	OnPartialClear	Called 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)
	OnPropertyChange	Overloaded. Virtual method that is called whenever a server state property within the object has been changed. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	OnUnload	Overridden. Called when the Filtering behavior is disabled.
	PreFetchPositionalClientProperty	Fetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	RegisterScripts	Overridden. The method is called by the framework to register any script references.
	ResetClientState	Resets the positional and occasional property stringBuffers to initial empty values. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	SaveClientCollections	Saves all Collections that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.GridControls.EditableBehaviorBase)
	SaveClientObjects	Overridden. Saves all objects that should go to the client into a javascript array.
	SaveClientProperties	Overloaded. Overridden. Saves any additional properties to be brought to the client.
	SaveClientStateToViewState	If 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)
	SaveCollectionsStateToViewState	Saves 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)
	SaveViewState	Overridden. Save data modified at run time.
	ShouldSerializeColumnFilters	Determines if ColumnFilters should be persisted
	ShouldSerializeColumnSettings	Determines if the ColumnSettings should be serialized.
	TrackViewState	Overrides base class' method. Enables the view state tracking for the behavior. (Inherited from Infragistics.Web.UI.GridControls.EditableBehaviorBase)
	WriteAdditionalClientProperties	Called by the framework for the behavior to add its additional client roperties. (Inherited from Infragistics.Web.UI.GridControls.GridBehavior)
	WriteClientCollections	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	WriteClientObjects	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	WriteClientOnlyProperty	Stores 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)
	WriteClientProperties	(Inherited from Infragistics.Web.UI.Framework.ObjectBase)
	WriteClientState	Responsible 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)
	WritePositionalProperty	Writes 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

	Name	Description
	BeforeFilterItemApplyTemplate	Event that should be raised before Item apply template is rendered.
	BeforeFilterItemMatchTemplate	Event that should be raised before Item match is rendered.
	DataFiltered	Occurs when a filters have be applied to the grid's data.
	DataFiltering	Occurs when a filters are about to be applied to the grid's data.
	FilterItemXmlAttributes	Event that should be raised after Fileting has added XmlAttributes to its Item, so other XmlAttributes can be added.
	PopulateUniqueFilterValues	Occurs when right before filtering behavior goes back to the client. This event needs to be handled when CustomDatabinding is used for the grid to provide the values that filtering needs to display for each column when filteringType is ExcelStyleFiltering.

Reference

Filtering Class
Infragistics.Web.UI.GridControls Namespace

ASP.NET | Help Topics

Filtering Class Members

Reference