ListProvider<TBusinessObject> Class

Article
09/23/2016

Provides a list of objects in the list pane of the page in the Dashboard.

Namespace: Microsoft.WindowsServerSolutions.Administration.ObjectModel
Assembly: Microsoft.WindowsServerSolutions.Administration.ObjectModel (in Microsoft.WindowsServerSolutions.Administration.ObjectModel.dll)

Inheritance Hierarchy

System.Object
System.MarshalByRefObject
Microsoft.WindowsServerSolutions.Administration.ObjectModel.ListProvider<TBusinessObject>
Microsoft.WindowsServerSolutions.Administration.ObjectModel.PollingListProvider<TBusinessObject>

Syntax

public abstract class ListProvider<TBusinessObject> : MarshalByRefObject, 
    IDisposable
where TBusinessObject : class

generic<typename TBusinessObject>
where TBusinessObject : ref class
public ref class ListProvider abstract : MarshalByRefObject, 
    IDisposable

Public MustInherit Class ListProvider(Of TBusinessObject As Class)
    Inherits MarshalByRefObject
    Implements IDisposable

Type Parameters

TBusinessObject
Represents a business object that encapsulates information and methods that relate to business data or business functionality. The information in the business object is exposed as properties.

Constructors

	Name	Description
	ListProvider<TBusinessObject>()	Initializes a new instance of the ListProvider<TBusinessObject> class.

Properties

	Name	Description
	Errors	Gets the ErrorManager object that is used to display the errors that occurred during the data retrieval process.
	IsMutipleSelection	Gets or sets a value that determines if the current instance is a multiple selection.

Methods

	Name	Description
	CreateObjRef(Type)	(Inherited from MarshalByRefObject.)
	Dispose()	Releases all resources used by the ListProvider<TBusinessObject> object.
	Dispose(Boolean)	Releases the unmanaged resources used by the ListProvider<TBusinessObject> object and optionally releases the managed resources.
	Equals(Object)	(Inherited from Object.)
	Filter(Object, String)	Filters using the specified business object and filter string.
	Finalize()	Releases unmanaged resources and performs other cleanup operations before the ListProvider<TBusinessObject> object is reclaimed by garbage collection.(Overrides Object.Finalize().)
	GetFilterConfig()	Retrieves the filter config.
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetObjectDisplayName(TBusinessObject)	Returns the name of the specified object that will be displayed on the page in the Dashboard.
	GetObjectIcon(TBusinessObject)	Returns the icon that is displayed for the specified object on the page of the Dashboard.
	GetObjectId(TBusinessObject)	Returns the identifier for the specified object.
	GetType()	(Inherited from Object.)
	InitializeLifetimeService()	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	RefreshAndListenForUpdates(IList<TBusinessObject>)	Called by the Dashboard when the user requests to refresh the list that is displayed in the list pane.
	StopListeningForUpdates()	Called to stop the Dashboard from listening for list updates and to relinquish control of the IList that was passed into RefreshAndListenForUpdates.
	ToString()	(Inherited from Object.)

Remarks

TBusinessObject represents a business object that encapsulates information and methods that relate to business data or business functionality. The information in the business object is exposed as properties.

A ListProvider<TBusinessObject> object is passed as an argument to one of the Create methods of PageContent.

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.

Share via