ClassGridFilterCellElement
Represents a filter cell in RadGridView
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class GridFilterCellElement : GridDataCellElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IContextMenuProvider, IVirtualizedElement<GridViewColumn>, IEditableCell, IDataConversionInfoProvider, ITypeDescriptorContext, IServiceProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementGridVisualElementConditionalFormattableGridVisualElementGridCellElementGridVirtualizedCellElementGridDataCellElementGridFilterCellElement
Derived Classes:
Implements:
Inherited Members
Constructors
GridFilterCellElement(GridViewDataColumn, GridRowElement)
Initializes a new instance of the GridFilterCellElement class.
Declaration
public GridFilterCellElement(GridViewDataColumn column, GridRowElement row)
Parameters
column
row
Fields
ElementSpacingProperty
Declaration
public static RadProperty ElementSpacingProperty
Field Value
IsFilterAppliedProperty
Declaration
public static RadProperty IsFilterAppliedProperty
Field Value
Properties
AutoFilterDelay
Gets the value in Milliseconds indicating delay between last key press and filtering operation."
Descriptor
Gets or sets the filter descriptor associated with this cell
Declaration
protected FilterDescriptor Descriptor { get; }
Property Value
The filter descriptor.
ElementSpacing
Gets or sets the spacing between elements in filter cell
FilterButton
Gets the filter button for the cell.
Declaration
public RadButtonElement FilterButton { get; }
Property Value
FilterOperatorText
Gets the filter operator for the cell.
Declaration
public TextPrimitive FilterOperatorText { get; }
Property Value
FilteringRowInfo
Gets the filtering row info.
Declaration
protected GridViewFilteringRowInfo FilteringRowInfo { get; }
Property Value
The filtering row info.
IsEditable
Gets a value indicating whether this instance is editable.
Declaration
public override bool IsEditable { get; }
Property Value
true if this instance is editable; otherwise, false.
Overrides
IsFilterApplied
Gets whether a filter is applied.
Declaration
public bool IsFilterApplied { get; }
Property Value
The is filter applied.
SupportsConditionalFormatting
Gets a value indicating whether [supports conditional formatting].
Declaration
public override bool SupportsConditionalFormatting { get; }
Property Value
true if [supports conditional formatting]; otherwise, false.
Overrides
Methods
AddEditor(IInputEditor)
Adds the editor.
Declaration
public override void AddEditor(IInputEditor editor)
Parameters
editor
The editor.
Overrides
ArrangeEditorElement(RadElement, RectangleF, RectangleF)
Arranges the editor element.
Declaration
protected virtual void ArrangeEditorElement(RadElement element, RectangleF editorRect, RectangleF clientRect)
Parameters
element
The element.
editorRect
The editor rect.
clientRect
The client rect.
ArrangeOverride(SizeF)
Arranges the elements in the available size.
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
An instance of CompositeFilterForm.
CreateFilterMenu(Type)
Creates the filter menu.
Declaration
protected virtual RadDropDownMenu CreateFilterMenu(Type dataType)
Parameters
dataType
Type of the data.
Returns
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
data
The column.
context
The context.
Returns
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
availableSize
The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
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
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
e
An instance of RadPropertyChangedEventArgs
Overrides
RemoveEditor(IInputEditor)
Removes the editor.
Declaration
public override void RemoveEditor(IInputEditor editor)
Parameters
editor
The editor.
Overrides
RemoveFilterDescriptor()
Removes the filter descriptor.
Declaration
protected virtual bool RemoveFilterDescriptor()
Returns
[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
value
Overrides
SetFilterDescriptor(FilterDescriptor)
Sets the filter descriptor.
Declaration
protected virtual bool SetFilterDescriptor(FilterDescriptor descriptor)
Parameters
descriptor
The descriptor.
Returns
SetFilterOperator(FilterOperator)
Sets the filter operator.
Declaration
protected virtual bool SetFilterOperator(FilterOperator filterOperator)
Parameters
filterOperator
The filter operator.
Returns
SetSelectedFilterOperatorText()
Sets the selected filter operator text.
Declaration
protected virtual void SetSelectedFilterOperatorText()
UpdateFilterButtonVisibility(bool)
Updates the filter button visibility.
Declaration
protected virtual void UpdateFilterButtonVisibility(bool enabled)
Parameters
enabled
if set to true [enabled].
UpdateInfoCore()
Updates the visual state of the cell.
Declaration
protected override void UpdateInfoCore()
Overrides
UpdateItemsVisibility(bool)
Updates filter cell items visibility.
Declaration
protected virtual void UpdateItemsVisibility(bool enabled)
Parameters
enabled
if set to true [enabled].
ValidateUserFilter(FilterDescriptor)
Validates a descriptor set by the user.
Declaration
public static bool ValidateUserFilter(FilterDescriptor descriptor)
Parameters
descriptor
the descriptor to validate.
Returns
true if successful.