Class PivotGridSortColumnHeaderCellRenderer

Implements the class for the renderer part of the sorted column header of the PivotGrid.

Inheritance
System.Object
NonFinalizeDisposable
GridCellRendererBase
GridStaticCellRenderer
GridHeaderCellRenderer
PivotGridSortColumnHeaderCellRenderer
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.Windows.Forms.PivotAnalysis
Assembly: Syncfusion.PivotAnalysis.Windows.dll
Syntax
public class PivotGridSortColumnHeaderCellRenderer : GridHeaderCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposable

Constructors

PivotGridSortColumnHeaderCellRenderer(GridControlBase, GridCellModelBase)

Initializes a new instance of the PivotGridSortColumnHeaderCellRenderer class with the specified GridControlBase and GridCellModelBase.

Declaration
public PivotGridSortColumnHeaderCellRenderer(GridControlBase gridControlBase, GridCellModelBase cellModel)
Parameters
Type Name Description
GridControlBase gridControlBase

The instance of GridControlBase class.
GridCellModelBase cellModel

The instance of GridCellModelBase class.

Methods

OnButtonClicked(Int32, Int32, Int32)

Called when the user clicks on a button inside the cell.

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

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
System.Int32 button

The button that is clicked.
Overrides

OnClick(Int32, Int32, MouseEventArgs)

Overrides and triggers the click event.

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

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
System.Windows.Forms.MouseEventArgs e

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

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

Draws the contents of the client bounds for the cell, e.g. the text for a static cell.

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

Points to the device context.
System.Drawing.Rectangle clientRectangle

Specifies the client rectangle without buttons and borders.
System.Int32 rowIndex

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
GridStyleInfo style

The GridStyleInfo object that holds the style information for the cell.
Overrides

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

Overrides and triggers to draw the cell buttons.

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

Used in the cell renderer.
System.Drawing.Graphics g

GDI+ surfaces.
System.Int32 rowIndex

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
System.Boolean bActive

Represents the boolean value.
GridStyleInfo style

Style object that holds the values of style properties.
Overrides

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

Overrides and draws the display text.

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

The graphics object.
System.Drawing.Rectangle textRectangle

The rectangle bounds of the display text.
System.Int32 rowIndex

The row index.
System.Int32 colIndex

The column index.
GridStyleInfo style

Style object that holds the values of style properties.
Overrides

OnGetCursor(Int32, Int32)

Overrides and triggers to get cursor.

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

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
Returns
Type Description
System.Windows.Forms.Cursor

Cursor.
Overrides

OnLayout(Int32, Int32, GridStyleInfo, Rectangle, Rectangle[])

Overrides and triggers the OnLayout() method.

Declaration
protected override Rectangle OnLayout(int rowIndex, int colIndex, GridStyleInfo style, Rectangle innerBounds, Rectangle[] buttonsBounds)
Parameters
Type Name Description
System.Int32 rowIndex

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
GridStyleInfo style

Style object that holds the values of style properties.
System.Drawing.Rectangle innerBounds

Represents the inner bounds of the rectangle.
System.Drawing.Rectangle[] buttonsBounds

Represents the bounds of the cell button.
Returns
Type Description
System.Drawing.Rectangle

Inner bounds of the rectangle.
Overrides

OnMouseDown(Int32, Int32, MouseEventArgs)

Overrides and triggers the mouse down event.

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

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
System.Windows.Forms.MouseEventArgs e

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

OnMouseHover(Int32, Int32, MouseEventArgs)

Overrides and triggers the mouse hover event.

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

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
System.Windows.Forms.MouseEventArgs e

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

OnMouseHoverLeave(Int32, Int32, EventArgs)

Overrides and triggers the Mouse hover leave event.

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

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
System.EventArgs e

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

OnMouseUp(Int32, Int32, MouseEventArgs)

Overrides and triggers the mouse up event.

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

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.
System.Windows.Forms.MouseEventArgs e

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

OnPrepareViewStyleInfo(GridPrepareViewStyleInfoEventArgs)

Raises when the PrepareViewStyleInfo event occurs.

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

The GridPrepareViewStyleInfoEventArgs that contains the event data.
Overrides

OnPushButtonClick(Int32, Int32)

Raises PushButtonClick event when the user presses the push button.

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

The row index of the current cell.
System.Int32 colIndex

The column index of the current cell.

Implements

System.IDisposable