This documentation is archived and is not being maintained.

ListSourceHelper Class

Used by data source controls when implementing the members defined by the IListSource interface. This class cannot be inherited.

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

'Declaration
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class ListSourceHelper
'Usage
You do not need to declare an instance of a static class in order to access its members.

The ListSourceHelper class is a utility class provided to simplify implementation of the IListSource interface by data source controls. Data source controls that implement the IDataSource interface but do not extend the DataSourceControl class can use the static ListSourceHelper methods in their own implementations of the methods defined by the IListSource interface. Data source controls that extend from the DataSourceControl class inherit these method implementations automatically.

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

#Region "Implementation of IDataSource" 

Public Overridable Function GetView(viewName As String) As DataSourceView Implements IDataSource.GetView
   If view Is Nothing Then
      view = New SomeDataSourceView(Me)
   End If 
   Return view
End Function 'GetView


Public Overridable Function GetViewNames() As ICollection Implements IDataSource.GetViewNames
   Dim al As New ArrayList(1)
   al.Add(GetView(String.Empty).Name)
   Return CType( al, ICollection)
End Function 'GetViewNames

Event DataSourceChanged As EventHandler Implements IDataSource.DataSourceChanged

#End Region

#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

System.Object
  System.Web.UI.ListSourceHelper

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: