DocumentationSourceCollection Class

This collection class is used to hold the documentation sources and can be used for editing them

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
public class DocumentationSourceCollection : BindingList<DocumentationSource>
Inheritance
Object    CollectionDocumentationSource    BindingListDocumentationSource    DocumentationSourceCollection

Remarks

A documentation source is an assembly, an XML comments file, a Visual Studio managed code project (C#, VB.NET, etc.), or a Visual Studio solution containing one or more managed code projects from which information is obtained to build a help file.

Properties

AllowEditGets or sets a value indicating whether items in the list can be edited.
(Inherited from BindingListDocumentationSource)
AllowNewGets or sets a value indicating whether you can add items to the list using the AddNew method.
(Inherited from BindingListDocumentationSource)
AllowRemoveGets or sets a value indicating whether you can remove items from the collection.
(Inherited from BindingListDocumentationSource)
CountGets the number of elements actually contained in the CollectionT.
(Inherited from CollectionDocumentationSource)
IsSortedCoreGets a value indicating whether the list is sorted.
(Inherited from BindingListDocumentationSource)
ItemGets or sets the element at the specified index.
(Inherited from CollectionDocumentationSource)
ItemsGets a IListT wrapper around the CollectionT.
(Inherited from CollectionDocumentationSource)
RaiseListChangedEventsGets or sets a value indicating whether adding or removing items within the list raises ListChanged events.
(Inherited from BindingListDocumentationSource)
SortDirectionCoreGets the direction the list is sorted.
(Inherited from BindingListDocumentationSource)
SortPropertyCoreGets the property descriptor that is used for sorting the list if sorting is implemented in a derived class; otherwise, returns .
(Inherited from BindingListDocumentationSource)
SupportsChangeNotificationCoreGets a value indicating whether ListChanged events are enabled.
(Inherited from BindingListDocumentationSource)
SupportsSearchingCoreGets a value indicating whether the list supports searching.
(Inherited from BindingListDocumentationSource)
SupportsSortingCoreGets a value indicating whether the list supports sorting.
(Inherited from BindingListDocumentationSource)

Methods

Add(T)Adds an object to the end of the CollectionT.
(Inherited from CollectionDocumentationSource)
Add(String, String, String, String, Boolean) Add a new item to the collection
AddNewAdds a new item to the collection.
(Inherited from BindingListDocumentationSource)
AddNewCoreAdds a new item to the end of the collection.
(Inherited from BindingListDocumentationSource)
ApplySortCoreSorts the items if overridden in a derived class; otherwise, throws a NotSupportedException.
(Inherited from BindingListDocumentationSource)
CancelNewDiscards a pending new item.
(Inherited from BindingListDocumentationSource)
ClearRemoves all elements from the CollectionT.
(Inherited from CollectionDocumentationSource)
ClearItemsRemoves all elements from the collection.
(Inherited from BindingListDocumentationSource)
ContainsDetermines whether an element is in the CollectionT.
(Inherited from CollectionDocumentationSource)
CopyToCopies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from CollectionDocumentationSource)
EndNewCommits a pending new item to the collection.
(Inherited from BindingListDocumentationSource)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
FindCoreSearches 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)
GetEnumeratorReturns an enumerator that iterates through the CollectionT.
(Inherited from CollectionDocumentationSource)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IndexOfSearches for the specified object and returns the zero-based index of the first occurrence within the entire CollectionT.
(Inherited from CollectionDocumentationSource)
InsertInserts an element into the CollectionT at the specified index.
(Inherited from CollectionDocumentationSource)
InsertItemInserts the specified item in the list at the specified index.
(Inherited from BindingListDocumentationSource)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OnAddingNewRaises the AddingNew event.
(Inherited from BindingListDocumentationSource)
OnListChangedRaises the ListChanged event.
(Inherited from BindingListDocumentationSource)
RemoveRemoves the first occurrence of a specific object from the CollectionT.
(Inherited from CollectionDocumentationSource)
RemoveAtRemoves the element at the specified index of the CollectionT.
(Inherited from CollectionDocumentationSource)
RemoveItemRemoves the item at the specified index.
(Inherited from BindingListDocumentationSource)
RemoveSortCoreRemoves any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException.
(Inherited from BindingListDocumentationSource)
ResetBindingsRaises a ListChanged event of type Reset.
(Inherited from BindingListDocumentationSource)
ResetItemRaises a ListChanged event of type ItemChanged for the item at the specified position.
(Inherited from BindingListDocumentationSource)
SaveToProject Save the documentation source collection to the associated project
SetItemReplaces the item at the specified index with the specified item.
(Inherited from BindingListDocumentationSource)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Events

AddingNewOccurs before an item is added to the list.
(Inherited from BindingListDocumentationSource)
ListChangedOccurs when the list or an item in the list changes.
(Inherited from BindingListDocumentationSource)

See Also