ListColumnCollection<TBusinessObject> Class

Article
09/23/2016

Represents a collection of ListColumn<TBusinessObject> objects that are displayed in the list pane of 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.ListColumnCollection<TBusinessObject>

Syntax

public sealed class ListColumnCollection<TBusinessObject> : MarshalByRefObject, 
    ICollection<ListColumn<TBusinessObject>>, IEnumerable<ListColumn<TBusinessObject>>, 
    IEnumerable
where TBusinessObject : class

generic<typename TBusinessObject>
where TBusinessObject : ref class
public ref class ListColumnCollection sealed : MarshalByRefObject, 
    ICollection<ListColumn<TBusinessObject>^>, IEnumerable<ListColumn<TBusinessObject>^>, 
    IEnumerable

Public NotInheritable Class ListColumnCollection(Of TBusinessObject As Class)
    Inherits MarshalByRefObject
    Implements ICollection(Of ListColumn(Of TBusinessObject)), IEnumerable(Of ListColumn(Of TBusinessObject)),
    IEnumerable

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
	ListColumnCollection<TBusinessObject>()	Initializes a new instance of the ListColumnCollection<TBusinessObject> class.

Properties

	Name	Description
	Count	Gets the number of ListColumn<TBusinessObject> objects in the ListColumnCollection<TBusinessObject>.
	DefaultSortColumn	Gets or sets the default sort column for the list that is displayed in the list pane of the Dashboard.
	DefaultSortOrder	Gets or sets the default sort order for the list that is displayed in the list pane of the Dashboard.
	IsReadOnly	Gets a value indicating whether the ListColumnCollection<TBusinessObject> is read-only.

Methods

	Name	Description
	Add(ListColumn<TBusinessObject>)	Adds the specified ListColumn<TBusinessObject> object to the ListColumnCollection<TBusinessObject>.
	Add(String, Converter<TBusinessObject, String>)	Adds a ListColumn<TBusinessObject> object to the ListColumnCollection<TBusinessObject> with the specified display name and the display value that is returned from the specified delegate method. The delegate method converts information from a business object to a string that is used as the display value for the object in the column.
	Add(String, String)	Adds a ListColumn<TBusinessObject> object to the ListColumnCollection<TBusinessObject> with the specified display name and the specified property name. The property name is retrieved from the business object and is used as the display value for the object in the column.
	Add(String, String, IFormatProvider, String)	Adds a ListColumn<TBusinessObject> object to the ListColumnCollection<TBusinessObject> with the specified display name and the specified property name. The property name is retrieved from the business object and is used as the display value for the object in the column. A format string and a format provider that are used to format the display value are also specified.
	Clear()	Removes all ListColumn<TBusinessObject> objects from the ListColumnCollection<TBusinessObject>.
	Contains(ListColumn<TBusinessObject>)	Determines whether the specified ListColumn<TBusinessObject> object is in the ListColumnCollection<TBusinessObject>.
	CopyTo(ListColumn<TBusinessObject>[], Int32)	Copies the entire ListColumnCollection<TBusinessObject> to a compatible one-dimensional array, starting at the specified index of the target array.
	CreateObjRef(Type)	(Inherited from MarshalByRefObject.)
	Equals(Object)	(Inherited from Object.)
	GetEnumerator()	Returns an enumerator that is used to iterate through the ListColumnCollection<TBusinessObject>.
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetType()	(Inherited from Object.)
	InitializeLifetimeService()	(Inherited from MarshalByRefObject.)
	Remove(ListColumn<TBusinessObject>)	Removes the first occurrence of the specified ListColumn<TBusinessObject> object from the ListColumnCollection<TBusinessObject>.
	ToString()	(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	IEnumerable.GetEnumerator()	Returns an IEnumerator that can iterate through a collection.

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 ListColumnCollection<TBusinessObject> 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