Note: A parameterless constructor is required for all derived classes.

With the exception of a , it is the responsibilty of derived classes to determine when they should be considered checked in the menu, since the filter provider does not have a means of determining that filtering has been performed via the click of a tool.

Note: The filter provider does not make an attempt to ensure that only one items is checked at a time. The event can be used to manipulate which tools are checked.

Note: No attempt will be made to guarantee uniqueness of this tool based on the id, nor is there a guarantee that a tool will provide an id.

Note: If a tool is set to IsFirstInGroup by default and that tool is removed from the list (such as through the event), the next tool will not automatically become the first tool in the group, so it is up to the developer to handle this.

Note: Changing this property will not have any effect until the next time the menu is shown.

Note: When the buttons are not shown, any changes that are made to the checked nodes in the tree will be applied to the associated column unless the user presses the Esc key.

Note: This property can be overriden on a per-instance basis by setting the s property.

The UltraGridFilterUIProvider allows a user to make use of a more complex, customizable interface in order to manipulate how data is presented to them. This interface uses a familiar design for faster adaptation and comfort, in addition to allowing the developer to provide additional functionality beyond simple filtering.

Filtering is controlled through a series of objects, each of which corresponds to different item that is shown on a menu. The standard types of tools that a user will deal with are s, s, s, and a single instance of a that allows for a finer degree of control over which values should be presented in the associated grid.

Though the filter provider will generate a default list of items based on the underlying data type of the column, items can be added, removed, or repositioned through the and events. This allows the ability to add functionality to the user that can meet the needs of a custom application, such as adding a new FilterButtonTool and handling the event in order to apply sorting to a column.

The appearances of all of the items on the provider can be customized through the , , and properties. In addition, each of the tools can have appearances set indivually through the AfterMenuPopulate event; these settings will override any component-level properties.

Note: The tree is the only area of the UI that is affected by the applyChanges parameter. All other tools shown by the provider trigger actions that immediately apply a filter and close the menu, and so would not have any pending changes to apply.

Note: The grid will not cache the editor returned from this method, so it is up to the implementor to use a caching mechanism, if applicable.

Note: Changing any of these settings while the filter provider is shown will not have any effect. These properties will be honored the next time the provider is displayed.

Note: Changing any of these settings while the filter provider is shown will not have any effect. These properties will be honored the next time the provider is displayed.

Note: Changing any of these settings while the filter provider is shown will not have any effect. These properties will be honored the next time the provider is displayed.

Note: Only the Vista style will have an effect on the FilterTreeTool; all other styles will show the tree with a standard style.

This event is fired after the UltraGrid's event. While the purpose of the grid's event is to populate the contents of the tree, the purpose of this event, and the corresponding , is to handle the creation and positioning of the various menu items that appear when the filter provider is shown.

Note: Marking this event as handled will prevent the provider from adding all standard menu tiems, including the tree. Since the cannot be manually created, if you would like to reposition this element, the AfterMenuPopulate event should be used instead.

This event will fire for all tools that derive from , including those buttons that are created automatically for the registered s. Marking this event as handled will prevent the default logic from being executed, which includes applying any filters to the associated column.