ListSourceHelper.GetList(IDataSource) Method

Definition

Retrieves an IList collection of data source objects.

public:
 static System::Collections::IList ^ GetList(System::Web::UI::IDataSource ^ dataSource);
public static System.Collections.IList GetList (System.Web.UI.IDataSource dataSource);
static member GetList : System.Web.UI.IDataSource -> System.Collections.IList
Public Shared Function GetList (dataSource As IDataSource) As IList

Parameters

dataSource
IDataSource

An IDataSource that contains one or more associated DataSourceView objects, which are retrieved by a call to GetViewNames().

Returns

An IList of one IDataSource, if the IDataSource has one or more associated DataSourceView objects; otherwise, returns null.

Examples

The following code example demonstrates the design pattern for a data source class that implements the IListSource methods. The GetList method calls the static GetList method.

#region Implementation of IListSource

bool IListSource.ContainsListCollection {
    get {
        return ListSourceHelper.ContainsListCollection(this);
    }
}

IList IListSource.GetList() {
    return ListSourceHelper.GetList(this);
}

#endregion
#Region "Implementation of IListSource"

ReadOnly Property ContainsListCollection() As Boolean Implements IListSource.ContainsListCollection
   Get
      Return ListSourceHelper.ContainsListCollection(Me)
   End Get
End Property


Function GetList() As IList Implements IListSource.GetList
   Return ListSourceHelper.GetList(Me)
End Function 'IListSource.GetList

#End Region

Remarks

Use this method in an implementation of the IListSource.GetList method, passing a reference to a data source control.

The IList object that is returned implements the ITypedList interface. You can use the GetItemProperties method to retrieve a list of PropertyDescriptor descriptors that correspond to the DataSourceView names associated with the data source control from the list.

Applies to

See also