ListSourceHelper.GetList Method (IDataSource)

 

Retrieves an IList collection of data source objects.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

public static IList GetList(
	IDataSource dataSource
)

Parameters

dataSource
Type: System.Web.UI.IDataSource

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

Return Value

Type: System.Collections.IList

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

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.

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

.NET Framework
Available since 2.0
Return to top
Show: