Back to Devexpress

LayoutView.CustomDrawCardFieldValue Event

windowsforms-devexpress-dot-xtragrid-dot-views-dot-layout-dot-layoutview-b0aa9288.md

latest6.3 KB
Original Source

LayoutView.CustomDrawCardFieldValue Event

Enables you to custom paint card field value cells

Namespace : DevExpress.XtraGrid.Views.Layout

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

csharp
[DXCategory("CustomDraw")]
public event RowCellCustomDrawEventHandler CustomDrawCardFieldValue
vb
<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:

PropertyDescription
AppearanceGets the painted element’s appearance settings. Inherited from CustomDrawEventArgs.
BoundsReturns a value specifying limits for the drawing area. Inherited from CustomDrawEventArgs.
CacheProvides methods to paint on drawing surfaces in GDI+ and DirectX modes. See DirectX hardware acceleration to learn more. Inherited from CustomDrawEventArgs.
CellProvides information on the painted cell.
CellValueGets the painted value or display text (depending on the event).
ColumnGets the column whose element is being painted.
DisplayTextGets or sets the painted element’s display text.
GraphicsA GDI+ drawing surface. Use the CustomDrawEventArgs.Cache property instead if you enable the DirectX hardware acceleration. Inherited from CustomDrawEventArgs.
HandledGets or sets a value specifying whether an event was handled and that the default element painting is therefore not required. Inherited from CustomDrawEventArgs.
RowHandleGets the handle of a painted element’s row.

The event data class exposes the following methods:

MethodDescription
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. See the Custom Painting Basics and Custom Painting Scenarios topics for information on using custom draw events.

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.

See Also

FieldValue

Custom Painting

LayoutView Class

LayoutView Members

DevExpress.XtraGrid.Views.Layout Namespace