ITypedList Interface

Provides functionality to discover the schema for a bindable list, where the properties available for binding differ from the public properties of the object to bind to.

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

'Declaration
Public Interface ITypedList

The ITypedList type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkGetItemPropertiesReturns the PropertyDescriptorCollection that represents the properties on each item used to bind data.
Public methodSupported by the XNA FrameworkGetListNameReturns the name of the list.
Top

Use this interface if, for instance, you are using a DataView object that represents a customer table, you want to bind to the properties on the customer object that the DataView represents, not the properties of the DataView.

This interface is not required for design-time support of a bindable list.

Binding to data can occur either at run time or in a designer, but there are rules for both. At run time, you can bind to data in any of the following:

  • Array

  • Implementer of IList, provided the implementer has a strongly typed Item property (that is, the Type is anything but Object). You can accomplish this by making the default implementation of Item private. If you want to create an IList that follows the rules of a strongly typed collection, you should derive from CollectionBase.

  • Implementer of ITypedList.

In a designer, you can initialize binding to Component objects by following the same rules.

For more information on binding to a data source, see the System.Windows.Forms.Binding class.

The following code example demonstrates how to implement the ITypedList interface. A generic type named SortableBindingList derives from the BindingList(Of T) class and implements the ITypedList interface. For a full code listing, see How to: Implement the ITypedList Interface.

Imports System.ComponentModel
Imports System.Collections.Generic
Imports System.Windows.Forms

<Serializable()> _
Public Class SortableBindingList(Of Tkey)
    Inherits BindingList(Of Tkey)
    Implements ITypedList

    <NonSerialized()> _
    Private properties As PropertyDescriptorCollection

    Public Sub New()
        MyBase.New()

        ' Get the 'shape' of the list.  
        ' Only get the public properties marked with Browsable = true. 
        Dim pdc As PropertyDescriptorCollection = TypeDescriptor.GetProperties(GetType(Tkey), New Attribute() {New BrowsableAttribute(True)})

        ' Sort the properties.
        properties = pdc.Sort()

    End Sub

#Region "ITypedList Implementation" 

    Public Function GetItemProperties(ByVal listAccessors() As System.ComponentModel.PropertyDescriptor) As System.ComponentModel.PropertyDescriptorCollection Implements System.ComponentModel.ITypedList.GetItemProperties

        Dim pdc As PropertyDescriptorCollection

        If (Not (listAccessors Is Nothing)) And (listAccessors.Length > 0) Then 
            ' Return child list shape
            pdc = ListBindingHelper.GetListItemProperties(listAccessors(0).PropertyType)
        Else 
            ' Return properties in sort order
            pdc = properties
        End If 

        Return pdc

    End Function 

    ' This method is only used in the design-time framework  
    ' and by the obsolete DataGrid control. 
    Public Function GetListName( _
    ByVal listAccessors() As PropertyDescriptor) As String _
    Implements System.ComponentModel.ITypedList.GetListName

        Return GetType(Tkey).Name

    End Function

#End Region

End Class

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft