Skip to main content
All docs
V21.2

CustomItemDescriptionAttribute Class

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

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v21.2.Core.dll

Declaration

[AttributeUsage(AttributeTargets.Class)]
public class CustomItemDescriptionAttribute :
    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:

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();
  }
}

Inheritance

Object
Attribute
CustomItemDescriptionAttribute
See Also