WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridDataFilterBarCellRenderer - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridDataFilterBarCellRenderer

    Inheritance
    System.Object
    NonFinalizeDisposable
    Disposable
    CellRendererBase<GridRenderStyleInfo>
    GridCellRendererBase
    GridVirtualizingCellRendererBase<System.Windows.Controls.TextBox>
    GridVirtualizingCellRenderer<System.Windows.Controls.TextBox>
    GridDataFilterBarCellRenderer
    Implements
    IGridCellRenderer
    ICellRenderer
    IHitTestSelectCells
    IStyleChanged
    System.IDisposable
    IAllowKeepAliveOnlyCurrentCell
    Inherited Members
    GridVirtualizingCellRenderer<TextBox>.OnCancelMouseCapture(UIElement)
    GridVirtualizingCellRenderer<TextBox>.OnRecaptureMouse(UIElement)
    GridVirtualizingCellRenderer<TextBox>.GetControlValueFromEditor()
    GridVirtualizingCellRenderer<TextBox>.GetControlValueFromEditorCore(TextBox)
    GridVirtualizingCellRenderer<TextBox>.GetControlTextFromEditor()
    GridVirtualizingCellRenderer<TextBox>.EnsureCurrentCellUIElement()
    GridVirtualizingCellRenderer<TextBox>.CreateRendererElement(TextBox, GridRenderStyleInfo)
    GridVirtualizingCellRenderer<TextBox>.RaiseGridPreviewMouseMove(RowColumnIndex, MouseEventArgs)
    GridVirtualizingCellRenderer<TextBox>.RollbackTextChange(TextBoxBase)
    GridVirtualizingCellRenderer<TextBox>.EmptyRecycleBin()
    GridVirtualizingCellRenderer<TextBox>.AllowKeepAliveOnlyCurrentCell
    GridVirtualizingCellRenderer<TextBox>.CurrentCellUIElement
    GridVirtualizingCellRendererBase<TextBox>.OnArrange(ArrangeCellArgs, GridRenderStyleInfo)
    GridVirtualizingCellRendererBase<TextBox>.InitializeDefaultProperties(TextBox)
    GridVirtualizingCellRendererBase<TextBox>.GetBounds(UIElement)
    GridVirtualizingCellRendererBase<TextBox>.SetBounds(UIElement, Rect)
    GridVirtualizingCellRendererBase<TextBox>.SetBounds(UIElement, Rect, Boolean, Boolean)
    GridVirtualizingCellRendererBase<TextBox>.InvalidateMeasureRecursive(UIElement)
    GridVirtualizingCellRendererBase<TextBox>.OnElementArranged(UIElement, Rect)
    GridVirtualizingCellRendererBase<TextBox>.OnElementMeasured(UIElement, Size)
    GridVirtualizingCellRendererBase<TextBox>.GetUIElement(CellUIElements)
    GridVirtualizingCellRendererBase<TextBox>.InitializeContent(TextBox, GridRenderStyleInfo)
    GridVirtualizingCellRendererBase<TextBox>.OnPrepareUIElements(ArrangeCellArgs, List<UIElement>, ScrollControlChildFrame, GridRenderStyleInfo)
    GridVirtualizingCellRendererBase<TextBox>.CreateUIElement(ArrangeCellArgs, GridRenderStyleInfo)
    GridVirtualizingCellRendererBase<TextBox>.OnUnloadUIElements(VirtualizingCellsControl, RowColumnIndex, CellUIElements)
    GridVirtualizingCellRendererBase<TextBox>.Dispose(Boolean)
    GridVirtualizingCellRendererBase<TextBox>.AllowRecycle
    GridVirtualizingCellRendererBase<TextBox>.AllowTransparentBackground
    GridVirtualizingCellRendererBase<TextBox>.InInitializeContent
    GridVirtualizingCellRendererBase<TextBox>.AllowRecycleIfIsKeyboardFocusWithin
    GridCellRendererBase.RaiseCreated(GridCellModelBase)
    GridCellRendererBase.OnCreated()
    GridCellRendererBase.SetCurrentCellState(GridControlBase, RowColumnIndex, GridActivateCurrentCellOptions)
    GridCellRendererBase.IsCurrentCell(GridControlBase, RowColumnIndex)
    GridCellRendererBase.IsCurrentCell(GridRenderStyleInfo)
    GridCellRendererBase.IsCurrentCell(UIElement)
    GridCellRendererBase.ResetCurrentCellState()
    GridCellRendererBase.OnResetFocus()
    GridCellRendererBase.SetControlText(String)
    GridCellRendererBase.SetControlText(String, Boolean)
    GridCellRendererBase.ValidateControlText(String)
    GridCellRendererBase.ResetControlText()
    GridCellRendererBase.ApplyControlText(GridRenderStyleInfo, String)
    GridCellRendererBase.GetControlText(GridRenderStyleInfo)
    GridCellRendererBase.GetControlTextCore(GridRenderStyleInfo, Object)
    GridCellRendererBase.ShouldCurrentCellShowCellText()
    GridCellRendererBase.SetControlValue(Object)
    GridCellRendererBase.ValidateControlValue(Object)
    GridCellRendererBase.ResetControlValue()
    GridCellRendererBase.GetControlValue(GridRenderStyleInfo)
    GridCellRendererBase.RaiseInitialize(GridActivateCurrentCellOptions)
    GridCellRendererBase.ScrollInView()
    GridCellRendererBase.RaiseActivating(GridControlBase, RowColumnIndex, GridActivateCurrentCellOptions)
    GridCellRendererBase.OnActivating()
    GridCellRendererBase.RaiseActivated()
    GridCellRendererBase.RaiseActivateFailed()
    GridCellRendererBase.OnActivateFailed()
    GridCellRendererBase.RaiseDeactivating()
    GridCellRendererBase.RaiseDeactivated()
    GridCellRendererBase.RaiseDeactivateFailed()
    GridCellRendererBase.OnDeactivateFailed()
    GridCellRendererBase.RaiseValidate()
    GridCellRendererBase.OnValidate()
    GridCellRendererBase.RaiseClipboardPaste(GridCutPasteEventArgs)
    GridCellRendererBase.OnClipboardPaste(GridCutPasteEventArgs)
    GridCellRendererBase.RaiseClipboardPasted(GridCutPasteEventArgs)
    GridCellRendererBase.OnClipboardPasted(GridCutPasteEventArgs)
    GridCellRendererBase.RaiseValidated()
    GridCellRendererBase.OnValidated()
    GridCellRendererBase.RaiseSaveChanges()
    GridCellRendererBase.OnSaveChanges()
    GridCellRendererBase.RaiseRejectChanges()
    GridCellRendererBase.OnRejectChanges()
    GridCellRendererBase.NotifyCurrentCellChanging()
    GridCellRendererBase.NotifyCurrentCellChanged()
    GridCellRendererBase.MoveCurrentHelper(FrameworkElement, MouseControllerEventArgs)
    GridCellRendererBase.IGridCellRenderer.ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs)
    GridCellRendererBase.IGridCellRenderer.RenderForPrinting(DrawingContext, RenderCellArgs, GridRenderStyleInfo)
    GridCellRendererBase.OnRenderForPrinting(DrawingContext, RenderCellArgs, GridRenderStyleInfo)
    GridCellRendererBase.IGridCellRenderer.RaiseGridPreviewTextInput(TextCompositionEventArgs)
    GridCellRendererBase.IGridCellRenderer.RaiseConfirmChangesFailed()
    GridCellRendererBase.OnConfirmChangesFailed()
    GridCellRendererBase.RaiseStartEditing()
    GridCellRendererBase.RaiseBeginEdit()
    GridCellRendererBase.OnEnteredEditMode()
    GridCellRendererBase.RaiseEndEdit()
    GridCellRendererBase.RaiseEditingComplete()
    GridCellRendererBase.OnEditingComplete()
    GridCellRendererBase.UpdateCellRowColumnIndex(RowColumnIndex)
    GridCellRendererBase.UpdateCurrentStyle()
    GridCellRendererBase.MouseDown(FrameworkElement, MouseControllerEventArgs)
    GridCellRendererBase.StyleChanged(StyleChangedEventArgs)
    GridCellRendererBase.OnCreateAutomationPeer()
    GridCellRendererBase.IsControlTextShown
    GridCellRendererBase.IsFocusable
    GridCellRendererBase.IsModifiable
    GridCellRendererBase.IsDropDownable
    GridCellRendererBase.EditorType
    GridCellRendererBase.CellModel
    GridCellRendererBase.GridControl
    GridCellRendererBase.CellRowColumnIndex
    GridCellRendererBase.ActivateOptions
    GridCellRendererBase.RowIndex
    GridCellRendererBase.ColumnIndex
    GridCellRendererBase.CurrentCell
    GridCellRendererBase.CurrentStyle
    GridCellRendererBase.CurrentStyleCopy
    GridCellRendererBase.HasCurrentCellState
    GridCellRendererBase.IsFocused
    GridCellRendererBase.IsModified
    GridCellRendererBase.IsDroppedDown
    GridCellRendererBase.ControlText
    GridCellRendererBase.HasControlText
    GridCellRendererBase.InSetControlText
    GridCellRendererBase.ControlValue
    GridCellRendererBase.HasControlValue
    GridCellRendererBase.InSetControlValue
    GridCellRendererBase.InInitialize
    GridCellRendererBase.IsEditable
    GridCellRendererBase.AllowGridToFocus
    GridCellRendererBase.SupportsRenderOptimization
    CellRendererBase<GridRenderStyleInfo>.isInArrange
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.Render(DrawingContext, RenderCellArgs)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.Arrange(ArrangeCellArgs)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.PrepareUIElements(ArrangeCellArgs, List<UIElement>, ScrollControlChildFrame)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.UnloadUIElements(VirtualizingCellsControl, RowColumnIndex, CellUIElements)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.CancelMouseCapture(UIElement)
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.RecaptureMouse(UIElement)
    CellRendererBase<GridRenderStyleInfo>.RefreshCellUIElementsContent(VirtualizingCellsControl, CellUIElements, RowColumnIndex)
    CellRendererBase<GridRenderStyleInfo>.Hide(UIElement)
    CellRendererBase<GridRenderStyleInfo>.IsInArrange
    CellRendererBase<GridRenderStyleInfo>.AllowCancelMouseCapture
    CellRendererBase<GridRenderStyleInfo>.ICellRenderer.UnloadUIElementsWhenScrolledOutOfView
    CellRendererBase<GridRenderStyleInfo>.UnloadVisualsWhenScrolledOutOfView
    NonFinalizeDisposable.Dispose()
    System.Object.ToString()
    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: Syncfusion.Windows.Controls.Grid
    Assembly: Syncfusion.Grid.Wpf.dll
    Syntax
    public class GridDataFilterBarCellRenderer : GridVirtualizingCellRenderer<TextBox>, IGridCellRenderer, ICellRenderer, IHitTestSelectCells, IStyleChanged, IDisposable, IAllowKeepAliveOnlyCurrentCell

    Constructors

    GridDataFilterBarCellRenderer()

    Initializes a new GridDataFilterBarCellRenderer.

    Declaration
    public GridDataFilterBarCellRenderer()

    Properties

    AlphaNumericRegexString

    Gets or Sets the Regex String for AlphaNumeric FilterBarType

    Declaration
    public string AlphaNumericRegexString { get; set; }
    Property Value
    Type Description
    System.String

    AlphaNumericWithSeparatorRegexString

    Gets or Sets the Regex String with Separator for AlphaNumeric FilterBarType

    Declaration
    public string AlphaNumericWithSeparatorRegexString { get; set; }
    Property Value
    Type Description
    System.String

    ContainsString

    Declaration
    public string ContainsString { get; set; }
    Property Value
    Type Description
    System.String

    DefaultFilterType

    Declaration
    public FilterType DefaultFilterType { get; set; }
    Property Value
    Type Description
    Syncfusion.Linq.FilterType

    EqualsString

    Declaration
    public string EqualsString { get; set; }
    Property Value
    Type Description
    System.String

    ErrorToolTip

    Displays the Error Tooltip when the filtered value was worng

    Declaration
    public string ErrorToolTip { get; set; }
    Property Value
    Type Description
    System.String

    FilterBarMode

    Gets or Sets the FilterBarMode for the current Visible Column

    Declaration
    public GridDataFilterBarMode FilterBarMode { get; set; }
    Property Value
    Type Description
    GridDataFilterBarMode

    FilterBarType

    Gets the Current FilterBar Type

    Declaration
    public GridDataFilterBarType FilterBarType { get; }
    Property Value
    Type Description
    GridDataFilterBarType

    GreaterThanOrEqualString

    Declaration
    public string GreaterThanOrEqualString { get; set; }
    Property Value
    Type Description
    System.String

    GreaterThanString

    Declaration
    public string GreaterThanString { get; set; }
    Property Value
    Type Description
    System.String

    IsFilteringSuspend

    Declaration
    public bool IsFilteringSuspend { get; }
    Property Value
    Type Description
    System.Boolean

    LessThanOrEqualString

    Declaration
    public string LessThanOrEqualString { get; set; }
    Property Value
    Type Description
    System.String

    LessThanString

    Declaration
    public string LessThanString { get; set; }
    Property Value
    Type Description
    System.String

    NotString

    Declaration
    public string NotString { get; set; }
    Property Value
    Type Description
    System.String

    NumericFollow

    Gets or Sets the Regex String for Numeric FilterBarType

    Declaration
    public string NumericFollow { get; set; }
    Property Value
    Type Description
    System.String

    NumericWithSeparatorRegexString

    Gets or Sets the Regex String with Separator for Numeric FilterBarType

    Declaration
    public string NumericWithSeparatorRegexString { get; set; }
    Property Value
    Type Description
    System.String

    StartWithEndWithString

    Declaration
    public string StartWithEndWithString { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    ArrangeUIElement(ArrangeCellArgs, TextBox, GridRenderStyleInfo)

    Declaration
    protected override void ArrangeUIElement(ArrangeCellArgs aca, TextBox textBox, GridRenderStyleInfo style)
    Parameters
    Type Name Description
    ArrangeCellArgs aca
    System.Windows.Controls.TextBox textBox
    GridRenderStyleInfo style
    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRendererBase<System.Windows.Controls.TextBox>.ArrangeUIElement(Syncfusion.Windows.Controls.Cells.ArrangeCellArgs, System.Windows.Controls.TextBox, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

    ClearCurrentColumnFilter()

    Clears the Filter from the Current VisibleColumn..

    Declaration
    protected virtual void ClearCurrentColumnFilter()

    GenerateFilter(Object, FilterType, Boolean)

    This method will apply Filter for the current Visible Column.

    Declaration
    public void GenerateFilter(object filtervalue, FilterType defaultFilterType, bool NeedValidation)
    Parameters
    Type Name Description
    System.Object filtervalue

    FilterValue

    Syncfusion.Linq.FilterType defaultFilterType

    FilterType

    System.Boolean NeedValidation

    True will validate the Filtering. False will apply filter directly.

    GetControlTextFromEditorCore(TextBox)

    Declaration
    protected override string GetControlTextFromEditorCore(TextBox textBox)
    Parameters
    Type Name Description
    System.Windows.Controls.TextBox textBox
    Returns
    Type Description
    System.String
    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.TextBox>.GetControlTextFromEditorCore(System.Windows.Controls.TextBox)

    GetCurrentColumn()

    Returns the Current GridDataVisibleColumn.

    Declaration
    public GridDataVisibleColumn GetCurrentColumn()
    Returns
    Type Description
    GridDataVisibleColumn

    GetCurrentFilterBarType()

    Returns the GridDataFilterBarType based on the VisibleColumn ColumnType.

    Declaration
    public GridDataFilterBarType GetCurrentFilterBarType()
    Returns
    Type Description
    GridDataFilterBarType

    GetCurrentFilterValue()

    Returns the Current FilterValue else returns empty String

    Declaration
    public string GetCurrentFilterValue()
    Returns
    Type Description
    System.String

    GetFilterType()

    Declaration
    public FilterType GetFilterType()
    Returns
    Type Description
    Syncfusion.Linq.FilterType

    GetStatusMessage()

    Declaration
    public string GetStatusMessage()
    Returns
    Type Description
    System.String

    m_filtertype(String)

    This method is used to set the filtertype based on string-tokenizer

    Declaration
    public FilterType m_filtertype(string filterValue)
    Parameters
    Type Name Description
    System.String filterValue

    Specifies to check whether the filterValue contains string-tokenizer or not.

    Returns
    Type Description
    Syncfusion.Linq.FilterType

    OnActivated()

    Declaration
    protected override void OnActivated()
    Overrides
    GridCellRendererBase.OnActivated()

    OnDeactivated()

    Declaration
    protected override void OnDeactivated()
    Overrides
    GridCellRendererBase.OnDeactivated()

    OnDeactivating()

    Declaration
    protected override bool OnDeactivating()
    Returns
    Type Description
    System.Boolean
    Overrides
    GridCellRendererBase.OnDeactivating()

    OnGridPreviewTextInput(TextCompositionEventArgs)

    Declaration
    protected override void OnGridPreviewTextInput(TextCompositionEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TextCompositionEventArgs e
    Overrides
    GridCellRendererBase.OnGridPreviewTextInput(TextCompositionEventArgs)

    OnInitialize()

    Declaration
    protected override void OnInitialize()
    Overrides
    GridCellRendererBase.OnInitialize()

    OnInitializeContent(TextBox, GridRenderStyleInfo)

    Declaration
    public override void OnInitializeContent(TextBox textBox, GridRenderStyleInfo style)
    Parameters
    Type Name Description
    System.Windows.Controls.TextBox textBox
    GridRenderStyleInfo style
    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.TextBox>.OnInitializeContent(System.Windows.Controls.TextBox, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

    OnRender(DrawingContext, RenderCellArgs, GridRenderStyleInfo)

    Declaration
    protected override void OnRender(DrawingContext dc, RenderCellArgs rca, GridRenderStyleInfo style)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    RenderCellArgs rca
    GridRenderStyleInfo style
    Overrides
    Syncfusion.Windows.Controls.Cells.CellRendererBase<Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo>.OnRender(System.Windows.Media.DrawingContext, Syncfusion.Windows.Controls.Cells.RenderCellArgs, Syncfusion.Windows.Controls.Grid.GridRenderStyleInfo)

    OnSetFocus()

    Declaration
    protected override void OnSetFocus()
    Overrides
    GridCellRendererBase.OnSetFocus()

    OnUnwireUIElement(TextBox)

    Unwire previously wired events from textBox.

    Declaration
    protected override void OnUnwireUIElement(TextBox textBox)
    Parameters
    Type Name Description
    System.Windows.Controls.TextBox textBox
    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.TextBox>.OnUnwireUIElement(System.Windows.Controls.TextBox)

    OnWireUIElement(TextBox)

    Wire events from textBox

    Declaration
    protected override void OnWireUIElement(TextBox textBox)
    Parameters
    Type Name Description
    System.Windows.Controls.TextBox textBox
    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.TextBox>.OnWireUIElement(System.Windows.Controls.TextBox)

    RaiseGridCellClick(Int32, Int32, MouseControllerEventArgs)

    Raises GridCellClick event.

    Declaration
    public override void RaiseGridCellClick(int rowIndex, int colIndex, MouseControllerEventArgs e)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The cell row index.

    System.Int32 colIndex

    The cell column index.

    MouseControllerEventArgs e

    A MouseControllerEventArgs object.

    Overrides
    GridCellRendererBase.RaiseGridCellClick(Int32, Int32, MouseControllerEventArgs)

    RefreshContent()

    Refreshes the textbox UnwireTemplatePartscell.

    Declaration
    public override void RefreshContent()
    Overrides
    Syncfusion.Windows.Controls.Grid.GridVirtualizingCellRenderer<System.Windows.Controls.TextBox>.RefreshContent()

    SetInVaildDataError()

    Declaration
    protected virtual void SetInVaildDataError()

    SetInValidDateTimeError()

    Declaration
    protected virtual void SetInValidDateTimeError()

    SetNoRecordsDataError()

    Declaration
    protected virtual void SetNoRecordsDataError()

    SetStatusMessage(String)

    Declaration
    public void SetStatusMessage(string statusMessage)
    Parameters
    Type Name Description
    System.String statusMessage

    ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs)

    Declaration
    protected override bool ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyEventArgs e
    Returns
    Type Description
    System.Boolean
    Overrides
    GridCellRendererBase.ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs)

    ValidateCurrentColumn()

    Declaration
    public bool ValidateCurrentColumn()
    Returns
    Type Description
    System.Boolean

    Events

    FilterValueChanged

    Declaration
    public event EventHandler<GridDataFilterBarValueArgs> FilterValueChanged
    Event Type
    Type Description
    System.EventHandler<GridDataFilterBarValueArgs>

    Implements

    IGridCellRenderer
    ICellRenderer
    IHitTestSelectCells
    IStyleChanged
    System.IDisposable
    IAllowKeepAliveOnlyCurrentCell
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved