WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridSortColumnHeaderCellRenderer - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridSortColumnHeaderCellRenderer

    Implements the renderer part of a column header with sort indicator.

    Inheritance
    System.Object
    NonFinalizeDisposable
    GridCellRendererBase
    GridStaticCellRenderer
    GridHeaderCellRenderer
    GridSortColumnHeaderCellRenderer
    Implements
    IQueryFocusInside
    IGridDropDownCell
    IPopupParent
    IPopupItem
    System.IDisposable
    Inherited Members
    GridHeaderCellRenderer.WireGrid()
    GridHeaderCellRenderer.UnwireGrid()
    GridHeaderCellRenderer.Dispose(Boolean)
    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.OnMouseHoverLeave(Int32, Int32, EventArgs)
    GridHeaderCellRenderer.OnDraw(Graphics, Rectangle, Int32, Int32, GridStyleInfo)
    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.OnMouseHoverEnter(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.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.Windows.Forms.Grid
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public class GridSortColumnHeaderCellRenderer : GridHeaderCellRenderer, IQueryFocusInside, IGridDropDownCell, IPopupParent, IPopupItem, IDisposable
    Remarks

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

    The GridDataBoundGrid registers "ColumnHeaderCell" as identifier in CellType of a cell's GridStyleInfo to associate this cell type with a cell.

    The sort indicator is defined through the Tag of a cell's GridStyleInfo. The Tag will be cast to System.ComponentModel.ListSortDirection.

    A renderer is created for each GridCellModelBase and GridControlBase. There can be several renderers associated with one GridSortColumnHeaderCellModel if several views display the same GridModel.

    The following table lists some characteristics about the SortColumnHeader cell type:

    ItemDescription
    CellTypeSortColumnHeaderCell
    RendererGridSortColumnHeaderCellRenderer
    ModelGridSortColumnHeaderCellModel
    XP Themes SupportYes
    InteractiveClick Only
    Floating SupportNo
    Base TypeGridHeaderCellRenderer

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

    PropertyNameDescription
    BaseStyle (System.String)The base style for this style instance with default values for properties that are not initialized for this style object. (Default: String.Empty)
    Borders (GridBordersInfo)Top, left, bottom, and right border settings. (Default: GridBordersInfo.Default)
    CellAppearance (GridCellAppearance)When set to Flat, the header will be drawn with slightly raised edges typical for cell headers. If the grid is XP Themes enabled, the headers will be drawn with XP Themes look. If you specify Sunken or Raised, the header will be drawn with sunken or raised edges and not XP Themed. (Default: GridCellAppearance.Flat)
    CellTipText (System.String)ToolTip text to be displayed when user hovers mouse over cell. (Default: String.Empty)
    CellType (System.String)ColumnHeaderCell (Default: Text Box)
    CellValue (System.Object)If empty, the standard header text will be drawn as specified with the NumberedRowHeaders and NumberedColHeaders properties in GridModel. If CellValue is not NULL, the cell value will be displayed as header text. (Default: String.Empty)
    CellValueType (System.Type)Specifies the preferred System.Type for cell values. When you assign a value to the GridStyleInfo object, the value will be converted to this type. If the value cannot be converted, Error will contain error information. (Default: NULL)
    CultureInfo (System.Globalization.CultureInfo)The culture information holds rules for parsing and formatting the cell's value. (Default: NULL)
    Enabled (System.Boolean)Specifies if the header cell can be activated as current cell when the user clicks onto the header. Usually you do not want a header to be activated as current cell unless you want to have editing capabilities such as allowing user to rename header text in place. (You would have to implement a custom header cell for this.) (Default: True)
    Error (System.String)Holds error information if a value could not be converted to the System.Type specified with CellValueType. (Default: String.Empty)
    Font (GridFontInfo)The font for drawing text. (Default: GridFontInfo.Default)
    Format (System.String)Gets / sets the format mask for formatting the cell value. You can specify numeric format strings, date format strings, or enumeration format strings as discussed in the section "Format Specifiers and Format Providers" of the .NET Framework Developers Guide (see ms-help://MS.VSCC/MS.MSDNVS/cpguide/html/cpconformatspecifiersformatproviders.htm) (Default: String.Empty)
    HorizontalAlignment (GridHorizontalAlignment)Specifies horizontal alignment of text in the cell. (Default: GridHorizontalAlignment.Left)
    HotkeyPrefix (System.Drawing.Text.HotkeyPrefix)Specifies how hot-key prefixes should be displayed. Hot-keys are indicated in text with an '&' (ampersand). When you enable hot-key prefix, the specific characters can be displayed underlined or regular. The '&' will not be displayed. (Default: HotkeyPrefix.Show)
    ImageIndex (System.Int32)Specifies an index for an image in the ImageList of a GridStyleInfo instance. (Default: -1)
    ImageList (System.Windows.Forms.ImageList)The ImageList that holds a collection of images. Cells can choose images with the ImageIndex property in a GridStyleInfo instance. (Default: NULL)
    Interior (BrushInfo)Lets you specify a solid backcolor, gradient, or pattern style with both back and forecolor for a cell's background. If grid is XP Themes enabled, this color will be ignored and the header will be drawn with default XP Themes header background. (Default: SystemColors.Window)
    MergeCell (GridMergeCellDirection)Specifies merge behavior for an individual cell when merging cells' features have been enabled in a GridModel with MergeCellsMode. (Default: GridMergeCellDirection.None)
    Tag (System.Object)The sort indicator is defined through the Tag of a cell's GridStyleInfo. The Tag will be cast to System.ComponentModel.ListSortDirection. (Default: NULL)
    Text (System.String)If empty, the standard header text will be drawn as specified with the NumberedRowHeaders and NumberedColHeaders properties in GridModel. If CellValue is not NULL, the cell value will be displayed as header text. (Default: String.Empty)
    TextColor (System.Drawing.Color)Lets you specify the color for drawing the cell text. (Default: SystemColors.WindowText)
    TextMargins (GridMarginsInfo)Holds text margins in pixels. When drawing a cell, this specifies the empty area between the text rectangle and the client rectangle of the cell without borders and cell buttons. (Default: GridMarginsInfo.Default)
    Themed (System.Boolean)Specifies if cell should be drawn using Windows XP themes when ThemesEnabled has been set. (Default: True)
    Trimming (System.Drawing.StringTrimming)Indicates how text is trimmed when it exceeds the edges of the cell text rectangle. (Default: StringTrimming.Character)
    VerticalAlignment (GridVerticalAlignment)Specifies vertical alignment of text in the cell. (Default: GridVerticalAlignment.Top)
    WrapText (System.Boolean)Specifies if text should be wrapped when it does not fit into a single line. (Default: true)

    Constructors

    GridSortColumnHeaderCellRenderer(GridControlBase, GridCellModelBase)

    Initializes a new instance of GridSortColumnHeaderCellRenderer object for the givenGridControlBase and GridCellModelBase.

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

    The GridControlBase that displays this cell renderer.

    GridCellModelBase cellModel

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

    Remarks

    References to GridControlBase, and GridCellModelBase will be saved.

    Methods

    OnClick(Int32, Int32, MouseEventArgs)

    Overrides when user clicked inside a cell.

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

    The row index.

    System.Int32 colIndex

    The column index.

    System.Windows.Forms.MouseEventArgs e

    A System.Windows.Forms.MouseEventArgs with data about the mouse event.

    Overrides
    GridCellRendererBase.OnClick(Int32, Int32, MouseEventArgs)

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

    Overridden to draw the display text of header cell and draw the triangle.

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

    Points to the device context.

    System.Drawing.Rectangle textRectangle

    Specifies the text rectangle. It is the cell rectangle without buttons, borders, or text margins.

    System.Int32 rowIndex

    Specifies the row id.

    System.Int32 colIndex

    Specifies the column id.

    GridStyleInfo style

    A reference to the style object of the cell.

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

    Implements

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