KGy SOFT

FlagsEnumConverter Class

KGy SOFT Core Libraries Help
By extending the EnumConverter, this class provides a type converter for flags Enum instances (not necessarily but typically marked by FlagsAttribute) by providing Boolean properties for each flags in the specific Enum type.
Inheritance Hierarchy

SystemObject
  System.ComponentModelTypeConverter
    System.ComponentModelEnumConverter
      KGySoft.ComponentModelFlagsEnumConverter

Namespace:  KGySoft.ComponentModel
Assembly:  KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 5.0.0-rc.1
Syntax

public class FlagsEnumConverter : EnumConverter

The FlagsEnumConverter type exposes the following members.

Constructors

  NameDescription
Public methodFlagsEnumConverter
Creates an instance of the FlagsEnumConverter class.
Top
Properties

  NameDescription
Protected propertyComparer
Gets an IComparer that can be used to sort the values of the enumeration.
(Inherited from EnumConverter.)
Protected propertyEnumType
Specifies the type of the enumerator this converter is associated with.
(Inherited from EnumConverter.)
Protected propertyValues (Inherited from EnumConverter.)
Top
Methods

  NameDescription
Public methodCanConvertFrom(Type)
Returns whether this converter can convert an object of the given type to the type of this converter.
(Inherited from TypeConverter.)
Public methodCanConvertFrom(ITypeDescriptorContext, Type)
Gets a value indicating whether this converter can convert an object in the given source type to an enumeration object using the specified context.
(Inherited from EnumConverter.)
Public methodCanConvertTo(Type)
Returns whether this converter can convert the object to the specified type.
(Inherited from TypeConverter.)
Public methodCanConvertTo(ITypeDescriptorContext, Type)
Gets a value indicating whether this converter can convert an object to the given destination type using the context.
(Inherited from EnumConverter.)
Public methodConvertFrom(Object)
Converts the given value to the type of this converter.
(Inherited from TypeConverter.)
Public methodConvertFrom(ITypeDescriptorContext, CultureInfo, Object)
Converts the specified value object to an enumeration object.
(Inherited from EnumConverter.)
Public methodConvertFromInvariantString(String)
Converts the given string to the type of this converter, using the invariant culture.
(Inherited from TypeConverter.)
Public methodConvertFromInvariantString(ITypeDescriptorContext, String)
Converts the given string to the type of this converter, using the invariant culture and the specified context.
(Inherited from TypeConverter.)
Public methodConvertFromString(String)
Converts the specified text to an object.
(Inherited from TypeConverter.)
Public methodConvertFromString(ITypeDescriptorContext, String)
Converts the given text to an object, using the specified context.
(Inherited from TypeConverter.)
Public methodConvertFromString(ITypeDescriptorContext, CultureInfo, String)
Converts the given text to an object, using the specified context and culture information.
(Inherited from TypeConverter.)
Public methodConvertTo(Object, Type)
Converts the given value object to the specified type, using the arguments.
(Inherited from TypeConverter.)
Public methodConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type)
Converts the given value object to the specified destination type.
(Inherited from EnumConverter.)
Public methodConvertToInvariantString(Object)
Converts the specified value to a culture-invariant string representation.
(Inherited from TypeConverter.)
Public methodConvertToInvariantString(ITypeDescriptorContext, Object)
Converts the specified value to a culture-invariant string representation, using the specified context.
(Inherited from TypeConverter.)
Public methodConvertToString(Object)
Converts the specified value to a string representation.
(Inherited from TypeConverter.)
Public methodConvertToString(ITypeDescriptorContext, Object)
Converts the given value to a string representation, using the given context.
(Inherited from TypeConverter.)
Public methodConvertToString(ITypeDescriptorContext, CultureInfo, Object)
Converts the given value to a string representation, using the specified context and culture information.
(Inherited from TypeConverter.)
Public methodCreateInstance(IDictionary)
Re-creates an Object given a set of property values for the object.
(Inherited from TypeConverter.)
Public methodCreateInstance(ITypeDescriptorContext, IDictionary)
Creates an instance of the type that this TypeConverter is associated with, using the specified context, given a set of property values for the object.
(Inherited from TypeConverter.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetConvertFromException
Returns an exception to throw when a conversion cannot be performed.
(Inherited from TypeConverter.)
Protected methodGetConvertToException
Returns an exception to throw when a conversion cannot be performed.
(Inherited from TypeConverter.)
Public methodGetCreateInstanceSupported
Returns whether changing a value on this object requires a call to the CreateInstance(IDictionary) method to create a new value.
(Inherited from TypeConverter.)
Public methodGetCreateInstanceSupported(ITypeDescriptorContext)
Returns whether changing a value on this object requires a call to CreateInstance(IDictionary) to create a new value, using the specified context.
(Inherited from TypeConverter.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetProperties(Object)
Returns a collection of properties for the type of array specified by the value parameter.
(Inherited from TypeConverter.)
Public methodGetProperties(ITypeDescriptorContext, Object)
Returns a collection of properties for the type of array specified by the value parameter, using the specified context.
(Inherited from TypeConverter.)
Public methodGetProperties(ITypeDescriptorContext, Object, Attribute)
Retrieves the property descriptors for the enumeration fields. These property descriptors will be used by the property grid to show separate enumeration fields.
(Overrides TypeConverterGetProperties(ITypeDescriptorContext, Object, Attribute).)
Public methodGetPropertiesSupported
Returns whether this object supports properties.
(Inherited from TypeConverter.)
Public methodGetPropertiesSupported(ITypeDescriptorContext)
Returns whether this object supports properties, using the specified context.
(Overrides TypeConverterGetPropertiesSupported(ITypeDescriptorContext).)
Public methodGetStandardValues
Returns a collection of standard values from the default context for the data type this type converter is designed for.
(Inherited from TypeConverter.)
Public methodGetStandardValues(ITypeDescriptorContext)
Gets a collection of standard values for the data type this validator is designed for.
(Inherited from EnumConverter.)
Public methodGetStandardValuesExclusive
Returns whether the collection of standard values returned from GetStandardValues is an exclusive list.
(Inherited from TypeConverter.)
Public methodGetStandardValuesExclusive(ITypeDescriptorContext)
Gets a value indicating whether the list of standard values returned from GetStandardValues is an exclusive list using the specified context.
(Inherited from EnumConverter.)
Public methodGetStandardValuesSupported
Returns whether this object supports a standard set of values that can be picked from a list.
(Inherited from TypeConverter.)
Public methodGetStandardValuesSupported(ITypeDescriptorContext)
Gets whether this object supports a standard set of values that can be picked from a list using the specified context.
(Overrides EnumConverterGetStandardValuesSupported(ITypeDescriptorContext).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsValid(Object)
Returns whether the given value object is valid for this type.
(Inherited from TypeConverter.)
Public methodIsValid(ITypeDescriptorContext, Object)
Gets a value indicating whether the given object value is valid for this type.
(Inherited from EnumConverter.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodSortProperties
Sorts a collection of properties.
(Inherited from TypeConverter.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods

  NameDescription
Public Extension MethodConvert(Type, CultureInfo)Overloaded.
Converts an Object specified in the obj parameter to the desired targetType.
See the Examples section of the generic ConvertTTarget(Object, CultureInfo) overload for an example.
(Defined by ObjectExtensions.)
Public Extension MethodCode exampleConvertTTarget(CultureInfo)Overloaded.
Converts an Object specified in the obj parameter to the desired TTarget.
(Defined by ObjectExtensions.)
Public Extension MethodIn (Defined by ObjectExtensions.)
Public Extension MethodTryConvert(Type, Object)Overloaded.
Tries to convert an Object specified in the obj parameter to the desired targetType.
(Defined by ObjectExtensions.)
Public Extension MethodTryConvert(Type, CultureInfo, Object)Overloaded.
Tries to convert an Object specified in the obj parameter to the desired targetType.
(Defined by ObjectExtensions.)
Public Extension MethodTryConvertTTarget(TTarget)Overloaded.
Tries to convert an Object specified in the obj parameter to the desired TTarget.
See the Examples section of the ConvertTTarget(Object, CultureInfo) method for a related example.
(Defined by ObjectExtensions.)
Public Extension MethodTryConvertTTarget(CultureInfo, TTarget)Overloaded.
Tries to convert an Object specified in the obj parameter to the desired TTarget.
See the Examples section of the ConvertTTarget(Object, CultureInfo) method for a related example.
(Defined by ObjectExtensions.)
Top
See Also

Reference