DocumentationSourceCollection Class

This collection class is used to hold the documentation sources

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionDocumentationSource
    System.ComponentModelBindingListDocumentationSource
      SandcastleBuilder.UtilsDocumentationSourceCollection

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

Syntax

C++

Copy

public class DocumentationSourceCollection : BindingList<DocumentationSource>

Public Class DocumentationSourceCollection
	Inherits BindingList(Of DocumentationSource)

public ref class DocumentationSourceCollection : public BindingList<DocumentationSource^>

type DocumentationSourceCollection =  
    class
        inherit BindingList<DocumentationSource>
    end

The DocumentationSourceCollection type exposes the following members.

Methods

	Name	Description
	Add(T)	Adds an object to the end of the CollectionT. (Inherited from CollectionDocumentationSource.)
	Add(String, String, String, Boolean)	Add a new item to the collection
	AddNew	Adds a new item to the collection. (Inherited from BindingListDocumentationSource.)
	AddNewCore	Adds a new item to the end of the collection. (Inherited from BindingListDocumentationSource.)
	ApplySortCore	Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException. (Inherited from BindingListDocumentationSource.)
	CancelNew	Discards a pending new item. (Inherited from BindingListDocumentationSource.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionDocumentationSource.)
	ClearItems	Removes all elements from the collection. (Inherited from BindingListDocumentationSource.)
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionDocumentationSource.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionDocumentationSource.)
	EndNew	Commits a pending new item to the collection. (Inherited from BindingListDocumentationSource.)
	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 BindingListDocumentationSource.)
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionDocumentationSource.)
	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 CollectionDocumentationSource.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionDocumentationSource.)
	InsertItem	Inserts the specified item in the list at the specified index. (Inherited from BindingListDocumentationSource.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAddingNew	Raises the AddingNew event. (Inherited from BindingListDocumentationSource.)
	OnListChanged	This is overridden to mark the collection as dirty when it changes (Overrides BindingListTOnListChanged(ListChangedEventArgs).)
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionDocumentationSource.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionDocumentationSource.)
	RemoveItem	Removes the item at the specified index. (Inherited from BindingListDocumentationSource.)
	RemoveSortCore	Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException. (Inherited from BindingListDocumentationSource.)
	ResetBindings	Raises a ListChanged event of type Reset. (Inherited from BindingListDocumentationSource.)
	ResetItem	Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingListDocumentationSource.)
	SetItem	Replaces the item at the specified index with the specified item. (Inherited from BindingListDocumentationSource.)
	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 BindingListDocumentationSource.)
	AllowNew	Gets or sets a value indicating whether you can add items to the list using the AddNew method. (Inherited from BindingListDocumentationSource.)
	AllowRemove	Gets or sets a value indicating whether you can remove items from the collection. (Inherited from BindingListDocumentationSource.)
	Assemblies	This read-only property returns a list of assemblies in the collection.
	CommentsFiles	This read-only property returns a list of XML comments files in the collection.
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionDocumentationSource.)
	IsDirty	This is used to get or set the dirty state of the collection
	IsSortedCore	Gets a value indicating whether the list is sorted. (Inherited from BindingListDocumentationSource.)
	Item	Gets or sets the element at the specified index. (Inherited from CollectionDocumentationSource.)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionDocumentationSource.)
	RaiseListChangedEvents	Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events. (Inherited from BindingListDocumentationSource.)
	SortDirectionCore	Gets the direction the list is sorted. (Inherited from BindingListDocumentationSource.)
	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 BindingListDocumentationSource.)
	SupportsChangeNotificationCore	Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingListDocumentationSource.)
	SupportsSearchingCore	Gets a value indicating whether the list supports searching. (Inherited from BindingListDocumentationSource.)
	SupportsSortingCore	Gets a value indicating whether the list supports sorting. (Inherited from BindingListDocumentationSource.)

Top

Events

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

Top

Remarks

A documentation source is an assembly, an XML comments file, a Visual Studio project (C#, VB.NET, or J#), or a Visual Studio solution containing one or more C#, VB.NET or J# projects.

Reference

SandcastleBuilder.Utils Namespace