CustomDrawNavBarElementEventArgs.Caption Property

Gets or sets the caption of the painted element.

Namespace: DevExpress.XtraNavBar.ViewInfo

Assembly: DevExpress.XtraNavBar.v18.2.dll

Declaration

C#

public string Caption { get; set; }

VB.NET

Public Property Caption As String

Property Value

Type	Description
String	A string value specifying the painted element’s caption.

Remarks

Read the Caption property to obtain the painted element’s caption. Use the obtained string to draw an element caption in a desired manner. Note that you can also assign a value to this property. The assigned value will be displayed as an element caption only if the CustomDrawObjectEventArgs.Handled property is not set to true within an event handler. Assigning a value to the Caption property doesn’t affect the NavElement.Caption property of the painted element.

Related GitHub Examples

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

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.

C#

how-to-implement-the-quick-search-feature-for-the-navbarcontrol-e5220/CS/WindowsFormsApplication72/SearchHelper.cs#L51

{
    if (e.Caption == "Search")
    {

how-to-custom-paint-navbar-links-e4128/CS/NavBarSample/Form1.cs#L42

}
e.Appearance.DrawString(e.Cache, e.Caption, linkInfo.RealCaptionRectangle, Brushes.White);
e.Handled = true;

how-to-manually-draw-navbarcontrols-links-e1050/CS/CustomDrawLinkSample/Form1.cs#L19

private void navBarControl1_CustomDrawLink(object sender, CustomDrawNavBarElementEventArgs e) {
    SizeF textSize = e.Cache.CalcTextSize(e.Caption, e.Appearance.Font, StringFormat.GenericDefault, e.RealBounds.Width);
    NavLinkInfoArgs args = (NavLinkInfoArgs)e.ObjectInfo;

VB.NET

how-to-implement-the-quick-search-feature-for-the-navbarcontrol-e5220/VB/WindowsFormsApplication72/SearchHelper.vb#L49

Private Shared Sub navBarControl_CustomDrawGroupCaption(ByVal sender As Object, ByVal e As DevExpress.XtraNavBar.ViewInfo.CustomDrawNavBarElementEventArgs)
    If e.Caption = "Search" Then
        Dim rect As Rectangle = e.RealBounds

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

End If
e.Appearance.DrawString(e.Cache, e.Caption, linkInfo.RealCaptionRectangle, Brushes.White)
e.Handled = True

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

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)
    Dim args As NavLinkInfoArgs = CType(e.ObjectInfo, NavLinkInfoArgs)