Class GridExcelFilterCellRenderer

Implements the renderer part of an optimized ExcelFilterCell.

Inheritance
System.Object
NonFinalizeDisposable
GridCellRendererBase
GridStaticCellRenderer
GridHeaderCellRenderer
GridExcelFilterCellRenderer
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 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

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

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

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

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

Implements

System.IDisposable

Extension Methods