ReferenceItemCollection Class

This collection class is used to hold the reference items for a project

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionReferenceItem
    System.ComponentModelBindingListReferenceItem
      SandcastleBuilder.UtilsReferenceItemCollection

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public class ReferenceItemCollection : BindingList<ReferenceItem>

Public Class ReferenceItemCollection
	Inherits BindingList(Of ReferenceItem)

public ref class ReferenceItemCollection : public BindingList<ReferenceItem^>

type ReferenceItemCollection =  
    class
        inherit BindingList<ReferenceItem>
    end

The ReferenceItemCollection type exposes the following members.

Methods

	Name	Description
	Add	Adds an object to the end of the CollectionT. (Inherited from CollectionReferenceItem.)
	AddNew	Adds a new item to the collection. (Inherited from BindingListReferenceItem.)
	AddNewCore	Adds a new item to the end of the collection. (Inherited from BindingListReferenceItem.)
	AddProjectReference	Add a new project reference item to the collection
	AddReference	Add a new GAC or file reference item to the collection
	ApplySortCore	Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException. (Inherited from BindingListReferenceItem.)
	CancelNew	Discards a pending new item. (Inherited from BindingListReferenceItem.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionReferenceItem.)
	ClearItems	Removes all elements from the collection. (Inherited from BindingListReferenceItem.)
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionReferenceItem.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionReferenceItem.)
	EndNew	Commits a pending new item to the collection. (Inherited from BindingListReferenceItem.)
	EnsureCurrent	This is used to ensure that the collection has up to date information about the reference build items in the project.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindCore	Searches for the index of the item that has the specified property descriptor with the specified value, if searching is implemented in a derived class; otherwise, a NotSupportedException. (Inherited from BindingListReferenceItem.)
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionReferenceItem.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified object and returns the zero-based index of the first occurrence within the entire CollectionT. (Inherited from CollectionReferenceItem.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionReferenceItem.)
	InsertItem	Inserts the specified item in the list at the specified index. (Inherited from BindingListReferenceItem.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAddingNew	Raises the AddingNew event. (Inherited from BindingListReferenceItem.)
	OnListChanged	This is overridden to suppress the event when loading references (Overrides BindingListTOnListChanged(ListChangedEventArgs).)
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionReferenceItem.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionReferenceItem.)
	RemoveItem	Remove an item from the collection and from the project file (Overrides BindingListTRemoveItem(Int32).)
	RemoveSortCore	Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException. (Inherited from BindingListReferenceItem.)
	ResetBindings	Raises a ListChanged event of type Reset. (Inherited from BindingListReferenceItem.)
	ResetItem	Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingListReferenceItem.)
	SetItem	Replaces the item at the specified index with the specified item. (Inherited from BindingListReferenceItem.)
	Sort	This is used to sort the collection in ascending order.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	AllowEdit	Gets or sets a value indicating whether items in the list can be edited. (Inherited from BindingListReferenceItem.)
	AllowNew	Gets or sets a value indicating whether you can add items to the list using the AddNew method. (Inherited from BindingListReferenceItem.)
	AllowRemove	Gets or sets a value indicating whether you can remove items from the collection. (Inherited from BindingListReferenceItem.)
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionReferenceItem.)
	IsSortedCore	Gets a value indicating whether the list is sorted. (Inherited from BindingListReferenceItem.)
	Item	Gets or sets the element at the specified index. (Inherited from CollectionReferenceItem.)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionReferenceItem.)
	RaiseListChangedEvents	Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events. (Inherited from BindingListReferenceItem.)
	SortDirectionCore	Gets the direction the list is sorted. (Inherited from BindingListReferenceItem.)
	SortPropertyCore	Gets the property descriptor that is used for sorting the list if sorting is implemented in a derived class; otherwise, returns null. (Inherited from BindingListReferenceItem.)
	SupportsChangeNotificationCore	Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingListReferenceItem.)
	SupportsSearchingCore	Gets a value indicating whether the list supports searching. (Inherited from BindingListReferenceItem.)
	SupportsSortingCore	Gets a value indicating whether the list supports sorting. (Inherited from BindingListReferenceItem.)

Top

Events

	Name	Description
	AddingNew	Occurs before an item is added to the list. (Inherited from BindingListReferenceItem.)
	ListChanged	Occurs when the list or an item in the list changes. (Inherited from BindingListReferenceItem.)

Top

Reference

SandcastleBuilder.Utils Namespace