HierarchicalDataSourceConverter Class

Definition

Namespace:

System.Web.UI.Design

Assembly:

System.Design.dll

Provides a type converter that can retrieve a list of the hierarchical data sources that are accessible to the current component.

public ref class HierarchicalDataSourceConverter : System::Web::UI::Design::DataSourceConverter

public class HierarchicalDataSourceConverter : System.Web.UI.Design.DataSourceConverter

type HierarchicalDataSourceConverter = class
    inherit DataSourceConverter

Public Class HierarchicalDataSourceConverter
Inherits DataSourceConverter

Inheritance

Object

TypeConverter

DataSourceConverter

HierarchicalDataSourceConverter

Examples

The following code example demonstrates how to associate a HierarchicalDataSourceConverter with a hierarchical data source property that is contained within a custom control.

[
ToolboxData("<{0}:MyCustomHierarchicalControl runat=server> </{0}:MyCustomHierarchicalControl>")
] 
public class MyCustomHierarchicalControl : TreeView 
{        
    private object _dataSource;

    [TypeConverter(typeof(HierarchicalDataSourceConverter))]
    public override object DataSource
    {
        get
        {
            return _dataSource;
        }
        set
        {
            if (value != null) 
            {
                ValidateDataSource(value);
            }
            _dataSource = value;
            OnDataPropertyChanged();
        }
    }

    // Define rest of custom control implementation.
    // ...
}

Remarks

The HierarchicalDataSourceConverter class provides methods that can be used to retrieve a list of the hierarchical data sources that are accessible to the current design-time component.

The HierarchicalDataSourceConverter type converter is used by Microsoft Visual Studio to provide the values that appear in the list of data sources in the Properties window.

Caution

You should never access a type converter directly. Instead, call the appropriate converter by using the TypeDescriptor class. For more information, see the examples in TypeConverter.

For more information about type converters, see the TypeConverter base class and How to: Implement a Type Converter.

Constructors

HierarchicalDataSourceConverter()

Initializes a new instance of the HierarchicalDataSourceConverter class.

Methods

CanConvertFrom(ITypeDescriptorContext, Type)	Gets a value indicating whether the converter can convert an object of the specified source type to the native type of the converter. (Inherited from DataSourceConverter)
CanConvertFrom(Type)	Returns whether this converter can convert an object of the given type to the type of this converter. (Inherited from TypeConverter)
CanConvertTo(ITypeDescriptorContext, Type)	Returns whether this converter can convert the object to the specified type, using the specified context. (Inherited from TypeConverter)
CanConvertTo(Type)	Returns whether this converter can convert the object to the specified type. (Inherited from TypeConverter)
ConvertFrom(ITypeDescriptorContext, CultureInfo, Object)	Converts the specified object to the native type of the converter. (Inherited from DataSourceConverter)
ConvertFrom(Object)	Converts the given value to the type of this converter. (Inherited from TypeConverter)
ConvertFromInvariantString(ITypeDescriptorContext, String)	Converts the given string to the type of this converter, using the invariant culture and the specified context. (Inherited from TypeConverter)
ConvertFromInvariantString(String)	Converts the given string to the type of this converter, using the invariant culture. (Inherited from TypeConverter)
ConvertFromString(ITypeDescriptorContext, CultureInfo, String)	Converts the given text to an object, using the specified context and culture information. (Inherited from TypeConverter)
ConvertFromString(ITypeDescriptorContext, String)	Converts the given text to an object, using the specified context. (Inherited from TypeConverter)
ConvertFromString(String)	Converts the specified text to an object. (Inherited from TypeConverter)
ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type)	Converts the given value object to the specified type, using the specified context and culture information. (Inherited from TypeConverter)
ConvertTo(Object, Type)	Converts the given value object to the specified type, using the arguments. (Inherited from TypeConverter)
ConvertToInvariantString(ITypeDescriptorContext, Object)	Converts the specified value to a culture-invariant string representation, using the specified context. (Inherited from TypeConverter)
ConvertToInvariantString(Object)	Converts the specified value to a culture-invariant string representation. (Inherited from TypeConverter)
ConvertToString(ITypeDescriptorContext, CultureInfo, Object)	Converts the given value to a string representation, using the specified context and culture information. (Inherited from TypeConverter)
ConvertToString(ITypeDescriptorContext, Object)	Converts the given value to a string representation, using the given context. (Inherited from TypeConverter)
ConvertToString(Object)	Converts the specified value to a string representation. (Inherited from TypeConverter)
CreateInstance(IDictionary)	Re-creates an Object given a set of property values for the object. (Inherited from TypeConverter)
CreateInstance(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)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetConvertFromException(Object)	Returns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter)
GetConvertToException(Object, Type)	Returns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter)
GetCreateInstanceSupported()	Returns whether changing a value on this object requires a call to the CreateInstance(IDictionary) method to create a new value. (Inherited from TypeConverter)
GetCreateInstanceSupported(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)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperties(ITypeDescriptorContext, Object)	Returns a collection of properties for the type of array specified by the value parameter, using the specified context. (Inherited from TypeConverter)
GetProperties(ITypeDescriptorContext, Object, Attribute[])	Returns a collection of properties for the type of array specified by the value parameter, using the specified context and attributes. (Inherited from TypeConverter)
GetProperties(Object)	Returns a collection of properties for the type of array specified by the value parameter. (Inherited from TypeConverter)
GetPropertiesSupported()	Returns whether this object supports properties. (Inherited from TypeConverter)
GetPropertiesSupported(ITypeDescriptorContext)	Returns whether this object supports properties, using the specified context. (Inherited from TypeConverter)
GetStandardValues()	Returns a collection of standard values from the default context for the data type this type converter is designed for. (Inherited from TypeConverter)
GetStandardValues(ITypeDescriptorContext)	Gets the standard data sources accessible to the control. (Inherited from DataSourceConverter)
GetStandardValuesExclusive()	Returns whether the collection of standard values returned from GetStandardValues() is an exclusive list. (Inherited from TypeConverter)
GetStandardValuesExclusive(ITypeDescriptorContext)	Gets a value indicating whether the collection of standard values returned from GetStandardValues() is a list of all possible values. (Inherited from DataSourceConverter)
GetStandardValuesSupported()	Returns whether this object supports a standard set of values that can be picked from a list. (Inherited from TypeConverter)
GetStandardValuesSupported(ITypeDescriptorContext)	Gets a value indicating whether the converter supports a standard set of values that can be picked from a list. (Inherited from DataSourceConverter)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsValid(ITypeDescriptorContext, Object)	Returns whether the given value object is valid for this type and for the specified context. (Inherited from TypeConverter)
IsValid(Object)	Returns whether the given value object is valid for this type. (Inherited from TypeConverter)
IsValidDataSource(IComponent)	Indicates whether the specified component is a valid data source for this converter.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
SortProperties(PropertyDescriptorCollection, String[])	Sorts a collection of properties. (Inherited from TypeConverter)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• HierarchicalDataSourceControl
• HierarchicalDataSourceDesigner
• How to: Implement a Type Converter