Class GridListFilterBarCellRenderer

Implements the renderer part of a TableFilterBar cell.

Inheritance
System.Object
NonFinalizeDisposable
GridCellRendererBase
GridStaticCellRenderer
GridTextBoxCellRenderer
GridDropDownCellRenderer
GridDropDownGridListControlCellRenderer
GridListFilterBarCellRenderer
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: Syncfusion.GridHelperClasses
Assembly: Syncfusion.GridHelperClasses.Windows.dll
Syntax
public class GridListFilterBarCellRenderer : GridDropDownGridListControlCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposable

Constructors

GridListFilterBarCellRenderer(GridControlBase, GridCellModelBase)

Initializes a new instance of the GridListFilterBarCellRenderer class for the given GridControlBase and GridCellModelBase.

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

The GridControlBase that displays this cell renderer.
GridCellModelBase cellModel

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

References to GridControlBase and GridCellModelBase will be saved.

Fields

filterColumnColl

A dictionary collection containing the filtercolumn

Declaration
public Dictionary<int, string> filterColumnColl
Field Value
Type Description
System.Collections.Generic.Dictionary<System.Int32, System.String>

Properties

Grid

Gets a reference to the parent grid.

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

Model

Gets a reference to the cell model.

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

Methods

AttachComparerListBoxPart()

Attaches a list box part to this renderer object.

Declaration
protected void AttachComparerListBoxPart()

AttachOriginalListBoxPart()

Called to attach a list box part to this renderer object.

Declaration
protected void AttachOriginalListBoxPart()

CanPaste()

Determines whether the current cell can be pasted from clipboard.

Declaration
public override bool CanPaste()
Returns
Type Description
System.Boolean

True if it is allowed.
Overrides

Dispose(Boolean)

Clean up the resources being used and unhook any events triggered in GridListFilterBarCellRenderer.

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

DropDownContainerShowingDropDown(Object, CancelEventArgs)

Occurs when the filter drop down is being shown.

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

Cell renderer.
System.ComponentModel.CancelEventArgs e

The System.ComponentModel.CancelEventArgs that contains the event data.
Overrides

GetFilterBarText(GridStyleInfo)

Determines the text from record filter criteria that should be displayed in filterbar cell.

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

Cell style information.
Returns
Type Description
System.String

Filter bar text.

ListControlGridPrepareViewStyleInfo(Object, GridPrepareViewStyleInfoEventArgs)

Applies event to ListControl.

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

The source control.
GridPrepareViewStyleInfoEventArgs e

The GridPrepareViewStyleInfoEventArgs that contains the event data.
Overrides

ListControlMouseUp(Object, MouseEventArgs)

Is called when the mouseup event is fired in list control

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

The source control.
System.Windows.Forms.MouseEventArgs e

The System.ComponentModel.MouseEventArgs that contains the event data.
Overrides

OnButtonClicked(Int32, Int32, Int32)

Is triggered when the button is clicked.

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

Row index of a cell.
System.Int32 colIndex

Column index of a cell.
System.Int32 button

Index of a button in cell.
Overrides

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

It is triggered when the cell is drawn

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

Cell rectangle.
System.Int32 rowIndex

Row index of a cell.
System.Int32 colIndex

Column index of a cell.
GridStyleInfo style

Cell style.
Overrides

OnDrawCellButton(GridCellButton, Graphics, Int32, Int32, Boolean, GridStyleInfo)

When the cell button is drawn.

Declaration
protected override void OnDrawCellButton(GridCellButton button, Graphics g, int rowIndex, int colIndex, bool bActive, GridStyleInfo style)
Parameters
Type Name Description
GridCellButton button

Grid cell button.
System.Drawing.Graphics g

Graphics of a cell.
System.Int32 rowIndex

Row index of a cell.
System.Int32 colIndex

Column index of a cell.
System.Boolean bActive

Indicates whether cell is in active state.
GridStyleInfo style

Cell style.
Overrides

OnInitialize(Int32, Int32)

Is executed when the program starts.

Declaration
protected override void OnInitialize(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

OnKeyDown(KeyEventArgs)

Is triggered when the key is pressed in keyboard.

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

The System.Windows.Forms.KeyPressEventArgs that contains the event data.
Overrides

OnKeyPress(KeyPressEventArgs)

Is triggered when the key is pressed down.

Declaration
protected override void OnKeyPress(KeyPressEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyPressEventArgs e

The System.Windows.Forms.KeyPressEventArgs that contains the event data.
Overrides

OnKeyUp(KeyEventArgs)

Is triggered when the key is released in keyboard.

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

The System.Windows.Forms.KeyPressEventArgs that contains the event data.
Overrides

OnMouseHoverEnter(Int32, Int32)

Is triggered when the mouse enters a particular area.

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

OnMouseHoverLeave(Int32, Int32, EventArgs)

Is triggered when the mouse leaves a particular area.

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

OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)

Occurs when OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs) event is called for this cell.

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

The GridPrepareViewStyleInfoEventArgs that contains the event data.
Overrides

OnShowDropDown()

Is triggered when the dropdown is clicked.

Declaration
protected override void OnShowDropDown()
Overrides

ProcessKeyEventArgs(ref Message)

Is triggered when the process key is pressed.

Declaration
protected override bool ProcessKeyEventArgs(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m

A message.
Returns
Type Description
System.Boolean

True if key stroke is processed otherwise false.
Overrides

SetLogicalCompareOperatorImage(Object, String)

Sets the default compare operator image in FilterButton explicitly.

Declaration
public void SetLogicalCompareOperatorImage(object key, string value)
Parameters
Type Name Description
System.Object key

Unique ColumnGroupId.
System.String value

Logical operator to be used for comparison.

UnwireModel(GridCellModelBase)

Unwire the grid from filter

Declaration
protected override void UnwireModel(GridCellModelBase cellModel)
Parameters
Type Name Description
GridCellModelBase cellModel

The GridCellModelBase.
Overrides

WireModel(GridCellModelBase)

Wires the filter to the grid

Declaration
protected override void WireModel(GridCellModelBase cellModel)
Parameters
Type Name Description
GridCellModelBase cellModel

The GridCellModelBase.
Overrides

Implements

System.IDisposable