CardView.CustomDrawCardFieldValue Event

Enables you to custom paint card field value cells.

Namespace : DevExpress.XtraGrid.Views.Card

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

[DXCategory("CustomDraw")]
public event RowCellCustomDrawEventHandler CustomDrawCardFieldValue

<DXCategory("CustomDraw")>
Public Event CustomDrawCardFieldValue As RowCellCustomDrawEventHandler

Event Data

The CustomDrawCardFieldValue event's data class is RowCellCustomDrawEventArgs. The following properties provide information specific to this event:

Property	Description
Appearance	Gets the painted element’s appearance settings. Inherited from CustomDrawEventArgs.
Bounds	Returns a value specifying limits for the drawing area. Inherited from CustomDrawEventArgs.
Cache	Provides methods to paint on drawing surfaces in GDI+ and DirectX modes. See DirectX hardware acceleration to learn more. Inherited from CustomDrawEventArgs.
Cell	Provides information on the painted cell.
CellValue	Gets the painted value or display text (depending on the event).
Column	Gets the column whose element is being painted.
DisplayText	Gets or sets the painted element’s display text.
Graphics	A GDI+ drawing surface. Use the CustomDrawEventArgs.Cache property instead if you enable the DirectX hardware acceleration. Inherited from CustomDrawEventArgs.
Handled	Gets or sets a value specifying whether an event was handled and that the default element painting is therefore not required. Inherited from CustomDrawEventArgs.
RowHandle	Gets the handle of a painted element’s row.

The event data class exposes the following methods:

Method	Description
DefaultDraw()	Performs default painting of an element. Inherited from CustomDrawEventArgs.
DrawHtml(HtmlTemplate, DxHtmlPainterContext, Action<DxHtmlPainterArgs>)	Paints the required HTML template inside an element that raised this event. The context parameter allows you to assign an object that transfers mouse events to template elements. Inherited from CustomDrawEventArgs.
DrawHtml(HtmlTemplate, Action<DxHtmlPainterArgs>)	Paints the required HTML template inside an element that raised this event. Inherited from CustomDrawEventArgs.

Remarks

The CustomDrawCardFieldValue event is raised before a cell is repainted. It enables you to paint the processed cell manually or to change its settings before it is painted by the default painting mechanism. See the Custom Painting Basics and Custom Painting Scenarios topics for information on using custom draw events.

Note

The CustomDrawCardFieldValue event is not raised if you handle the CardView.CustomDrawCardField event and set its CustomDrawEventArgs.Handled parameter to true.

Important

Do not change cell values, modify the control’s layout, or change the control’s object model in the events used for custom control painting. Actions that update the layout can cause the control to malfunction.

Example

The following example handles the CardView.CustomDrawCardFieldValue event to custom paint card field values in the Price column.

C#
VB.NET

csharp

private void cardView1_CustomDrawCardFieldValue(object sender, Views.Base.RowCellCustomDrawEventArgs e) {
    if (e.Column.FieldName != "Price") return;
    // The brush to fill the cell background.
    Color color1 = Color.FromArgb(40, 170, 225);
    Color color2 = Color.FromArgb(35, 80, 160);
    Brush brush = e.Cache.GetGradientBrush(e.Bounds, color1, color2, LinearGradientMode.Horizontal);
    e.Appearance.ForeColor = Color.White;
    e.Appearance.Font = e.Cache.GetFont(e.Appearance.Font, FontStyle.Bold);
    e.Cache.FillRectangle(brush, e.Bounds);
    e.Appearance.DrawString(e.Cache, e.DisplayText, e.Bounds);
    // Prevent default painting.
    e.Handled = true;
}

Private Sub CardView1_CustomDrawCardFieldValue(sender As Object, e As DevExpress.XtraGrid.Views.Base.RowCellCustomDrawEventArgs) Handles CardView1.CustomDrawCardFieldValue
    If e.Column.FieldName <> "Price" Then Return
    Dim color1 As Color = Color.FromArgb(40, 170, 225)
    Dim color2 As Color = Color.FromArgb(35, 80, 160)
    Dim brush As Brush = e.Cache.GetGradientBrush(e.Bounds, color1, color2, LinearGradientMode.Horizontal)
    e.Appearance.ForeColor = Color.White
    e.Appearance.Font = e.Cache.GetFont(e.Appearance.Font, FontStyle.Bold)
    e.Cache.FillRectangle(brush, e.Bounds)
    e.Appearance.DrawString(e.Cache, e.DisplayText, e.Bounds)
    e.Handled = True
End Sub