Click or drag to resize

ObjectToDescriptionConverter Class

Takes an object and returns the description taken from it's DescriptionAttribute
Inheritance Hierarchy
SystemObject
  TomsToolbox.Wpf.ConvertersValueConverter
    TomsToolbox.Wpf.ConvertersObjectToAttributeConverterDescriptionAttribute
      TomsToolbox.Wpf.ConvertersObjectToDescriptionConverter

Namespace:  TomsToolbox.Wpf.Converters
Assembly:  TomsToolbox.Wpf (in TomsToolbox.Wpf.dll) Version: 1.0.64.0 (1.0.64.0)
Syntax
[ValueConversionAttribute(typeof(Object), typeof(string))]
public class ObjectToDescriptionConverter : ObjectToAttributeConverter<DescriptionAttribute>

The ObjectToDescriptionConverter type exposes the following members.

Constructors
  NameDescription
Public methodObjectToDescriptionConverter
Initializes a new instance of the ObjectToDescriptionConverter class
Top
Properties
  NameDescription
Public propertyConvertBackErrorValue
Gets or sets the error value, which is returned whenever the value to convert back produces an error; the default is UnsetValue.
(Inherited from ValueConverter.)
Public propertyConvertBackNullValue
Gets or sets the null value, which is returned whenever the value to convert back is null; the default is null.
(Inherited from ValueConverter.)
Public propertyConvertBackUnsetValue
Gets or sets the unset value, which is returned whenever the value to convert back is UnsetValue; the default is UnsetValue.
(Inherited from ValueConverter.)
Public propertyConvertErrorValue
Gets or sets the error value, which is returned whenever the value to convert produces an error; the default is UnsetValue.
(Inherited from ValueConverter.)
Public propertyConvertNullValue
Gets or sets the null value, which is returned whenever the value to convert is null; the default is null.
(Inherited from ValueConverter.)
Public propertyConvertUnsetValue
Gets or sets the unset value, which is returned whenever the value to convert is UnsetValue; the default is UnsetValue.
(Inherited from ValueConverter.)
Top
Methods
Fields
  NameDescription
Public fieldStatic memberDefault
The singleton instance of the converter.
Top
Extension Methods
Remarks
Works with any object; for enum types the attribute of the field is returned.
Examples
C#
enum Items
{
    [Description("This is item 1")]
    Item1,
    [Description("This is item 2")]
    Item2
}

Assert.Equals("This is item 1", ObjectToDescriptionConverter.Convert(Items.Item1));
See Also