Back to Devexpress

TileCustomDrawEventArgs.ShouldDrawCheckMark Property

windowsforms-devexpress-dot-xtraeditors-dot-tilecustomdraweventargs-966534aa.md

latest3.5 KB
Original Source

TileCustomDrawEventArgs.ShouldDrawCheckMark Property

Gets whether the tile should display a check mark.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
public virtual bool ShouldDrawCheckMark { get; }
vb
Public Overridable ReadOnly Property ShouldDrawCheckMark As Boolean

Property Value

TypeDescription
Boolean

true if the tile should display a check mark; otherwise, false.

|

Remarks

When the ShouldDrawCheckMark property returns true, you can draw your custom check mark or use the e.DrawCheckMark method to draw the default check mark.

The following code snippet demonstrates the default drawing algorithm:

csharp
void tileView1_CustomDrawTile(object sender, TileViewItemCustomDrawEventArgs e) {
    switch (e.DrawingProcess) {
        case TileViewItemCustomDrawProcess.DrawTile:
            if (e.ShouldDrawBackground)
                e.DrawBackground();
            if (e.ShouldDrawContent)
                e.DrawContent();
            if (e.ShouldDrawHoveredOverlay)
                e.DrawHoveredOverlay();
            if (e.ShouldDrawDisabledOverlay)
                e.DrawDisabledOverlay();
            if (e.ShouldDrawBorder)
                e.DrawBorder();
            if (e.ShouldDrawCheckMark)
                e.DrawCheckMark();
            break;
        case TileViewItemCustomDrawProcess.DrawCheckMark:
            e.DefaultDraw();
            break;
        case TileViewItemCustomDrawProcess.DrawSelection:
            e.DefaultDraw();
            break;
    }
    e.Handled = true;
}
vb
Private Sub tileView1_CustomDrawTile(ByVal sender As Object, ByVal e As TileViewItemCustomDrawEventArgs)
    Select Case e.DrawingProcess
        Case TileViewItemCustomDrawProcess.DrawTile
            If e.ShouldDrawBackground Then e.DrawBackground()
            If e.ShouldDrawContent Then e.DrawContent()
            If e.ShouldDrawHoveredOverlay Then e.DrawHoveredOverlay()
            If e.ShouldDrawDisabledOverlay Then e.DrawDisabledOverlay()
            If e.ShouldDrawBorder Then e.DrawBorder()
            If e.ShouldDrawCheckMark Then e.DrawCheckMark()
        Case TileViewItemCustomDrawProcess.DrawCheckMark
            e.DefaultDraw()
        Case TileViewItemCustomDrawProcess.DrawSelection
            e.DefaultDraw()
    End Select

    e.Handled = True
End Sub

See Also

TileCustomDrawEventArgs Class

TileCustomDrawEventArgs Members

DevExpress.XtraEditors Namespace