Class GridDrawCellDisplayTextEventArgs

Provides the data for the DrawCellDisplayText event which occurs for every cell before the grid draws the display text for the specified cell.

Inheritance
System.Object
SyncfusionCancelEventArgs
GridDrawCellDisplayTextEventArgs
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public sealed class GridDrawCellDisplayTextEventArgs : SyncfusionCancelEventArgs

Constructors

GridDrawCellDisplayTextEventArgs(Graphics, String, Rectangle, GridStyleInfo)

Initializes the new instances for the GridDrawCellDisplayTextEventArgs class.

Declaration
public GridDrawCellDisplayTextEventArgs(Graphics g, string displayText, Rectangle textRectangle, GridStyleInfo style)
Parameters
Type Name Description
System.Drawing.Graphics g

Points to the device context.
System.String displayText

The display text.
System.Drawing.Rectangle textRectangle

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

A reference to the style object of the cell.

GridDrawCellDisplayTextEventArgs(Graphics, String, Rectangle, GridStyleInfo, Boolean)

Initializes the new instances for the GridDrawCellDisplayTextEventArgs class.

Declaration
public GridDrawCellDisplayTextEventArgs(Graphics g, string displayText, Rectangle textRectangle, GridStyleInfo style, bool useTextRenderer)
Parameters
Type Name Description
System.Drawing.Graphics g

Points to the device context.
System.String displayText

The display text.
System.Drawing.Rectangle textRectangle

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

A reference to the style object of the cell.
System.Boolean useTextRenderer

is need to use text renderer

Properties

ClipBounds

Gets the clipping bounds

Declaration
public Rectangle ClipBounds { get; }
Property Value
Type Description
System.Drawing.Rectangle

ColIndex

Gets the column index

Declaration
public int ColIndex { get; }
Property Value
Type Description
System.Int32

DisplayText

Gets or sets the display text.

Declaration
[TraceProperty(true)]
public string DisplayText { get; set; }
Property Value
Type Description
System.String

Graphics

Gets or sets points to the device context.

Declaration
[TraceProperty(true)]
public Graphics Graphics { get; set; }
Property Value
Type Description
System.Drawing.Graphics

RowIndex

Gets the row index

Declaration
public int RowIndex { get; }
Property Value
Type Description
System.Int32

Style

Gets or sets a reference to the style object of the cell.

Declaration
[TraceProperty(true)]
public GridStyleInfo Style { get; set; }
Property Value
Type Description
GridStyleInfo

TextRectangle

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

Declaration
[TraceProperty(true)]
public Rectangle TextRectangle { get; set; }
Property Value
Type Description
System.Drawing.Rectangle

UseTextRenderer

Gets or sets a value indicating whether to use TextRenderer for header rendering or use default graphics for renderering. set "True" to use TextRenderer, else default rendering will take place. TextRenderer can be used to avoid TextSpacing issue if you face any in the header text.

Declaration
public bool UseTextRenderer { get; set; }
Property Value
Type Description
System.Boolean