Provides a description for an enumerated type. : Enum « Data Types « C# / C Sharp

1. C# / C Sharp
2. Data Types
3. Enum

Provides a description for an enumerated type.

        

/**********************************************************************
 * Copyright (c) 2008, j. montgomery                                  *
 * All rights reserved.                                               *
 *                                                                    *
 * Redistribution and use in source and binary forms, with or without *
 * modification, are permitted provided that the following conditions *
 * are met:                                                           *
 *                                                                    *
 * + Redistributions of source code must retain the above copyright   *
 *   notice, this list of conditions and the following disclaimer.    *
 *                                                                    *
 * + Redistributions in binary form must reproduce the above copyright*
 *   notice, this list of conditions and the following disclaimer     *
 *   in the documentation and/or other materials provided with the    *
 *   distribution.                                                    *
 *                                                                    *
 * + Neither the name of j. montgomery's employer nor the names of    *
 *   its contributors may be used to endorse or promote products      *
 *   derived from this software without specific prior written        *
 *   permission.                                                      *
 *                                                                    *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS*
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT  *
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS  *
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE     *
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,*
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES           *
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR *
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) *
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,*
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)      *
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED*
 * OF THE POSSIBILITY OF SUCH DAMAGE.                                 *
 **********************************************************************/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace UpdateDnsOMatic.Utility
{
    /// <summary>
    /// Provides a description for an enumerated type.
    /// </summary>
    [AttributeUsage(AttributeTargets.Enum | AttributeTargets.Field, AllowMultiple = false)]
    public sealed class EnumDescriptionAttribute : Attribute
    {
        private string _description;
        private string _detailedDescription;
        /// <summary>
        /// Gets the description stored in this attribute.
        /// </summary>
        /// <value>The description stored in the attribute.</value>
        public string Description
        {
            get
            {
                return this._description;
            }
        }

        /// <summary>
        /// Gets the detailed description stored in this attribute.
        /// </summary>
        /// <value>The detailed description stored in the attribute.</value>
        public string DetailedDescription
        {
            get
            {
                return this._detailedDescription;
            }
        }
        /// <summary>
        /// Initializes a new instance of the 
        /// <see cref="EnumDescriptionAttribute"/> class.
        /// </summary>
        /// <param name="description">The description to store in this attribute.</param>
        public EnumDescriptionAttribute(string description)
            : base()
        {
            this._description = description;
            this._detailedDescription = string.Empty;
        }

        public EnumDescriptionAttribute(string description, string detailedDescription)
            : base()
        {
            this._description = description;
            this._detailedDescription = detailedDescription;
        }
    }
}

   
    
    
    
    
    
    
    
  

Related examples in the same category

1.	Enumerations:Initialization
2.	Enumerations Initialization 2
3.	Enumeration Base Types
4.	Enum declare and use it
5.	Demonstrate an enumeration
6.	Enum by IEnumerable
7.	Enum Values
8.	The use of an enumeration that defines the positions of the planets in the solar system relative to the Sun
9.	Illustrates the use of an enumeration that defines the orbital periods of the first four planets in days
10.	Illustrates the use of an enumeration that defines the orbital periods of the first four planets in days, using a base type of long
11.	how a derived class may override an existing enumeration in a base class
12.	A public enum in one class from another class
13.	Demonstrate an enumerator
14.	Demonstrate IDictionaryEnumerator
15.	Enumerators and Foreach
16.	Enumerations:Bit Flag Enums 1
17.	Enumerations:Bit Flag Enums 2
18.	Enumerations:The System.Enum Type
19.	Enumerations: The System.Enum Type 2
20.	Enum data type comparison
21.	Enum.IsDefined()
22.	Get all stats for EmpType.
23.	Enum Parse
24.	Get Enum's type, hex and value.
25.	Enum.Format()
26.	Get underlying type
27.	switch statement with Enum and call its ToString function
28.	Format enum value
29.	Wrap an enumerable so that clients can't get to the underlying implementation via a down-case
30.	Try to parse Enum
31.	Enum To Array
32.	Get Enum Description
33.	Convert all Enum value to a List
34.	Get all values from an Enum type
35.	Get Enum Values
36.	Fill all enum value to a List
37.	Retrieves the enum field associated with the specified value. A return value indicates whether the conversion succeeded.
38.	Get Description