NavBarControl.CustomDrawLink Event

Provides the ability to perform custom painting of links.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v18.1.dll

Declaration

C#

public event CustomDrawNavBarElementEventHandler CustomDrawLink

VB.NET

Public Event CustomDrawLink As CustomDrawNavBarElementEventHandler

Event Data

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

Property	Description
Appearance	Gets the painted element’s appearance settings. Inherited from CustomDrawObjectEventArgs.
Cache	Gets an object which specifies the storage for the most used pens, fonts and brushes. Inherited from CustomDrawObjectEventArgs.
Caption	Gets or sets the caption of the painted element.
Graphics	Gets an object used to paint the object. Inherited from CustomDrawObjectEventArgs.
Handled	Gets or sets a value specifying whether the control must perform default painting after an event handler has been executed. Inherited from CustomDrawObjectEventArgs.
Image	Gets or sets the image displayed within the painted element.
ObjectInfo	Gets an object providing information on the element being painted. Inherited from CustomDrawObjectEventArgs.
RealBounds	Gets the bounding rectangle of the painted object. Inherited from CustomDrawObjectEventArgs.

Remarks

Write a CustomDrawLink event handler to perform custom painting of links. Set the CustomDrawObjectEventArgs.Handled property of the event parameter to true to disable default painting. Other properties of the event parameter allow you to identify the link being painted and provide all necessary information to paint.

Note

The control’s events designed to change the appearance or rendering of control elements must not be used to update cell values or to modify the control’s layout. Any inappropriate operation which causes a layout update, may break the normal control behavior.

Example

The following sample code handles the NavBarControl.CustomDrawLink event to custom paint links. Links are painted differently in the hot tracked and pressed states.

The image below shows a custom painted hot tracked link:

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-custom-paint-navbar-links-e4128

Form1.cs

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Drawing.Drawing2D;
using DevExpress.XtraNavBar.ViewInfo;
using DevExpress.XtraNavBar;
using DevExpress.Utils.Drawing;

namespace NavBarSample {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void navBarControl1_CustomDrawLink(object sender, DevExpress.XtraNavBar.ViewInfo.CustomDrawNavBarElementEventArgs e) {
            if (e.ObjectInfo.State == ObjectState.Hot || e.ObjectInfo.State == ObjectState.Pressed) {
                LinearGradientBrush brush;
                NavLinkInfoArgs linkInfo = e.ObjectInfo as NavLinkInfoArgs;
                if (e.ObjectInfo.State == ObjectState.Hot) {
                    brush = new LinearGradientBrush(e.RealBounds, Color.Orange, Color.PeachPuff,
                        LinearGradientMode.Horizontal);
                }
                else
                    brush = new LinearGradientBrush(e.RealBounds, Color.PeachPuff, Color.Orange,
                        LinearGradientMode.Horizontal);
                e.Graphics.FillRectangle(Brushes.OrangeRed, e.RealBounds);
                Rectangle rect = e.RealBounds;
                rect.Inflate(-1, -1);
                e.Graphics.FillRectangle(brush, rect);
                if (e.Image != null) {
                    Rectangle imageRect = linkInfo.ImageRectangle;
                    imageRect.X += (imageRect.Width - e.Image.Width) / 2;
                    imageRect.Y += (imageRect.Height - e.Image.Height) / 2;
                    imageRect.Size = e.Image.Size;
                    e.Graphics.DrawImageUnscaled(e.Image, imageRect);
                }
                e.Appearance.DrawString(e.Cache, e.Caption, linkInfo.RealCaptionRectangle, Brushes.White);
                e.Handled = true;
            }
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.ComponentModel
Imports System.Data
Imports System.Drawing
Imports System.Linq
Imports System.Text
Imports System.Windows.Forms
Imports System.Drawing.Drawing2D
Imports DevExpress.XtraNavBar.ViewInfo
Imports DevExpress.XtraNavBar
Imports DevExpress.Utils.Drawing

Namespace NavBarSample
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub navBarControl1_CustomDrawLink(ByVal sender As Object, ByVal e As DevExpress.XtraNavBar.ViewInfo.CustomDrawNavBarElementEventArgs) Handles navBarControl1.CustomDrawLink
            If e.ObjectInfo.State = ObjectState.Hot OrElse e.ObjectInfo.State = ObjectState.Pressed Then
                Dim brush As LinearGradientBrush
                Dim linkInfo As NavLinkInfoArgs = TryCast(e.ObjectInfo, NavLinkInfoArgs)
                If e.ObjectInfo.State = ObjectState.Hot Then
                    brush = New LinearGradientBrush(e.RealBounds, Color.Orange, Color.PeachPuff, LinearGradientMode.Horizontal)
                Else
                    brush = New LinearGradientBrush(e.RealBounds, Color.PeachPuff, Color.Orange, LinearGradientMode.Horizontal)
                End If
                e.Graphics.FillRectangle(Brushes.OrangeRed, e.RealBounds)
                Dim rect As Rectangle = e.RealBounds
                rect.Inflate(-1, -1)
                e.Graphics.FillRectangle(brush, rect)
                If e.Image IsNot Nothing Then
                    Dim imageRect As Rectangle = linkInfo.ImageRectangle
                    imageRect.X += (imageRect.Width - e.Image.Width) / 2
                    imageRect.Y += (imageRect.Height - e.Image.Height) / 2
                    imageRect.Size = e.Image.Size
                    e.Graphics.DrawImageUnscaled(e.Image, imageRect)
                End If
                e.Appearance.DrawString(e.Cache, e.Caption, linkInfo.RealCaptionRectangle, Brushes.White)
                e.Handled = True
            End If
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomDrawLink event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

how-to-custom-paint-navbar-links-e4128/VB/NavBarSample/Form1.vb#L22

Private Sub navBarControl1_CustomDrawLink(ByVal sender As Object, ByVal e As DevExpress.XtraNavBar.ViewInfo.CustomDrawNavBarElementEventArgs) Handles navBarControl1.CustomDrawLink
    If e.ObjectInfo.State = ObjectState.Hot OrElse e.ObjectInfo.State = ObjectState.Pressed Then

how-to-create-a-navbarcontrol-descendant-that-will-implement-keyboard-navigation-e893/VB/WindowsApplication1/Form1.vb#L321

Private Sub navBarControl1_CustomDrawLink(ByVal sender As Object, ByVal e As DevExpress.XtraNavBar.ViewInfo.CustomDrawNavBarElementEventArgs) Handles navBarControl1.CustomDrawLink
    Dim args As NavLinkInfoArgs = TryCast(e.ObjectInfo, NavLinkInfoArgs)

how-to-manually-draw-navbarcontrols-links-e1050/VB/CustomDrawLinkSample/Form1.vb#L20

Private Sub navBarControl1_CustomDrawLink(ByVal sender As Object, ByVal e As CustomDrawNavBarElementEventArgs) Handles navBarControl1.CustomDrawLink
    Dim textSize As SizeF = e.Cache.CalcTextSize(e.Caption, e.Appearance.Font, StringFormat.GenericDefault, e.RealBounds.Width)

C#

how-to-create-a-navbarcontrol-descendant-that-will-implement-keyboard-navigation-e893/CS/WindowsApplication1/Form1.cs#L160

this.navBarControl1.Text = "navBarControl1";
this.navBarControl1.CustomDrawLink += new DevExpress.XtraNavBar.ViewInfo.CustomDrawNavBarElementEventHandler(this.navBarControl1_CustomDrawLink);
//