Class GridFilterCellElement

Represents a filter cell in RadGridView

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
GridVisualElement
ConditionalFormattableGridVisualElement
GridCellElement
GridVirtualizedCellElement
GridDataCellElement
GridFilterCellElement
GridFilterCheckBoxCellElement
GridFilterComboBoxCellElement
GridFilterTimeSpanCellElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class GridFilterCellElement : GridDataCellElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider, IContextMenuProvider, IVirtualizedElement<GridViewColumn>, IEditableCell, IDataConversionInfoProvider, ITypeDescriptorContext, IServiceProvider

Constructors

GridFilterCellElement(GridViewDataColumn, GridRowElement)

Initializes a new instance of the GridFilterCellElement class.

Declaration
public GridFilterCellElement(GridViewDataColumn column, GridRowElement row)
Parameters
GridViewDataColumn column

GridRowElement row

Fields

ElementSpacingProperty

Declaration
public static RadProperty ElementSpacingProperty
Field Value
RadProperty

IsFilterAppliedProperty

Declaration
public static RadProperty IsFilterAppliedProperty
Field Value
RadProperty

Properties

AutoFilterDelay

Gets the value in Milliseconds indicating delay between last key press and filtering operation."

Declaration
protected virtual int AutoFilterDelay { get; }
Property Value
System.Int32

Descriptor

Gets or sets the filter descriptor associated with this cell

Declaration
protected FilterDescriptor Descriptor { get; }
Property Value
FilterDescriptor

The filter descriptor.

ElementSpacing

Gets or sets the spacing between elements in filter cell

Declaration
public int ElementSpacing { get; set; }
Property Value
System.Int32

FilterButton

Gets the filter button for the cell.

Declaration
public RadButtonElement FilterButton { get; }
Property Value
RadButtonElement

FilteringRowInfo

Gets the filtering row info.

Declaration
protected GridViewFilteringRowInfo FilteringRowInfo { get; }
Property Value
GridViewFilteringRowInfo

The filtering row info.

FilterOperatorText

Gets the filter operator for the cell.

Declaration
public TextPrimitive FilterOperatorText { get; }
Property Value
TextPrimitive

IsEditable

Gets a value indicating whether this instance is editable.

Declaration
public override bool IsEditable { get; }
Property Value
System.Boolean

true if this instance is editable; otherwise, false.
Overrides

IsFilterApplied

Gets whether a filter is applied.

Declaration
public bool IsFilterApplied { get; }
Property Value
System.Boolean

The is filter applied.

SupportsConditionalFormatting

Gets a value indicating whether [supports conditional formatting].

Declaration
public override bool SupportsConditionalFormatting { get; }
Property Value
System.Boolean

true if [supports conditional formatting]; otherwise, false.
Overrides

Value

Get or set the filter cell value

Declaration
public override object Value { get; set; }
Property Value
System.Object

Overrides

Methods

AddEditor(IInputEditor)

Adds the editor.

Declaration
public override void AddEditor(IInputEditor editor)
Parameters
IInputEditor editor

The editor.
Overrides

ArrangeEditorElement(RadElement, RectangleF, RectangleF)

Arranges the editor element.

Declaration
protected virtual void ArrangeEditorElement(RadElement element, RectangleF editorRect, RectangleF clientRect)
Parameters
RadElement element

The element.
System.Drawing.RectangleF editorRect

The editor rect.
System.Drawing.RectangleF clientRect

The client rect.

ArrangeOverride(SizeF)

Arranges the elements in the available size.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final size.
Returns
System.Drawing.SizeF

Overrides

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration
protected override void CreateChildElements()
Overrides

CreateCompositeFilterForm()

Creates the composite filter form

Declaration
protected virtual BaseCompositeFilterDialog CreateCompositeFilterForm()
Returns
BaseCompositeFilterDialog

An instance of CompositeFilterForm.

CreateFilterMenu(Type)

Creates the filter menu.

Declaration
protected virtual RadDropDownMenu CreateFilterMenu(Type dataType)
Parameters
System.Type dataType

Type of the data.
Returns
RadDropDownMenu

InitializeFields()

Initializes member fields to their default values. This method is called prior the CreateChildItems one and allows for initialization of members on which child elements depend.

Declaration
protected override void InitializeFields()
Overrides

IsCompatible(GridViewColumn, Object)

Determines whether the specified cell is compatible with concrete column.

Declaration
public override bool IsCompatible(GridViewColumn data, object context)
Parameters
GridViewColumn data

The column.
System.Object context

The context.
Returns
System.Boolean

true if the specified column is compatible; otherwise, false.
Overrides

MeasureOverride(SizeF)

Measures the space required by the RadElement Used by the layout system.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
System.Drawing.SizeF

The minimum size required by the element to be completely visible. Cannot be infinity.
Overrides
Remarks

In this method call to the Measure method of each child must be made.

OnCellFormatting(CellFormattingEventArgs)

Raises the CellFormatting event.

Declaration
protected override void OnCellFormatting(CellFormattingEventArgs e)
Parameters
CellFormattingEventArgs e

The CellFormattingEventArgs instance containing the event data.
Overrides

OnColumnPropertyChanged(RadPropertyChangedEventArgs)

Occurs when some column property changes its value.

Declaration
protected override void OnColumnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

An instance of RadPropertyChangedEventArgs
Overrides

RemoveEditor(IInputEditor)

Removes the editor.

Declaration
public override void RemoveEditor(IInputEditor editor)
Parameters
IInputEditor editor

The editor.
Overrides

RemoveFilterDescriptor()

Removes the filter descriptor.

Declaration
protected virtual bool RemoveFilterDescriptor()
Returns
System.Boolean

[TRUE] if succeed, otherwise [FALSE]

SetContent()

Sets the value of the cell.

Declaration
public override void SetContent()
Overrides

SetContentCore(Object)

Sets the actual text of the cell.

Declaration
protected override void SetContentCore(object value)
Parameters
System.Object value

Overrides

SetFilterDescriptor(FilterDescriptor)

Sets the filter descriptor.

Declaration
protected virtual bool SetFilterDescriptor(FilterDescriptor descriptor)
Parameters
FilterDescriptor descriptor

The descriptor.
Returns
System.Boolean

SetFilterOperator(FilterOperator)

Sets the filter operator.

Declaration
protected virtual bool SetFilterOperator(FilterOperator filterOperator)
Parameters
FilterOperator filterOperator

The filter operator.
Returns
System.Boolean

SetSelectedFilterOperatorText()

Sets the selected filter operator text.

Declaration
protected virtual void SetSelectedFilterOperatorText()

UpdateFilterButtonVisibility(Boolean)

Updates the filter button visibility.

Declaration
protected virtual void UpdateFilterButtonVisibility(bool enabled)
Parameters
System.Boolean enabled

if set to true [enabled].

UpdateInfoCore()

Updates the visual state of the cell.

Declaration
protected override void UpdateInfoCore()
Overrides

UpdateItemsVisibility(Boolean)

Updates filter cell items visibility.

Declaration
protected virtual void UpdateItemsVisibility(bool enabled)
Parameters
System.Boolean enabled

if set to true [enabled].

ValidateUserFilter(FilterDescriptor)

Validates a descriptor set by the user.

Declaration
public static bool ValidateUserFilter(FilterDescriptor descriptor)
Parameters
FilterDescriptor descriptor

the descriptor to validate.
Returns
System.Boolean

true if successful.

Extension Methods