Skip to main content
ExpandableObjectConverter Class
 

Provides a type converter to convert expandable objects to and from various other representations.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)


Syntax
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class ExpandableObjectConverter : TypeConverter
[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)]
public ref class ExpandableObjectConverter : TypeConverter
[<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)>]
type ExpandableObjectConverter = 
    class
        inherit TypeConverter
    end
<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState := True)>
Public Class ExpandableObjectConverter
	Inherits TypeConverter
Constructors
NameDescription
System_CAPS_pubmethod ExpandableObjectConverter

Initializes a new instance of the ExpandableObjectConverter class.

Methods
NameDescription
System_CAPS_pubmethod CanConvertFrom

Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod CanConvertFrom

Returns whether this converter can convert an object of the given type to the type of this converter.(Inherited from TypeConverter.)

System_CAPS_pubmethod CanConvertTo

Returns whether this converter can convert the object to the specified type, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod CanConvertTo

Returns whether this converter can convert the object to the specified type.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertFrom

Converts the given object to the type of this converter, using the specified context and culture information.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertFrom

Converts the given value to the type of this converter.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertFromInvariantString

Converts the given string to the type of this converter, using the invariant culture and the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertFromInvariantString

Converts the given string to the type of this converter, using the invariant culture.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertFromString

Converts the given text to an object, using the specified context and culture information.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertFromString

Converts the given text to an object, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertFromString

Converts the specified text to an object.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertTo

Converts the given value object to the specified type, using the specified context and culture information.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertTo

Converts the given value object to the specified type, using the arguments.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertToInvariantString

Converts the specified value to a culture-invariant string representation, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertToInvariantString

Converts the specified value to a culture-invariant string representation.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertToString

Converts the given value to a string representation, using the specified context and culture information.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertToString

Converts the given value to a string representation, using the given context.(Inherited from TypeConverter.)

System_CAPS_pubmethod ConvertToString

Converts the specified value to a string representation.(Inherited from TypeConverter.)

System_CAPS_pubmethod CreateInstance

Re-creates an Object given a set of property values for the object.(Inherited from TypeConverter.)

System_CAPS_pubmethod CreateInstance

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.)

System_CAPS_pubmethod Equals

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethod Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethod GetConvertFromException

Returns an exception to throw when a conversion cannot be performed.(Inherited from TypeConverter.)

System_CAPS_protmethod GetConvertToException

Returns an exception to throw when a conversion cannot be performed.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetCreateInstanceSupported

Returns whether changing a value on this object requires a call to the CreateInstance method to create a new value.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetCreateInstanceSupported

Returns whether changing a value on this object requires a call to CreateInstance to create a new value, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetHashCode

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethod GetProperties

Returns a collection of properties for the type of array specified by the value parameter, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetProperties

Gets a collection of properties for the type of object specified by the value parameter.(Overrides TypeConverterGetProperties.)

System_CAPS_pubmethod GetProperties

Returns a collection of properties for the type of array specified by the value parameter.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetPropertiesSupported

Returns whether this object supports properties.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetPropertiesSupported

Gets a value indicating whether this object supports properties using the specified context.(Overrides TypeConverterGetPropertiesSupported.)

System_CAPS_pubmethod GetStandardValues

Returns a collection of standard values from the default context for the data type this type converter is designed for.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetStandardValues

Returns a collection of standard values for the data type this type converter is designed for when provided with a format context.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetStandardValuesExclusive

Returns whether the collection of standard values returned from GetStandardValues is an exclusive list.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetStandardValuesExclusive

Returns whether the collection of standard values returned from GetStandardValues is an exclusive list of possible values, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetStandardValuesSupported

Returns whether this object supports a standard set of values that can be picked from a list.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetStandardValuesSupported

Returns whether this object supports a standard set of values that can be picked from a list, using the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod IsValid

Returns whether the given value object is valid for this type and for the specified context.(Inherited from TypeConverter.)

System_CAPS_pubmethod IsValid

Returns whether the given value object is valid for this type.(Inherited from TypeConverter.)

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethod SortProperties

