CustomItemDescriptionAttribute Class

Specifies tooltip text that is displayed for a custom item’s bar in the Ribbon.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[AttributeUsage(AttributeTargets.Class)]
public class CustomItemDescriptionAttribute :
    Attribute

VB.NET

<AttributeUsage(AttributeTargets.Class)>
Public Class CustomItemDescriptionAttribute
    Inherits Attribute

Remarks

You can apply CustomItemDescriptionAttribute to a CustomItemMetadata object when you create metadata for a custom dashboard item. The attribute specifies the tooltip text that is displayed for a custom item’s bar in the Ribbon.

The following code snippet specifies tooltip text for CustomFunnelMetadata:

C#

using System.ComponentModel;
using DevExpress.DashboardCommon;

namespace CustomItemsSample {
  [DisplayName("Funnel"),
  CustomItemDescription("Funnel description"),
  CustomItemImage("CustomItemsSample.Images.Funnel.svg")]
  public class CustomFunnelMetadata : CustomItemMetadata{
     [DisplayName("Value"),
      EmptyDataItemPlaceholder("Value"),
      SupportColoring(DefaultColoringMode.Hue)]
      public Measure Value {
          get { return GetPropertyValue<Measure>(); }
          set { SetPropertyValue(value); }
      }
      [DisplayName("Arguments"),
      EmptyDataItemPlaceholder("Argument"),
      SupportColoring(DefaultColoringMode.Hue),
      SupportInteractivity]
      public DimensionCollection Arguments { get; } = new DimensionCollection();
  }
}

VB.NET

Imports System.ComponentModel
Imports DevExpress.DashboardCommon

Namespace CustomItemsSample
  <DisplayName("Funnel"), CustomItemDescription("Funnel description"), CustomItemImage("Funnel.svg")>
  Public Class CustomFunnelMetadata
      Inherits CustomItemMetadata
      <DisplayName("Value"), EmptyDataItemPlaceholder("Value"), SupportColoring(DefaultColoringMode.Hue)>
      Public Property Value() As Measure
          Get
              Return GetPropertyValue(Of Measure)()
          End Get
          Set(ByVal value As Measure)
              SetPropertyValue(value)
          End Set
      End Property
      <DisplayName("Arguments"), EmptyDataItemPlaceholder("Argument"), SupportColoring(DefaultColoringMode.Hue), SupportInteractivity>
      Public ReadOnly Property Arguments() As New DimensionCollection()
  End Class
End Namespace

Inheritance

Object

Attribute

CustomItemDescriptionAttribute