Class FilterControlBase

Represents the control that used to show the filter options.

Inheritance

System.Object

FilterControlBase

DataGridFilterControl

Implements

IThemeProvider

IVisualStyle

Namespace: Syncfusion.WinForms.GridCommon

Assembly: Syncfusion.SfDataGrid.WinForms.dll

Syntax

public class FilterControlBase : UserControl, IThemeProvider, IVisualStyle

Constructors

FilterControlBase()

Initializes a new instance of the FilterControlBase class.

Declaration

public FilterControlBase()

Properties

AdvancedFilterButton

Gets or sets the button that used to switch the view between CheckBox and the Advanced filter.

Declaration

public SortButton AdvancedFilterButton { get; set; }

Property Value

Type
SortButton

AdvancedFilterButtonLabel

Gets or sets the label to display the image in the advanced filter button.

Declaration

public Label AdvancedFilterButtonLabel { get; set; }

Property Value

Type
System.Windows.Forms.Label

AdvancedFilterLabelText

Gets or sets the text that needs to be displayed on the Advanced Filter type label.

Declaration

public string AdvancedFilterLabelText { get; set; }

Property Value

Type
System.String

AdvancedFilterPanel

Gets or sets the advanced filter panel.

Declaration

public Panel AdvancedFilterPanel { get; set; }

Property Value

Type
System.Windows.Forms.Panel

AdvancedFilterType

Gets or sets the filter type of the advanced filter such as Numeric, Text or Date filter.

Declaration

public AdvancedFilterType AdvancedFilterType { get; set; }

Property Value

Type
AdvancedFilterType

AllowBlankFilters

Gets or sets a value indicating whether the Blank filters is enabled for the filter pop up or not.

Declaration

public bool AllowBlankFilters { get; set; }

Property Value

Type
System.Boolean

AndButtonText

Gets or sets the text that needs to be applied for the And radio button.

Declaration

public string AndButtonText { get; set; }

Property Value

Type
System.String

AndRadioButton

Gets or sets the RadioButton for the And operator.

Declaration

public RadioButton AndRadioButton { get; set; }

Property Value

Type
System.Windows.Forms.RadioButton

BaseThemeName

Gets or sets the BaseThemeName of the control.

Declaration

protected string BaseThemeName { get; set; }

Property Value

Type
System.String

CanApplyTheme

Gets or sets a value indicating whether a theme style has been applied to the control.

Declaration