Sorts a collection of properties.(Inherited from TypeConverter.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

Remarks

This class adds support for properties on an object to the methods and properties provided by TypeConverter. To make a type of property expandable in the PropertyGrid, specify this TypeConverter for standard implementations of GetPropertiesSupported and GetProperties. Mark child properties with the NotifyParentPropertyAttribute to ensure correct behavior in a PropertyGrid control.

System_CAPS_noteNote

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

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

Examples

The following code example converts a variable of type Margins to a string variable.

string strM="1,2,3,4";
System.Drawing.Printing.Margins  m= new System.Drawing.Printing.Margins(1,2,3,4);
Console.WriteLine(TypeDescriptor.GetConverter(strM).CanConvertTo(typeof(System.Drawing.Printing.Margins))); 
Console.WriteLine(TypeDescriptor.GetConverter(m).ConvertToString(m)); 
Dim strM As String
strM = "1,2,3,4"
            Dim m As New System.Drawing.Printing.Margins(1, 2, 3, 4)
Console.WriteLine(TypeDescriptor.GetConverter(strM).CanConvertTo(GetType(System.Drawing.Printing.Margins)))
Console.WriteLine(TypeDescriptor.GetConverter(m).ConvertToString(m))
String^ strM = "1,2,3,4";
System::Drawing::Printing::Margins^ m = gcnew System::Drawing::Printing::Margins( 1,2,3,4 );
Console::WriteLine( TypeDescriptor::GetConverter( strM )->CanConvertTo( System::Drawing::Printing::Margins::typeid ) );
Console::WriteLine( TypeDescriptor::GetConverter( m )->ConvertToString( m ) );

The following code example demonstrates how to use the NotifyParentPropertyAttribute and the ExpandableObjectConverter class to create an expandable property on a custom control. This code example is part of a larger example provided for the NotifyParentPropertyAttribute class.

[TypeConverter(typeof(BorderAppearanceConverter))]
public class BorderAppearance
{
    private int borderSizeValue = 1;
    private Color borderColorValue = Color.Empty;

    [Browsable(true),
    NotifyParentProperty(true),
    EditorBrowsable(EditorBrowsableState.Always),
    DefaultValue(1)]
    public int BorderSize
    {
        get
        {
            return borderSizeValue;
        }
        set
        {
            if (value < 0)
            {
                throw new ArgumentOutOfRangeException(
                    "BorderSize",
                    value,
                    "must be >= 0");
            }

            if (borderSizeValue != value)
            {
                borderSizeValue = value;
            }
        }
    }

    [Browsable(true)]
    [NotifyParentProperty(true)]
    [EditorBrowsable(EditorBrowsableState.Always)]
    [DefaultValue(typeof(Color), "")]
    public Color BorderColor
    {
        get
        {
            return borderColorValue;
        }
        set
        {
            if (value.Equals(Color.Transparent))
            {
                throw new NotSupportedException("Transparent colors are not supported.");
            }

            if (borderColorValue != value)
            {
                borderColorValue = value;
            }
        }
    }
}
<TypeConverter(GetType(BorderAppearanceConverter))>  _
Public Class BorderAppearance
    Private borderSizeValue As Integer = 1
    Private borderColorValue As Color = Color.Empty


    <Browsable(True), NotifyParentProperty(True), EditorBrowsable(EditorBrowsableState.Always), DefaultValue(1)>  _
    Public Property BorderSize() As Integer 
        Get
            Return borderSizeValue
        End Get
        Set
            If value < 0 Then
                Throw New ArgumentOutOfRangeException("BorderSize", value, "must be >= 0")
            End If

            If borderSizeValue <> value Then
                borderSizeValue = value
            End If
        End Set
    End Property


    <Browsable(True), NotifyParentProperty(True), EditorBrowsable(EditorBrowsableState.Always), DefaultValue(GetType(Color), "")>  _
    Public Property BorderColor() As Color 
        Get
            Return borderColorValue
        End Get
        Set
            If value.Equals(Color.Transparent) Then
                Throw New NotSupportedException("Transparent colors are not supported.")
            End If

            If borderColorValue <> value Then
                borderColorValue = value
            End If
        End Set
    End Property
End Class
Version Information
.NET Framework
Available since 1.1
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top