menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridTableFilterBarCellRenderer - API Reference

    Show / Hide Table of Contents

    Class GridTableFilterBarCellRenderer

    Implements the renderer part of a TableFilterBar cell.

    Inheritance
    System.Object
    NonFinalizeDisposable
    GridCellRendererBase
    GridStaticCellRenderer
    GridTextBoxCellRenderer
    GridDropDownCellRenderer
    GridComboBoxCellRenderer
    GridTableFilterBarCellRenderer
    GridFilterByDisplayMemberCellRenderer
    Implements
    IQueryFocusInside
    IGridDropDownCell
    IPopupParent
    IPopupItem
    System.IDisposable
    Inherited Members
    GridComboBoxCellRenderer.CreateListBoxPart()
    GridComboBoxCellRenderer.Dispose(Boolean)
    GridComboBoxCellRenderer.DetachListBoxPart()
    GridComboBoxCellRenderer.AttachListBoxPart()
    GridComboBoxCellRenderer.OnRejectChanges()
    GridComboBoxCellRenderer.ProcessMouseWheel(MouseEventArgs)
    GridComboBoxCellRenderer.OnDeactivating()
    GridComboBoxCellRenderer.OnSetControlText(String)
    GridComboBoxCellRenderer.OnKeyPress(KeyPressEventArgs)
    GridComboBoxCellRenderer.TextBoxChanged(Object, EventArgs)
    GridComboBoxCellRenderer.ValidateString(String)
    GridComboBoxCellRenderer.DropDownContainerShowedDropDown(Object, EventArgs)
    GridComboBoxCellRenderer.InitializeDropDownContainer()
    GridComboBoxCellRenderer.NotifyCurrentCellChanged()
    GridComboBoxCellRenderer.ListBoxClick(Object, EventArgs)
    GridComboBoxCellRenderer.ChildClosing(IPopupChild, PopupCloseType)
    GridComboBoxCellRenderer.SynchronizeDisplayText(Int32)
    GridComboBoxCellRenderer.FindItem(String, Boolean, Int32, Boolean)
    GridComboBoxCellRenderer.FindItemExact(String, Boolean, Int32, Boolean)
    GridComboBoxCellRenderer.OnEditPartMouseDown(Object, MouseEventArgs)
    GridComboBoxCellRenderer.OnClick(Int32, Int32, MouseEventArgs)
    GridComboBoxCellRenderer.OnDoubleClick(Int32, Int32, MouseEventArgs)
    GridComboBoxCellRenderer.AllowValidateStringOnKeyPress
    GridComboBoxCellRenderer.ListBoxPart
    GridDropDownCellRenderer.CreateTextBox()
    GridDropDownCellRenderer.TextBoxGotFocus(Object, EventArgs)
    GridDropDownCellRenderer.EditPart
    GridDropDownCellRenderer.PopupControlContainer
    GridDropDownCellRenderer.DropDownContainer
    GridTextBoxCellRenderer.GetEditState()
    GridTextBoxCellRenderer.SetEditState(Object)
    GridTextBoxCellRenderer.WireModel(GridCellModelBase)
    GridTextBoxCellRenderer.UnwireModel(GridCellModelBase)
    GridTextBoxCellRenderer.ControlLostFocus(Object, EventArgs)
    GridTextBoxCellRenderer.ControlGotFocus(Object, EventArgs)
    GridTextBoxCellRenderer.TextBoxLostFocus(Object, EventArgs)
    GridTextBoxCellRenderer.ModelUpdateActiveText()
    GridTextBoxCellRenderer.SetModelActiveText(String)
    GridTextBoxCellRenderer.GetSelectedText(String)
    GridTextBoxCellRenderer.ReplaceSel(String)
    GridTextBoxCellRenderer.OnHasFocusControlChanged()
    GridTextBoxCellRenderer.SetTextBoxText(String, Boolean)
    GridTextBoxCellRenderer.SetSelectedText(String, Boolean)
    GridTextBoxCellRenderer.CanCopy()
    GridTextBoxCellRenderer.Copy()
    GridTextBoxCellRenderer.Paste()
    GridTextBoxCellRenderer.CanPaste()
    GridTextBoxCellRenderer.CanCut()
    GridTextBoxCellRenderer.Cut()
    GridTextBoxCellRenderer.WantsAutoSize
    GridTextBoxCellRenderer.LimitTextLength
    GridTextBoxCellRenderer.TextBoxControl
    GridTextBoxCellRenderer.InTextBoxChanged
    GridTextBoxCellRenderer.TextBox
    GridTextBoxCellRenderer.IgnoreTextBoxChanged
    GridTextBoxCellRenderer.InNotifyCurrentCellChangedException
    GridTextBoxCellRenderer.InSetTextBoxTextCore
    GridTextBoxCellRenderer.TextBoxTextCore
    GridTextBoxCellRenderer.TextBoxText
    GridTextBoxCellRenderer.DisableTextBox
    GridStaticCellRenderer.RemoveMargins(Rectangle, GridStyleInfo)
    GridStaticCellRenderer.DrawImage(Graphics, ImageList, Int32, Rectangle, Boolean)
    GridStaticCellRenderer.DrawImage(Graphics, ImageList, Int32, Rectangle, Rectangle, Boolean)
    GridStaticCellRenderer.DrawImage(Graphics, ImageList, Int32, Rectangle)
    GridStaticCellRenderer.DrawText(Graphics, String, Font, Rectangle, GridStyleInfo, Color, Boolean)
    GridStaticCellRenderer.DrawText(Graphics, String, Font, Rectangle, GridStyleInfo, Color, Boolean, Boolean)
    GridStaticCellRenderer.GetRotatedTextBound(String, Font, StringFormat, Single, Single)
    GridStaticCellRenderer.DrawRotatedString(Graphics, String, Font, Brush, RectangleF, StringFormat, Single, GridStyleInfo)
    GridStaticCellRenderer.DrawText(Graphics, String, Font, Rectangle, GridStyleInfo, Color)
    GridStaticCellRenderer.IsPointOverImage(Int32, Int32, Point)
    GridCellRendererBase.Dispose()
    GridCellRendererBase.ToString()
    GridCellRendererBase.OnDeleting()
    GridCellRendererBase.OnModelChanged(EventArgs)
    GridCellRendererBase.OnDeactived(Int32, Int32)
    GridCellRendererBase.OnBeginEdit()
    GridCellRendererBase.OnEndEdit()
    GridCellRendererBase.QueryFocusInside()
    GridCellRendererBase.OnSaveChanges()
    GridCellRendererBase.OnStartEditing()
    GridCellRendererBase.OnEditingComplete()
    GridCellRendererBase.OnValidate()
    GridCellRendererBase.OnValidated()
    GridCellRendererBase.OnActivating(Int32, Int32)
    GridCellRendererBase.OnActivated()
    GridCellRendererBase.ShouldDrawEditing(Int32, Int32)
    GridCellRendererBase.ShouldDrawFocused(Int32, Int32)
    GridCellRendererBase.NotifyCurrentCellChanging()
    GridCellRendererBase.NotifyCurrentCellControlDoubleClick(Control)
    GridCellRendererBase.ControlDoubleClick(Object, EventArgs)
    GridCellRendererBase.OnControlDoubleClick(Control)
    GridCellRendererBase.NotifyCurrentCellControlGotFocus(Control)
    GridCellRendererBase.NotifyCurrentCellControlLostFocus(Control)
    GridCellRendererBase.OnShowDropDown()
    GridCellRendererBase.OnCloseDropDown(PopupCloseType)
    GridCellRendererBase.OnOutlineCurrentCell(Graphics, Rectangle)
    GridCellRendererBase.OnCellLayoutChanged()
    GridCellRendererBase.OnGridGotFocus(EventArgs)
    GridCellRendererBase.ResetCellLayout()
    GridCellRendererBase.GetCellBoundsCore(Int32, Int32)
    GridCellRendererBase.GetCellBoundsCore(Int32, Int32, Boolean)
    GridCellRendererBase.GetCellBoundsCoreInt(Int32, Int32, Boolean)
    GridCellRendererBase.GetCellLayout(Int32, Int32, GridStyleInfo)
    GridCellRendererBase.GetCellClientRectangle(Int32, Int32, GridStyleInfo, Boolean)
    GridCellRendererBase.PerformLayout(Int32, Int32)
    GridCellRendererBase.PerformLayout(Int32, Int32, GridStyleInfo)
    GridCellRendererBase.PerformLayout(Int32, Int32, GridStyleInfo, Rectangle)
    GridCellRendererBase.OnLayout(Int32, Int32, GridStyleInfo, Rectangle, Rectangle[])
    GridCellRendererBase.DrawSingleCell(Graphics, Rectangle, Int32, Int32, GridStyleInfo, Boolean)
    GridCellRendererBase.Draw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
    GridCellRendererBase.OnDrawCellButton(GridCellButton, Graphics, Int32, Int32, Boolean, GridStyleInfo)
    GridCellRendererBase.OnDrawCellButtonBackground(GridCellButton, Graphics, Rectangle, ButtonState, GridStyleInfo)
    GridCellRendererBase.OnQueryShowButtons(Int32, Int32, GridStyleInfo)
    GridCellRendererBase.AddButton(GridCellButton)
    GridCellRendererBase.RemoveButton(GridCellButton)
    GridCellRendererBase.GetButton(Int32)
    GridCellRendererBase.DrawBackground(Graphics, Rectangle, GridStyleInfo, Boolean)
    GridCellRendererBase.OnDrawCellBackground(GridDrawCellBackgroundEventArgs)
    GridCellRendererBase.DrawCellAppearance(Graphics, Rectangle, GridStyleInfo)
    GridCellRendererBase.GetMarkHeaderState(Int32, Int32, GridStyleInfo)
    GridCellRendererBase.SetControl(Control)
    GridCellRendererBase.ResetControlText()
    GridCellRendererBase.UpdateControlValue()
    GridCellRendererBase.SetControlValue(Object, Boolean)
    GridCellRendererBase.InitializeControlText(Object)
    GridCellRendererBase.ResetControlValue()
    GridCellRendererBase.GetDisplayText()
    GridCellRendererBase.GetCellValue()
    GridCellRendererBase.Initialize(Int32, Int32)
    GridCellRendererBase.InitializedAt(Int32, Int32)
    GridCellRendererBase.InitalizedAt(Int32, Int32)
    GridCellRendererBase.Hide()
    GridCellRendererBase.IsControlVisible()
    GridCellRendererBase.RaiseProcessKeyEventArgs(Message)
    GridCellRendererBase.ProcessKeyEventArgs(Message)
    GridCellRendererBase.OnKeyUp(KeyEventArgs)
    GridCellRendererBase.FindText(String, Int32, Int32, GridFindTextOptions, Boolean)
    GridCellRendererBase.GetCellText(GridStyleInfo, GridFindTextOptions)
    GridCellRendererBase.ReplaceText(String, String, Int32, Int32, GridFindTextOptions, Boolean)
    GridCellRendererBase.OnNotifyMsg(Message)
    GridCellRendererBase.IsReadOnly()
    GridCellRendererBase.RaiseHitTest(Int32, Int32, MouseEventArgs, IMouseController)
    GridCellRendererBase.OnHitTest(Int32, Int32, MouseEventArgs, IMouseController)
    GridCellRendererBase.RaiseGetCursor(Int32, Int32)
    GridCellRendererBase.OnGetCursor(Int32, Int32)
    GridCellRendererBase.RaiseMouseHoverEnter(Int32, Int32)
    GridCellRendererBase.OnMouseHoverEnter(Int32, Int32)
    GridCellRendererBase.RaiseMouseHover(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnMouseHover(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseMouseHoverLeave(Int32, Int32, EventArgs)
    GridCellRendererBase.OnMouseHoverLeave(Int32, Int32, EventArgs)
    GridCellRendererBase.RaiseMouseDown(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnMouseDown(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.ControlMouseDown(Object, MouseEventArgs)
    GridCellRendererBase.RaiseMouseMove(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnMouseMove(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseMouseUp(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnMouseUp(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseCancelMode(Int32, Int32)
    GridCellRendererBase.OnCancelMode(Int32, Int32)
    GridCellRendererBase.RaiseClick(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseDoubleClick(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnButtonClicked(Int32, Int32, Int32)
    GridCellRendererBase.CreateDropDownContainer()
    GridCellRendererBase.EnsureDropDownContainer()
    GridCellRendererBase.DropDownContainerCloseDropDown(Object, PopupClosedEventArgs)
    GridCellRendererBase.IPopupParent.GetLocationForPopupAlignment(PopupRelativeAlignment, PopupRelativeAlignment)
    GridCellRendererBase.IPopupParent.GetBorderOverlapCue(PopupRelativeAlignment)
    GridCellRendererBase.NotifyShowingDropDown(Size)
    GridCellRendererBase.NotifyShowedDropDown()
    GridCellRendererBase.IPopupItem.GetPopupParentControl()
    GridCellRendererBase.IsRelatedControl(Control, Boolean)
    GridCellRendererBase.OnScrollInView(GridScrollCurrentCellReason)
    GridCellRendererBase.GetNestedCurrentCell()
    GridCellRendererBase.ShouldRefreshCurrentCell()
    GridCellRendererBase.ScaleFactor
    GridCellRendererBase.IsDisposing
    GridCellRendererBase.IsDisposed
    GridCellRendererBase.DropDownImp
    GridCellRendererBase.CurrentCell
    GridCellRendererBase.InBeginEdit
    GridCellRendererBase.SupportsFocusControl
    GridCellRendererBase.SupportsEditing
    GridCellRendererBase.HasFocusControl
    GridCellRendererBase.IsEditing
    GridCellRendererBase.IsDroppedDown
    GridCellRendererBase.Control
    GridCellRendererBase.InSetControlText
    GridCellRendererBase.HasControlText
    GridCellRendererBase.InSetControlValue
    GridCellRendererBase.ControlValue
    GridCellRendererBase.InSetSetControlValue
    GridCellRendererBase.HasControlValue
    GridCellRendererBase.InInitialize
    GridCellRendererBase.CurrentStyle
    GridCellRendererBase.Initalized
    GridCellRendererBase.StyleInfo
    GridCellRendererBase.ForceRefreshOnActivateCell
    GridCellRendererBase.RowIndex
    GridCellRendererBase.ColIndex
    GridCellRendererBase.MouseDownTick
    GridCellRendererBase.MouseDownPoint
    GridCellRendererBase.ClickOverImage
    GridCellRendererBase.AlwaysRaiseCellClick
    GridCellRendererBase.DropDownPart
    GridCellRendererBase.DropDownButton
    GridCellRendererBase.IPopupParent.IsRightToLeft
    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.Forms.Grid.Grouping
    Assembly: Syncfusion.Grid.Grouping.Windows.dll
    Syntax
    public class GridTableFilterBarCellRenderer : GridComboBoxCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposable
    Remarks

    GridTableFilterBarCellRenderer can be customized with DataSource, ValueMember, and DisplayMember properties of a GridStyleInfo instance.

    If you do not have a data source object, you can also fill the drop-down list contents with a ChoiceList and optionally specify ExclusiveChoiceList.

    The TableFilterBar cell is XP Themes enabled. It will be drawn themed if ThemesEnabled is True.

    There can be several renderers. associated with one GridTableFilterBarCellModel if several views display the same GridModel.

    Use "TableFilterBar" as identifier in CellType of a cell's GridStyleInfo to associate this cell type with a cell.

    The cell's behavior and appearance can be customized with the following properties of the GridStyleInfo class.

    Constructors

    GridTableFilterBarCellRenderer(GridControlBase, GridCellModelBase)

    Initializes a new instance of the GridTableFilterBarCellRenderer class for the given instances of the GridControlBase and GridCellModelBase classes.

    Declaration
    public GridTableFilterBarCellRenderer(GridControlBase grid, GridCellModelBase cellModel)
    Parameters
    Type Name Description
    GridControlBase grid

    The GridControlBase that displays this cell renderer.

    GridCellModelBase cellModel

    The GridTableFilterBarCellModel that holds data for this cell renderer that should be shared among views.

    Remarks

    References to GridControlBase and GridCellModelBase will be saved.

    Properties

    ControlText

    Gets or sets the value to be specified to the active text that is being displayed on the cell.

    Declaration
    public override string ControlText { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    GridComboBoxCellRenderer.ControlText

    Grid

    Gets a value for reference to the parent grid.

    Declaration
    public GridTableControl Grid { get; }
    Property Value
    Type Description
    GridTableControl

    Model

    Gets a value for reference to the filterbar cell model.

    Declaration
    public GridTableFilterBarCellModel Model { get; }
    Property Value
    Type Description
    GridTableFilterBarCellModel

    Methods

    DropDownContainerShowingDropDown(Object, CancelEventArgs)

    Overrides and triggered when the drop down is about to be shown.

    Declaration
    public override void DropDownContainerShowingDropDown(object sender, CancelEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The Control.

    System.ComponentModel.CancelEventArgs e

    The System.ComponentModel.CancelEventArgs contains the event data.

    Overrides
    GridComboBoxCellRenderer.DropDownContainerShowingDropDown(Object, CancelEventArgs)

    GetFilterBarText(GridStyleInfo)

    Gets the text from record filter criteria that should be displayed in filter bar cell.

    Declaration
    public string GetFilterBarText(GridStyleInfo style)
    Parameters
    Type Name Description
    GridStyleInfo style

    An instance of the GridStyleInfo that holds the values of style properties.

    Returns
    Type Description
    System.String

    The filtered item's text value.

    ListBoxMouseUp(Object, MouseEventArgs)

    Overrides and triggered when the System.Windows.Forms.Control.MouseUp event is done in the list box.

    Declaration
    protected override void ListBoxMouseUp(object sender, MouseEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The Control.

    System.Windows.Forms.MouseEventArgs e

    A System.Windows.Forms.MouseEventArgs contains the event data.

    Overrides
    GridComboBoxCellRenderer.ListBoxMouseUp(Object, MouseEventArgs)

    OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)

    Overrides and draws the of the client bounds for the cell.

    Declaration
    protected override void OnDraw(Graphics g, Rectangle clientRectangle, int rowIndex, int colIndex, GridStyleInfo style)
    Parameters
    Type Name Description
    System.Drawing.Graphics g

    The instance of the System.Drawing.Graphics class.

    System.Drawing.Rectangle clientRectangle

    Specifies the client rectangle. It is the cell rectangle without buttons and borders.

    System.Int32 rowIndex

    Specifies the row index.

    System.Int32 colIndex

    Specifies the column index.

    GridStyleInfo style

    An instance of the GridStyleInfo that holds the values of style properties.

    Overrides
    GridTextBoxCellRenderer.OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)

    OnInitialize(Int32, Int32)

    Overrides and initializes the current cell.

    Declaration
    protected override void OnInitialize(int rowIndex, int colIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    Row index for the current cell.

    System.Int32 colIndex

    Column index for the current cell.

    Overrides
    GridComboBoxCellRenderer.OnInitialize(Int32, Int32)

    OnKeyDown(KeyEventArgs)

    Overrides and triggered when user pressed key down.

    Declaration
    protected override void OnKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.KeyEventArgs e

    The System.Windows.Forms.KeyEventArgs contains the event data.

    Overrides
    GridComboBoxCellRenderer.OnKeyDown(KeyEventArgs)

    OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)

    Overrides and triggered for custom formatting of a cell by changing its style object.

    Declaration
    public override void OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs e)
    Parameters
    Type Name Description
    GridPrepareViewStyleInfoEventArgs e

    The GridPrepareViewStyleInfoEventArgs contains the event data.

    Overrides
    GridComboBoxCellRenderer.OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)

    Implements

    IQueryFocusInside
    IGridDropDownCell
    IPopupParent
    IPopupItem
    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved