Show a custom tooltip for an enumeration value at design time?

Question

0.00/5 (No votes)

See more:

In a DLL I have the following enumeration.

C#

/// <summary>
/// 
/// </summary>
public enum Shapes
{
  /// <summary>
  /// 
  /// </summary>
  [DescriptionAttribute("A shape with 1 continuous edge that has no corners.")]
  Circle,

  /// <summary>
  /// 
  /// </summary>
  [DescriptionAttribute("A shape 4 equal sides with 4 90° corners.")]
  Square,

  /// <summary>
  /// 
  /// </summary>
  [DescriptionAttribute("A shape 2 pairs of sides that are unequal with 4 90° corners.")]
  Rectangle,
}

How do I get the DescriptionAttribute text to appear in the tooltip instead of the Shape.Circle = 0 at design time within VS?

Thanks

What I have tried:

I haven't found any solutions online yet.

Posted 26-Feb-18 6:10am

-Dr_X-

Updated 26-Feb-18 7:13am

v2

Add a Solution

Comments

Richard Deeming 26-Feb-18 12:16pm

Try putting the description in the XML doc comments.

/// <summary>
/// A shape with 1 continuous edge that has no corners.
/// </summary>
[DescriptionAttribute("A shape with 1 continuous edge that has no corners.")]
Circle,

2 solutions

Solution 2

After compiling at least a half dozen times, the XML summary tag is finally appearing with the tooltip.

Thanks,

/// <summary>
///
/// </summary>
public enum Shapes
{
  /// <summary>
  /// "A shape with a continuous edge and has no corners."
  /// </summary>
  [DescriptionAttribute("A shape with a continuous edge and has no corners.")]
  //[EnumToClass(typeof(Circle))]
  Circle,

  /// <summary>
  /// "A shape 4 equal side with 4 90° corners."
  /// </summary>
  [DescriptionAttribute("A shape 4 equal side with 4 90° corners.")]
  //[EnumToClass(typeof(Square))]
  Square,

  /// <summary>
  /// "A shape 2 pairs of side that are unequal with 4 90° corners."
  /// </summary>
  [DescriptionAttribute("A shape 2 pairs of side that are unequal with 4 90° corners.")]
  //[EnumToClass(typeof(Rectangle))]
  Rectangle,
}

Outlaw, I'll give you the answer to you.

Posted 26-Feb-18 7:13am

-Dr_X-

Comments

#realJSOP 26-Feb-18 13:21pm

I bet it started showing up after you performed a clean/build all action.

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

#realJSOP · Accepted Answer · 2018-02-26T06:24:00

You didn't specify the platform (WinForms, WPF, or MVC)...

At first blush, I would create a list of Shape objects:

C#

public class MyShape
{
    public ShapeEnum Value { get; set; }
    public string Name { get { return this.Value.ToString(); } }
    public string Description {get; set; }
}

public ListOfShapes:List<MyShape>{}

And then instantiate it in a static class:

C#

public static Globals
{
    public static ListOfShapes Shapes = null;
    static Globals()
    {
        Shapes = new ListOfShapes(){ new MyShape(){Value=ShapeEnum.Circle, Description = "circle description"},...};
    }
}

Bind your control to that list.