Documentation

Class CompositeFilterForm

Displays a form used to create custom filters.

Inheritance
System.Object
RadFormControlBase
RadForm
BaseCompositeFilterDialog
CompositeFilterForm
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class CompositeFilterForm : BaseCompositeFilterDialog, IComponentTreeHandler, ILayoutHandler, ISupportInitializeNotification, ISupportInitialize, INotifyPropertyChanged, IAnalyticsProvider

Constructors

CompositeFilterForm()

Initializes a new instance of the CompositeFilterForm class.

Declaration
public CompositeFilterForm()

CompositeFilterForm(GridViewDataColumn)

Initializes a new instance of the CompositeFilterForm class.

Declaration
public CompositeFilterForm(GridViewDataColumn dataColumn)
Parameters
GridViewDataColumn dataColumn

The data column.

CompositeFilterForm(GridViewDataColumn, FilterDescriptor)

Initializes a new instance of the CompositeFilterForm class.

Declaration
public CompositeFilterForm(GridViewDataColumn dataColumn, FilterDescriptor filterDescriptor)
Parameters
GridViewDataColumn dataColumn

The GridViewDataColumn, owner of this form.
FilterDescriptor filterDescriptor

CompositeFilterForm(GridViewDataColumn, FilterDescriptor, Boolean)

Initializes a new instance of the CompositeFilterForm class.

Declaration
public CompositeFilterForm(GridViewDataColumn dataColumn, FilterDescriptor filterDescriptor, bool useTypedEditors)
Parameters
GridViewDataColumn dataColumn

The data column.
FilterDescriptor filterDescriptor

The filter descriptor.
System.Boolean useTypedEditors

The use typed editors.

CompositeFilterForm(GridViewDataColumn, FilterDescriptor, Boolean, String)

Initializes a new instance of the CompositeFilterForm class.

Declaration
public CompositeFilterForm(GridViewDataColumn dataColumn, FilterDescriptor filterDescriptor, bool useTypedEditors, string themeName)
Parameters
GridViewDataColumn dataColumn

The data column.
FilterDescriptor filterDescriptor

The filter descriptor.
System.Boolean useTypedEditors

The use typed editors.
System.String themeName

Name of the theme.

Properties

ComboBoxLeftOperator

Gets the combo box of left operator.

Declaration
public RadDropDownList ComboBoxLeftOperator { get; }
Property Value
RadDropDownList

The combo box left operator.

ComboBoxRightOperator

Gets the combo box of right operator.

Declaration
public RadDropDownList ComboBoxRightOperator { get; }
Property Value
RadDropDownList

The combo box right operator.

DataType

Gets the column's data type

Declaration
public Type DataType { get; set; }
Property Value
System.Type

The type of the column's data type.

FilterDescriptor

Gets or sets the filter descriptor.

Declaration
public override FilterDescriptor FilterDescriptor { get; }
Property Value
FilterDescriptor

The filter descriptor.
Overrides

LeftDescriptor

Gets or sets the left descriptor.

Declaration
public FilterDescriptor LeftDescriptor { get; }
Property Value
FilterDescriptor

The left descriptor.

LeftEditor

Gets the left operator editor.

Declaration
public RadControl LeftEditor { get; }
Property Value
RadControl

LogicalOperator

Gets or sets the logical operator

Declaration
public FilterLogicalOperator LogicalOperator { get; }
Property Value
FilterLogicalOperator

The logical operator.

RightDescriptor

Gets or sets the right descriptor.

Declaration
public FilterDescriptor RightDescriptor { get; }
Property Value
FilterDescriptor

The right descriptor.

RightEditor

Gets the right operator editor.

Declaration
public RadControl RightEditor { get; }
Property Value
RadControl

Methods

CreateEditors(GridViewColumn)

Creates the editors.

Declaration
protected virtual void CreateEditors(GridViewColumn column)
Parameters
GridViewColumn column

The column.

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true if managed resources should be disposed; otherwise, false.
Overrides

GetValueFromEditor(RadControl, ref Exception)

Gets the selected value form editor.

Declaration
protected virtual object GetValueFromEditor(RadControl editorControl, ref Exception parseException)
Parameters
RadControl editorControl

RadControl editor
System.Exception parseException

return exception if parse is not successful
Returns
System.Object

Value from the editor

Initialize(GridViewDataColumn, FilterDescriptor, Boolean)

Initializes the editors in the dialog with the filter descriptor that is correctly applied to the RadGridView data.

Declaration
public override void Initialize(GridViewDataColumn dataColumn, FilterDescriptor filterDescriptor, bool useTypedEditors)
Parameters
GridViewDataColumn dataColumn

The column which represents the property by which data will be filtered
FilterDescriptor filterDescriptor

The filter descriptor that is currently applied to the grid for this column.
System.Boolean useTypedEditors

Determines whether type specific editors should be used e.g. RadSpinEditor for numeric properties.
Overrides

IsEditableFilterOperator(FilterOperator)

Determines whether the specified filter operator is editale.

Declaration
protected bool IsEditableFilterOperator(FilterOperator filterOperator)
Parameters
FilterOperator filterOperator

The filter operator.
Returns
System.Boolean

OnClosing(CancelEventArgs)

Raises the System.Windows.Forms.Form.Closing event.

Declaration
protected override void OnClosing(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

A System.ComponentModel.CancelEventArgs that contains the event data.

OnLoad(EventArgs)

Raises the Load event.

Declaration
protected override void OnLoad(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Overrides

Extension Methods