public bool CanApplyTheme { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

CancelButton

Gets or sets the Cancel Button to the filter control.

Declaration

public SfButton CancelButton { get; set; }

Property Value

Type
SfButton

CanOverrideStyle

Gets or sets a value indicating whether control elements styles can be overridden by theme style settings.

Declaration

public bool CanOverrideStyle { get; set; }

Property Value

Type	Description
System.Boolean	Default value is false.

Remarks

By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. This property should be enabled or disabled before calling the ThemeName property of the control.

CheckBoxFilterPanel

Gets or sets the CheckBox filter panel.

Declaration

public Panel CheckBoxFilterPanel { get; set; }

Property Value

Type
System.Windows.Forms.Panel

CheckedListBoxItems

Gets the overall items added to the checked list box.

Declaration

public List<object> CheckedListBoxItems { get; }

Property Value

Type
System.Collections.Generic.List<System.Object>

CheckListBox

Gets or sets the CheckedListBox that shows the list of items for filtering in CheckBoxFilterPanel.

Declaration

public SfListView CheckListBox { get; set; }

Property Value

Type
SfListView

ClearFilterButton

Gets or sets the clear filter sort button.

Declaration

public SortButton ClearFilterButton { get; set; }

Property Value

Type
SortButton

ControlName

Gets the name of the control.

Declaration

public string ControlName { get; }

Property Value

Type
System.String

DataSource

Gets or sets the data source for the FilterControl.

Declaration

public object DataSource { get; set; }

Property Value

Type
System.Object

DatePicker

Gets or sets the MonthCalendar to select the date for the filter value of the date filter.

Declaration

public SfCalendar DatePicker { get; set; }

Property Value

Type
SfCalendar

DoneButton

Gets or sets the Done button to the Filter drop down.

Declaration

public SfButton DoneButton { get; set; }

Property Value

Type
SfButton

EnableClearFilter

Gets or sets a value indicating whether the ClearFilter option is enabled or not.

Declaration

public bool EnableClearFilter { get; set; }

Property Value

Type
System.Boolean

EnableFirstCaseSensitive

Gets or sets a value indicating whether the first filter condition is cases sensitive or not.

Declaration

public bool EnableFirstCaseSensitive { get; set; }

Property Value

Type
System.Boolean

EnableSecondCaseSensitive

Gets or sets a value indicating whether the second filter condition is cases sensitive or not.

Declaration

public bool EnableSecondCaseSensitive { get; set; }

Property Value

Type
System.Boolean

FilterDescription

Gets or sets the filter descriptor text on the advanced filter. like "Show rows where:".

Declaration

public string FilterDescription { get; set; }

Property Value

Type
System.String

FilterDescriptionLabel

Gets or sets Label for specifying the filter description text in the Advanced filter.

Declaration

public Label FilterDescriptionLabel { get; set; }

Property Value

Type
System.Windows.Forms.Label

FilteredFrom

Gets or sets a value indicating whether the collection is filtered from the CheckBox filter or the advanced filter.

Declaration

public FilteredFrom FilteredFrom { get; set; }

Property Value

Type
FilteredFrom

FilterPanel

Gets or sets the filter panel of the filter control.

Declaration

public Panel FilterPanel { get; set; }

Property Value

Type
System.Windows.Forms.Panel

FilterPopupMode

Gets or sets the value that specifies whether the FilterControl needs to be show only the CheckBox filter or Advanced filter or the Both the filters on the same panel.

Declaration

public FilterPopupMode FilterPopupMode { get; set; }

Property Value

Type
FilterPopupMode

FilterTypeLabel

Gets or sets the label that used to display the filter type of the advanced filter.

Declaration

public Label FilterTypeLabel { get; set; }

Property Value

Type
System.Windows.Forms.Label

FirstCasingButton

Gets or sets the CheckBox for specifying whether the casing is needs to be enabled or not for the first filter condition.

Declaration

public CheckBox FirstCasingButton { get; set; }

Property Value

Type
System.Windows.Forms.CheckBox

FirstCondition

Gets the first filter condition for the advanced filter.

Declaration

public string FirstCondition { get; }

Property Value

Type
System.String

FirstConditionComboBox

Gets or sets the ComboBox for the first filter condition in the AdvancedFilterPanel.

Declaration

public SfComboBox FirstConditionComboBox { get; set; }

Property Value

Type
SfComboBox

FirstFilterValue

Gets the filter value for the first filter predicate in Advanced filter.

Declaration

public string FirstFilterValue { get; }

Property Value

Type
System.String

FirstValueComboBox

Gets or sets the ComboBox for the first filter value of the AdvancedFilterPanel.

Declaration

public SfComboBox FirstValueComboBox { get; set; }

Property Value

Type
SfComboBox

FirstValueTextBox

Gets or sets the TextBox for the first filter value in the AdvancedFilterPanel.

Declaration

public TextBoxExt FirstValueTextBox { get; set; }

Property Value

Type
TextBoxExt

ImmediateUpdateColumnFilter

Gets or sets a value indicating whether the immediate filter is enabled or not.

Declaration

public bool ImmediateUpdateColumnFilter { get; set; }

Property Value

Type
System.Boolean

InLoading

Gets or sets a value indicating whether the loading is in process for the checked list box items.

Declaration

public bool InLoading { get; set; }

Property Value

Type
System.Boolean

IsAdvancedFilterVisible

Gets or sets a value indicating whether the advanced filter is visible or not when the FilterMode is set to Both.

Declaration

public bool IsAdvancedFilterVisible { get; set; }

Property Value

Type
System.Boolean

IsVisualStyleEnabled

Gets a value indicating whether the visual style based theme is applied to the control and also indicates whether the theme files are referred from external assemblies or not.

Declaration

public bool IsVisualStyleEnabled { get; }

Property Value

Type	Description
System.Boolean	Return true, if the visual style based theme is applied to the control. Otherwise returns false.

NoItemsLabel

Gets or sets the label for display the no items text when the items count is zero.

Declaration

protected Label NoItemsLabel { get; set; }

Property Value

Type
System.Windows.Forms.Label

NoMatchLabel

Gets or sets the label to display the empty value in the checked list box.

Declaration

protected Label NoMatchLabel { get; set; }

Property Value

Type
System.Windows.Forms.Label

OkButton

Gets or sets the OK button to the Filter drop down.

Declaration

public SfButton OkButton { get; set; }

Property Value

Type
SfButton

OrButtonText

Gets or sets the text that needs to be applied for the 'Or' radio button.

Declaration

public string OrButtonText { get; set; }

Property Value

Type
System.String

OrRadioButton

Gets or sets the RadioButton for the Or operator.

Declaration

public RadioButton OrRadioButton { get; set; }

Property Value

Type
System.Windows.Forms.RadioButton

SearchClearButton

Gets or sets the search button added to the search text box.

Declaration

public SortButton SearchClearButton { get; set; }

Property Value

Type
SortButton

SearchedItems

Gets the list of filtered items based on the search text.

Declaration

public List<object> SearchedItems { get; }

Property Value

Type
System.Collections.Generic.List<System.Object>

SearchIconLabel

Gets or sets the search icon in the search text box of the CheckBox filter.

Declaration

public Label SearchIconLabel { get; set; }

Property Value

Type
System.Windows.Forms.Label

SearchTextBox

Gets or sets the TextBox that used to add the search text of the CheckBoxFilterPanel.

Declaration

public TextBoxExt SearchTextBox { get; set; }

Property Value

Type
TextBoxExt

SecondCasingButton

Gets or sets the CheckBox for specifying whether the casing is needs to be enabled or not for the second filter condition.

Declaration

public CheckBox SecondCasingButton { get; set; }

Property Value

Type
System.Windows.Forms.CheckBox

SecondCondition

Gets the second filter condition for the advanced filter.

Declaration

public string SecondCondition { get; }

Property Value

Type
System.String

SecondConditionComboBox

Gets or sets the ComboBox for the second filter condition in the AdvancedFilterPanel.

Declaration

public SfComboBox SecondConditionComboBox { get; set; }

Property Value

Type
SfComboBox

SecondFilterValue

Gets the filter value for the second filter predicate in Advanced filter.

Declaration

public string SecondFilterValue { get; }

Property Value

Type
System.String

SecondValueComboBox

Gets or sets the ComboBox for the second filter value of the AdvancedFilterPanel.

Declaration

public SfComboBox SecondValueComboBox { get; set; }

Property Value

Type
SfComboBox

SecondValueTextBox

Gets or sets the second filter value text box for the first filter condition..

Declaration

public TextBoxExt SecondValueTextBox { get; set; }

Property Value

Type
TextBoxExt

ShowClearFilter

Gets or sets a value indicating whether the clear filter is needs to be visible or not.

Declaration

public bool ShowClearFilter { get; set; }

Property Value

Type
System.Boolean

ShowSearch

Gets or sets a value indicating whether the search text box is needs to be visible or not.

Declaration

public bool ShowSearch { get; set; }

Property Value

Type
System.Boolean

ShowSortPanel

Gets or sets a value indicating whether the sorting options is needs to be visible or not.

Declaration

public bool ShowSortPanel { get; set; }

Property Value

Type
System.Boolean

SortAscending

Gets or sets a value indicating whether the sort ascending can be enabled.

Declaration

public bool SortAscending { get; set; }

Property Value

Type
System.Boolean

SortAscendingButton

Gets or sets the Ascending sort button.

Declaration

public SortButton SortAscendingButton { get; set; }

Property Value

Type
SortButton

SortDescending

Gets or sets a value indicating whether the sort descending can be enabled.

Declaration

public bool SortDescending { get; set; }

Property Value

Type
System.Boolean

SortDescendingButton

Gets or sets the Ascending sort button.

Declaration

public SortButton SortDescendingButton { get; set; }

Property Value

Type
SortButton

SortPanel

Gets or sets the sort panel of the filter control.

Declaration

public Panel SortPanel { get; set; }

Property Value

Type
System.Windows.Forms.Panel

Style

Gets or sets the style for the filter control.

Declaration

protected FilterControlVisualStyle Style { get; set; }

Property Value

Type
FilterControlVisualStyle

ThemeName

Gets or sets the theme name of the button control.

Declaration

public string ThemeName { get; set; }

Property Value

Type	Description
System.String	The default value is null.

Remarks

The theme will be applied only when the particular theme for this control has included the Themes assembly.

VisualTheme

Gets or sets the visualTheme of the control, which holds the ThemeName applied from SkinManager

Declaration

protected string VisualTheme { get; set; }

Property Value

Type
System.String

Methods

CheckListBox_ListViewItemChecked(Object, ItemCheckedEventArgs)

Occurs while checked list box item is checked.

Declaration

protected virtual void CheckListBox_ListViewItemChecked(object sender, ItemCheckedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
ItemCheckedEventArgs	e	An ItemCheckingEventArgs that contains event data.

CheckListBox_ListViewItemChecking(Object, ItemCheckingEventArgs)

Occurs while checked list box item is checked.

Declaration

protected virtual void CheckListBox_ListViewItemChecking(object sender, ItemCheckingEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
ItemCheckingEventArgs	e	An ItemCheckingEventArgs that contains event data.

Dispose(Boolean)

Clean up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true if managed resources should be disposed; otherwise, false.

GetActiveThemeName()

Gets the active theme name of the control.

Declaration

public string GetActiveThemeName()

Returns

Type	Description
System.String	Returns the active theme name.

GetBitmap(String)

Loads the bitmap from manifest.

Declaration

protected virtual Bitmap GetBitmap(string bitmapName)

Parameters

Type	Name	Description
System.String	bitmapName	The bitmap name.

Returns

Type	Description
System.Drawing.Bitmap	Reference to bitmap; NULL if bitmap failed to load.

InitializeFilterPopup()

Initialize the filter control.

Declaration

public virtual void InitializeFilterPopup()

OnAdvancedFilterButtonClicked(Object, EventArgs)

Occurs when clicking the advanced filter button for switching the view between CheckBox and the advanced filter options.

Declaration

protected virtual void OnAdvancedFilterButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	The System.EventArgs that contains event data.

OnCalenderDateSelected(SfCalendar, SelectionChangedEventArgs)

Set the combobox text based on the value.

Declaration

protected virtual void OnCalenderDateSelected(SfCalendar sender, SelectionChangedEventArgs e)

Parameters

Type	Name	Description
SfCalendar	sender	The SfCalender.
SelectionChangedEventArgs	e	Selection changed event args.

OnCancelButtonClicked(Object, EventArgs)

Occurs when the cancel button is clicked on the FilterControl.

Declaration

protected virtual void OnCancelButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	The System.EventArgs that contains event data.

OnClearFilterButtonClicked(Object, EventArgs)

Occurs when the clear filter button is clicked.

Declaration

protected virtual void OnClearFilterButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	An System.EventArgs that contains event data.

OnDoneButtonClicked(Object, EventArgs)

Occurs while clicking the "Done" button.

Declaration

protected virtual void OnDoneButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	An System.EventArgs that contains event data.

OnFilterPopupClosed(Object, ToolStripDropDownClosedEventArgs)

Occurs when the filter pop up is closed.

Declaration

protected virtual void OnFilterPopupClosed(object sender, ToolStripDropDownClosedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.Windows.Forms.ToolStripDropDownClosedEventArgs	e	An System.Windows.Forms.ToolStripDropDownClosedEventArgs that contains event data.

OnFilterPopupClosing(Object, ToolStripDropDownClosingEventArgs)

Occurs while closing the filter pop up.

Declaration

protected virtual void OnFilterPopupClosing(object sender, ToolStripDropDownClosingEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.Windows.Forms.ToolStripDropDownClosingEventArgs	e	An System.Windows.Forms.ToolStripDropDownClosingEventArgs that contains event data.

Remarks

This is used to restrict the closing of filter pop up while selecting the drop down values outside the filter pop up.

OnFilterPopupOpening(Object, CancelEventArgs)

Occurs when the filter pop up is showing.

Declaration

protected virtual void OnFilterPopupOpening(object sender, CancelEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.ComponentModel.CancelEventArgs	e	The System.ComponentModel.CancelEventArgs that contains event data.

OnFirstCasingButtonClicked(Object, EventArgs)

Occurs when the casing button is clicked for the first filter condition.

Declaration

protected virtual void OnFirstCasingButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	The System.EventArgs that contains event data.

OnOKButtonClicked(Object, EventArgs)

Occurs when the OK button is clicked on the FilterControl.

Declaration

protected virtual void OnOKButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	The System.EventArgs that contains event data.

OnSearchClearButtonClicked(Object, EventArgs)

Occurs when the SearchTextBox label is clicked on the CheckBoxFilterPanel.

Declaration

protected virtual void OnSearchClearButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	The System.EventArgs that contains event data.

OnSearchTextBoxTextChanged(Object, EventArgs)

Occurs when the search text box text is changed.

Declaration

protected virtual void OnSearchTextBoxTextChanged(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The search text box of the check box filter panel.
System.EventArgs	e	The System.EvenArgs that contains event data.

OnSecondCasingButtonClicked(Object, EventArgs)

Occurs when the casing button is clicked for the second filter condition.

Declaration

protected virtual void OnSecondCasingButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	The System.EventArgs that contains event data.

OnSortAscendingButtonClicked(Object, EventArgs)

Occurs while clicking the SortAscending button.

Declaration

protected virtual void OnSortAscendingButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	The System.EventArgs that contains event data.

OnSortDescendingButtonClicked(Object, EventArgs)

Occurs while clicking the SortDescending button.

Declaration

protected virtual void OnSortDescendingButtonClicked(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The object of the sender.
System.EventArgs	e	The System.EventArgs that contains event data.

ProcessCmdKey(ref Message, Keys)

Overridden to update the key down event.

Declaration

protected override bool ProcessCmdKey(ref Message msg, Keys keyData)

Parameters

Type	Name	Description
System.Windows.Forms.Message	msg	The System.Windows.Forms.Message for the key.
System.Windows.Forms.Keys	keyData	The System.Windows.Forms.Keys of the key.

Returns

Type	Description
System.Boolean	Returns true if the control processed the key otherwise return false.

ProcessTabKey(Boolean)

Overridden to process the TabKeyDown on the filter control base.

Declaration

protected override bool ProcessTabKey(bool forward)

Parameters

Type	Name	Description
System.Boolean	forward	Specifies whether the tab is need to move forward or not.

Returns

Type	Description
System.Boolean	Returns true if the control handles the key down, otherwise return false.

ResetDataSource()

Reset the data source for the checked list box.

Declaration

protected virtual void ResetDataSource()

SetAdvancedFilter(Control, Point, Size)

Sets the advanced filter options to the given control.

Declaration

protected virtual void SetAdvancedFilter(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The panel that needs to added with the advanced filter options.
System.Drawing.Point	location	the location of the control on the Filter panel.
System.Drawing.Size	size	The size of the advanced filter panel.

SetAdvancedFilterButton(Control, Point, Size)

Sets the AdvancedFilterButton on the AdvancedFilterPanel for switching the filter views.

Declaration

protected virtual void SetAdvancedFilterButton(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control that needs to be added to the advanced filter button.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetAndFilterOperator(Control, Point, String)

Sets the radio button that shows whether the second filter condition is needs to be added with the And operator or not.

Declaration

protected virtual void SetAndFilterOperator(Control control, Point location, string text)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The RadioButton.
System.Drawing.Point	location	The location of the radio button on the advanced filter panel.
System.String	text	The text that needs to be showed for the radio button.

SetAscendingSortButton(Control, Point, Size)

Sets the ascending sort button to the sort panel.

Declaration

protected virtual void SetAscendingSortButton(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The button that needs to be added.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetCancelButton(Control, Point, Size)

Sets the Cancel button for the filter drop down.

Declaration

protected virtual void SetCancelButton(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control that needs to be added.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetCheckBoxFilter(Control, Point, Size)

Arranges the check box filter items to the Filter panel.

Declaration

protected virtual void SetCheckBoxFilter(Control checkBoxFilterPanel, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	checkBoxFilterPanel	The panel that needs to show the filter options for the check box filter.
System.Drawing.Point	location	The location of the check box filter panel on the FilterPanel.
System.Drawing.Size	size	The size of the check box filter panel.

SetCheckedListBox(Control, Point, Size)

Sets the checked list box control for the CheckBoxFilter.

Declaration

protected virtual void SetCheckedListBox(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The System.Windows.Forms.CheckedListBox control.
System.Drawing.Point	location	The location of the checked list box.
System.Drawing.Size	size	The size of the checked list box.

SetClearFilterButton(Control, Point, Size)

Sets the clear filter button for the Sort panel.

Declaration

protected virtual void SetClearFilterButton(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The object of the sender.
System.Drawing.Point	location	The location of the clear filter button.
System.Drawing.Size	size	the size of the control.

SetDataSource(Object)

Sets the data source for the checked list box of the FilterControl.

Declaration

protected virtual void SetDataSource(object source)

Parameters

Type	Name	Description
System.Object	source	The System.Collections.Generic.IEnumerable source that needs to be assigned to the checked list box.

SetDefaultFilter(Point, Size)

Sets the both advanced and CheckBox filter options in the FilterControl.

Declaration

protected virtual void SetDefaultFilter(Point location, Size size)

Parameters

Type	Name	Description
System.Drawing.Point	location	The location of the Filer panel.
System.Drawing.Size	size	The size of the filer panel.

SetDesendingSortButton(Control, Point, Size)

Sets the descending sort button to the sort panel.

Declaration

protected virtual void SetDesendingSortButton(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The button that needs to be added.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetDoneButton(Control, Point, Size)

Sets the Done button for the Immediate column filter.

Declaration

protected virtual void SetDoneButton(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control that needs to be added.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetFilterDescription(Control, Point, String)

Sets the label that used to display the filter description of the advanced filter.

Declaration

protected virtual void SetFilterDescription(Control control, Point location, string text)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The label.
System.Drawing.Point	location	The location of the control.
System.String	text	The text that needs to be displayed on the filter description label.

SetFilterLabel(Control, Point, String)

Sets the filter label for displaying the advanced filter type.

Declaration

protected virtual void SetFilterLabel(Control control, Point location, string text)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The label that needs to be displayed.
System.Drawing.Point	location	The location of the control.
System.String	text	The text that needs to be displayed in the label.

SetFilterPanel(Control, Point, Size)

Sets the controls added to the filter panel based on the FilterMode property.

Declaration

protected virtual void SetFilterPanel(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The filter panel of the control.
System.Drawing.Point	location	The location of the filter panel.
System.Drawing.Size	size	The size of the filter panel.

SetFirstCasingButton(Control, Point, Size)

Sets the casing button for enable the case sensitive filtering for the second filter condition of the advanced filter.

Declaration

protected virtual void SetFirstCasingButton(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control that needs to be added as the casing button.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetFirstFilterCondition(Control, Point, Size)

Sets the ComboBox for selecting second filter condition for the advanced filter.

Declaration

protected virtual void SetFirstFilterCondition(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The ComboBox control that needs to be added for displaying the first filter condition.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetFirstFilterValueComboBox(Control, Point, Size)

Sets the control for showing the first filter value in the Advanced filter.

Declaration

protected virtual void SetFirstFilterValueComboBox(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The object of the sender.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetFirstFilterValueTextBox(Control, Point, Size)

Sets the control for showing the first filter value in the Advanced filter.

Declaration

protected virtual void SetFirstFilterValueTextBox(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The object of the sender.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetNoItemsLabel(Control, Point)

Sets the No Items label to display the filter popup with empty data source.

Declaration

protected virtual void SetNoItemsLabel(Control control, Point location)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The label control.
System.Drawing.Point	location	The location of the checked list box.

SetNoMatchLabel(Control, Point)

Sets the No match label to display the empty values in the CheckedListBox while searching through the text box.

Declaration

protected virtual void SetNoMatchLabel(Control control, Point location)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The label control.
System.Drawing.Point	location	The location of the checked list box.

SetOKButton(Control, Point, Size)

Sets the OK button for the filter drop down.

Declaration

protected virtual void SetOKButton(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control that needs to be added.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetOrFilterOperator(Control, Point, String)

Sets the Or filter operator for the advanced filter control.

Declaration

protected virtual void SetOrFilterOperator(Control control, Point location, string text)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The RadioButton.
System.Drawing.Point	location	The location of the control.
System.String	text	The text that needs to be shown for the 'Or' Radio button.

SetSearchTextBox(Control, Point, Size)

Sets the search text box for the CheckBox filter panel.

Declaration

protected virtual void SetSearchTextBox(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The text box control.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetSecondCasingButton(Control, Point, Size)

Sets the casing button for enable the case sensitive filtering for the second filter condition of the advanced filter.

Declaration

protected virtual void SetSecondCasingButton(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control that needs to be added as the casing button.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetSecondFilterCondition(Control, Point, Size)

Sets the ComboBox for selecting first filter condition for the advanced filter.

Declaration

protected virtual void SetSecondFilterCondition(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The ComboBox control that needs to be added for displaying the first filter condition.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetSecondFilterValueComboBox(Control, Point, Size)

Sets the control for showing the second filter value in the Advanced filter.

Declaration

protected virtual void SetSecondFilterValueComboBox(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The object of the sender.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetSecondFilterValueTextBox(Control, Point, Size)

Sets the control for showing the second filter value in the Advanced filter.

Declaration

protected virtual void SetSecondFilterValueTextBox(Control control, Point location, Size size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The object of the sender.
System.Drawing.Point	location	The location of the control.
System.Drawing.Size	size	The size of the control.

SetSeparator(Control, Point)

Sets the separator between the controls.

Declaration

protected virtual void SetSeparator(Control parentControl, Point point)

Parameters

Type	Name	Description
System.Windows.Forms.Control	parentControl	The control that needs to add the separator.
System.Drawing.Point	point	The location of the separator.

SetSortPanel(Control, Point)

Sets the SortPanel items on the filter control.

Declaration

protected virtual void SetSortPanel(Control control, Point location)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control that needs to be loaded with the sort options at the top of the FilterControl."/>
System.Drawing.Point	location	The location of the control.

Show(Control, Point)

Display the FilterPopupBase for the given control at the specified location.

Declaration

public virtual void Show(Control control, Point location)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control that needs to be display the filter drop down.
System.Drawing.Point	location	The location of the filter drop down.

WndProc(ref Message)

Overridden to provide the resizing option for the control.

Declaration

protected override void WndProc(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m	The window message.

Events

ThemeChanged

Occurs when theme name of the FilterControlBase has changed.

Declaration

public event ThemeChangedEventHandler ThemeChanged

Event Type

Type
ThemeChangedEventHandler

ThemeNameChanged

Occurs when theme name of the FilterControlBase has changed.

Declaration

public event ThemeChangedEventHandler ThemeNameChanged

Event Type

Type
ThemeChangedEventHandler

Explicit Interface Implementations

IVisualStyle.VisualTheme

Gets or sets the VisualTheme of the SfNumericTextBox control.

Declaration

string IVisualStyle.VisualTheme { get; set; }

Returns

Type
System.String

IThemeProvider.BaseThemeName

Gets or sets the BaseTheme name of the theme

Declaration

string IThemeProvider.BaseThemeName { get; set; }

Returns

Type
System.String

Implements

IThemeProvider

IVisualStyle