WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridExcelFilterCellRenderer

    Show / Hide Table of Contents

    Class GridExcelFilterCellRenderer

    Implements the renderer part of an optimized ExcelFilterCell.

    Inheritance
    System.Object
    NonFinalizeDisposable
    GridCellRendererBase
    GridStaticCellRenderer
    GridHeaderCellRenderer
    GridExcelFilterCellRenderer
    Implements
    IQueryFocusInside
    IGridDropDownCell
    IPopupParent
    IPopupItem
    System.IDisposable
    Inherited Members
    GridHeaderCellRenderer.WireGrid()
    GridHeaderCellRenderer.UnwireGrid()
    GridHeaderCellRenderer.OnHitTest(Int32, Int32, MouseEventArgs, IMouseController)
    GridHeaderCellRenderer.OnMouseMove(Int32, Int32, MouseEventArgs)
    GridHeaderCellRenderer.OnMouseHover(Int32, Int32, MouseEventArgs)
    GridHeaderCellRenderer.OnMouseDown(Int32, Int32, MouseEventArgs)
    GridHeaderCellRenderer.OnMouseUp(Int32, Int32, MouseEventArgs)
    GridHeaderCellRenderer.DrawMetroHeaderStyle(Graphics, Rectangle, ThemedHeaderDrawing.HeaderState)
    GridHeaderCellRenderer.DrawMetroCaptionRowStyle(Graphics, Rectangle, ThemedHeaderDrawing.HeaderState)
    GridHeaderCellRenderer.OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)
    GridHeaderCellRenderer.OnDrawCellBackground(GridDrawCellBackgroundEventArgs)
    GridHeaderCellRenderer.OnOutlineCurrentCell(Graphics, Rectangle)
    GridStaticCellRenderer.CanCopy()
    GridStaticCellRenderer.CanCut()
    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.ProcessMouseWheel(MouseEventArgs)
    GridCellRendererBase.GetEditState()
    GridCellRendererBase.SetEditState(Object)
    GridCellRendererBase.ToString()
    GridCellRendererBase.OnDeleting()
    GridCellRendererBase.UnwireModel(GridCellModelBase)
    GridCellRendererBase.WireModel(GridCellModelBase)
    GridCellRendererBase.OnModelChanged(EventArgs)
    GridCellRendererBase.OnDeactivating()
    GridCellRendererBase.OnDeactived(Int32, Int32)
    GridCellRendererBase.OnBeginEdit()
    GridCellRendererBase.OnEndEdit()
    GridCellRendererBase.QueryFocusInside()
    GridCellRendererBase.OnHasFocusControlChanged()
    GridCellRendererBase.OnSaveChanges()
    GridCellRendererBase.OnRejectChanges()
    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.NotifyCurrentCellChanged()
    GridCellRendererBase.NotifyCurrentCellControlDoubleClick(Control)
    GridCellRendererBase.ControlDoubleClick(Object, EventArgs)
    GridCellRendererBase.OnControlDoubleClick(Control)
    GridCellRendererBase.NotifyCurrentCellControlGotFocus(Control)
    GridCellRendererBase.NotifyCurrentCellControlLostFocus(Control)
    GridCellRendererBase.OnShowDropDown()
    GridCellRendererBase.OnCloseDropDown(PopupCloseType)
    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.DrawCellAppearance(Graphics, Rectangle, GridStyleInfo)
    GridCellRendererBase.GetMarkHeaderState(Int32, Int32, GridStyleInfo)
    GridCellRendererBase.SetControl(Control)
    GridCellRendererBase.ControlLostFocus(Object, EventArgs)
    GridCellRendererBase.ControlGotFocus(Object, EventArgs)
    GridCellRendererBase.OnSetControlText(String)
    GridCellRendererBase.ResetControlText()
    GridCellRendererBase.UpdateControlValue()
    GridCellRendererBase.SetControlValue(Object, Boolean)
    GridCellRendererBase.InitializeControlText(Object)
    GridCellRendererBase.ResetControlValue()
    GridCellRendererBase.GetDisplayText()
    GridCellRendererBase.GetCellValue()
    GridCellRendererBase.Initialize(Int32, Int32)
    GridCellRendererBase.OnInitialize(Int32, Int32)
    GridCellRendererBase.InitializedAt(Int32, Int32)
    GridCellRendererBase.InitalizedAt(Int32, Int32)
    GridCellRendererBase.Hide()
    GridCellRendererBase.IsControlVisible()
    GridCellRendererBase.RaiseProcessKeyEventArgs(Message)
    GridCellRendererBase.ProcessKeyEventArgs(Message)
    GridCellRendererBase.OnKeyDown(KeyEventArgs)
    GridCellRendererBase.OnKeyUp(KeyEventArgs)
    GridCellRendererBase.OnKeyPress(KeyPressEventArgs)
    GridCellRendererBase.Copy()
    GridCellRendererBase.Paste()
    GridCellRendererBase.Cut()
    GridCellRendererBase.CanPaste()
    GridCellRendererBase.FindText(String, Int32, Int32, GridFindTextOptions, Boolean)
    GridCellRendererBase.GetCellText(GridStyleInfo, GridFindTextOptions)
    GridCellRendererBase.ReplaceText(String, String, Int32, Int32, GridFindTextOptions, Boolean)
    GridCellRendererBase.ReplaceSel(String)
    GridCellRendererBase.GetSelectedText(String)
    GridCellRendererBase.OnNotifyMsg(Message)
    GridCellRendererBase.IsReadOnly()
    GridCellRendererBase.ValidateString(String)
    GridCellRendererBase.RaiseHitTest(Int32, Int32, MouseEventArgs, IMouseController)
    GridCellRendererBase.RaiseGetCursor(Int32, Int32)
    GridCellRendererBase.OnGetCursor(Int32, Int32)
    GridCellRendererBase.RaiseMouseHoverEnter(Int32, Int32)
    GridCellRendererBase.RaiseMouseHover(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseMouseHoverLeave(Int32, Int32, EventArgs)
    GridCellRendererBase.RaiseMouseDown(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.ControlMouseDown(Object, MouseEventArgs)
    GridCellRendererBase.RaiseMouseMove(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseMouseUp(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseCancelMode(Int32, Int32)
    GridCellRendererBase.OnCancelMode(Int32, Int32)
    GridCellRendererBase.RaiseClick(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnClick(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.RaiseDoubleClick(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnDoubleClick(Int32, Int32, MouseEventArgs)
    GridCellRendererBase.OnButtonClicked(Int32, Int32, Int32)
    GridCellRendererBase.CreateDropDownContainer()
    GridCellRendererBase.EnsureDropDownContainer()
    GridCellRendererBase.InitializeDropDownContainer()
    GridCellRendererBase.ChildClosing(IPopupChild, PopupCloseType)
    GridCellRendererBase.DropDownContainerCloseDropDown(Object, PopupClosedEventArgs)
    GridCellRendererBase.IPopupParent.GetLocationForPopupAlignment(PopupRelativeAlignment, PopupRelativeAlignment)
    GridCellRendererBase.IPopupParent.GetBorderOverlapCue(PopupRelativeAlignment)
    GridCellRendererBase.DropDownContainerShowedDropDown(Object, EventArgs)
    GridCellRendererBase.DropDownContainerShowingDropDown(Object, CancelEventArgs)
    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.Model
    GridCellRendererBase.CurrentCell
    GridCellRendererBase.InBeginEdit
    GridCellRendererBase.SupportsFocusControl
    GridCellRendererBase.SupportsEditing
    GridCellRendererBase.HasFocusControl
    GridCellRendererBase.IsEditing
    GridCellRendererBase.IsDroppedDown
    GridCellRendererBase.Control
    GridCellRendererBase.InSetControlText
    GridCellRendererBase.ControlText
    GridCellRendererBase.HasControlText
    GridCellRendererBase.InSetControlValue
    GridCellRendererBase.ControlValue
    GridCellRendererBase.InSetSetControlValue
    GridCellRendererBase.HasControlValue
    GridCellRendererBase.InInitialize
    GridCellRendererBase.CurrentStyle
    GridCellRendererBase.Initalized
    GridCellRendererBase.Grid
    GridCellRendererBase.StyleInfo
    GridCellRendererBase.ForceRefreshOnActivateCell
    GridCellRendererBase.RowIndex
    GridCellRendererBase.ColIndex
    GridCellRendererBase.MouseDownTick
    GridCellRendererBase.MouseDownPoint
    GridCellRendererBase.ClickOverImage
    GridCellRendererBase.AlwaysRaiseCellClick
    GridCellRendererBase.DropDownPart
    GridCellRendererBase.DropDownButton
    GridCellRendererBase.IPopupParent.IsRightToLeft
    GridCellRendererBase.DropDownContainer
    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.GridHelperClasses
    Assembly: Syncfusion.GridHelperClasses.Windows.dll
    Syntax
    public class GridExcelFilterCellRenderer : GridHeaderCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposable

    Constructors

    GridExcelFilterCellRenderer(GridControlBase, GridCellModelBase, GridExcelFilter)

    Initializes a new GridExcelFilterCellRenderer object for the given GridControlBase and GridCellModelBase.

    Declaration
    public GridExcelFilterCellRenderer(GridControlBase grid, GridCellModelBase cellModel, GridExcelFilter filter)
    Parameters
    Type Name Description
    GridControlBase grid

    The GridControlBase that displays this cell renderer.

    GridCellModelBase cellModel

    The Grid2007ExcelFilterCellModel that holds data for this cell renderer that should

    The GridExcelFilter that displays this cell renderer. be shared among views.
    GridExcelFilter filter
    Remarks

    References to GridControlBase and GridCellModelBase will be saved.

    Fields

    col_index

    Stores the row and column index

    Declaration
    public int col_index
    Field Value
    Type Description
    System.Int32

    row_index

    Stores the row and column index

    Declaration
    public int row_index
    Field Value
    Type Description
    System.Int32

    Properties

    FilteredIcon

    Gets or sets a Bitmap for the Filtered icon.

    Declaration
    protected Bitmap FilteredIcon { get; set; }
    Property Value
    Type Description
    System.Drawing.Bitmap

    FilterIcon

    Gets or sets a Bitmap for the Filter icon.

    Declaration
    protected Bitmap FilterIcon { get; set; }
    Property Value
    Type Description
    System.Drawing.Bitmap

    FilterIconSize

    Gets or sets a value indicating the size of the GridExcelFilter's filter icon.

    Declaration
    protected Size FilterIconSize { get; set; }
    Property Value
    Type Description
    System.Drawing.Size

    Methods

    ClearFilters()

    Clears all the filter choices from dictionary.

    Declaration
    public void ClearFilters()

    Dispose(Boolean)

    Disposes the groupingGrid and its events.

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

    Indicates whether controls has to be disposed.

    Overrides
    GridHeaderCellRenderer.Dispose(Boolean)

    GetDateFilterBarChoices(Object[], Int32, Object)

    Returns the unique choices to be displayed in the filterbar cell.

    Declaration
    public object[] GetDateFilterBarChoices(object[] items, int index, object filteroption)
    Parameters
    Type Name Description
    System.Object[] items

    Stores the list of items

    System.Int32 index

    Represents the index for the use of indicating the item

    System.Object filteroption

    Used to select the filter option

    Returns
    Type Description
    System.Object[]

    Filter bar choices.

    GetFilterBarChoices(GridTableCellStyleInfoIdentity)

    Returns the unique choices to be displayed in the filterbar cell.

    Declaration
    public object[] GetFilterBarChoices(GridTableCellStyleInfoIdentity tableCellIdentity)
    Parameters
    Type Name Description
    GridTableCellStyleInfoIdentity tableCellIdentity

    Table cell identifier.

    Returns
    Type Description
    System.Object[]

    Filter bar choices.

    GetFilterName(GridTableCellStyleInfo)

    Determines the name of the filter based on the cell style information passed in.

    Declaration
    public string GetFilterName(GridTableCellStyleInfo sty)
    Parameters
    Type Name Description
    GridTableCellStyleInfo sty

    cell style information.

    Returns
    Type Description
    System.String

    Name of the filter.

    GetUniqueGroupId(GridTableCellStyleInfoIdentity)

    Returns an array of category keys for this group and all parent groups which is used by FilterBarCells and FilterBarSummary to compare whether the conditions should be applied to this group.

    Declaration
    public object[] GetUniqueGroupId(GridTableCellStyleInfoIdentity tableCellIdentity)
    Parameters
    Type Name Description
    GridTableCellStyleInfoIdentity tableCellIdentity

    Cell identifier.

    Returns
    Type Description
    System.Object[]

    An array of category keys.

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

    Overridden to draw the border line.

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

    Graphics of a cell.

    System.Drawing.Rectangle clientRectangle

    Text rectangle of a cell.

    System.Int32 rowIndex

    Row index of a cell.

    System.Int32 colIndex

    Column index of a cell.

    GridStyleInfo style

    Cell style.

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

    OnDrawDisplayText(Graphics, Rectangle, Int32, Int32, GridStyleInfo)

    Overridden to draw the sort icons.

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

    Graphics of a cell.

    System.Drawing.Rectangle textRectangle

    Text rectangle of a cell.

    System.Int32 rowIndex

    Row index of a cell.

    System.Int32 colIndex

    Column index of a cell.

    GridStyleInfo style

    Cell style.

    Overrides
    GridHeaderCellRenderer.OnDrawDisplayText(Graphics, Rectangle, Int32, Int32, GridStyleInfo)

    OnMouseHoverEnter(Int32, Int32)

    Occurs when mouse hover enters the column header.

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

    Row index of a cell.

    System.Int32 colIndex

    Column index of a cell.

    Overrides
    GridCellRendererBase.OnMouseHoverEnter(Int32, Int32)

    OnMouseHoverLeave(Int32, Int32, EventArgs)

    Occurs when mouse hover leaves the column header.

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

    Row index of a cell.

    System.Int32 colIndex

    Column index of a cell.

    System.EventArgs e

    The System.EventArgs that contains the event data.

    Overrides
    GridHeaderCellRenderer.OnMouseHoverLeave(Int32, Int32, EventArgs)

    Implements

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