TileCustomDrawEventArgs.ShouldDrawBackground Property

Gets whether the tile should display a background.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public virtual bool ShouldDrawBackground { get; }

VB.NET

Public Overridable ReadOnly Property ShouldDrawBackground As Boolean

Property Value

Type	Description
Boolean	true if the tile should display a background; otherwise, false.

Remarks

When the ShouldDrawBackground property returns true, you can draw your custom background or use the e.DrawBackground method to draw the default background.

The following code snippet demonstrates the default drawing algorithm:

C#

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.NET

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