XmlCommentsFileCollection Class

This collection class is used to hold the XML comments files during the build process

Definition

Namespace: SandcastleBuilder.Utils.BuildEngine
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
public class XmlCommentsFileCollection : BindingList<XmlCommentsFile>
Inheritance
Object    Collection<XmlCommentsFile>    BindingList<XmlCommentsFile>    XmlCommentsFileCollection

Constructors

XmlCommentsFileCollectionInitializes a new instance of the XmlCommentsFileCollection class

Properties

AllowEditGets or sets a value indicating whether items in the list can be edited.
(Inherited from BindingList<XmlCommentsFile>)
AllowNewGets or sets a value indicating whether you can add items to the list using the AddNew() method.
(Inherited from BindingList<XmlCommentsFile>)
AllowRemoveGets or sets a value indicating whether you can remove items from the collection.
(Inherited from BindingList<XmlCommentsFile>)
ContainsInheritedDocumentation This read-only property returns true if any of the comments files contain an inheritdoc, AttachedPropertyComments, or AttachedEventComments tag indicating that the Inherited Documentation tool will need to be ran.
CountGets the number of elements actually contained in the Collection<T>.
(Inherited from Collection<XmlCommentsFile>)
IsSortedCoreGets a value indicating whether the list is sorted.
(Inherited from BindingList<XmlCommentsFile>)
ItemGets or sets the element at the specified index.
(Inherited from Collection<XmlCommentsFile>)
ItemsGets a IList<T> wrapper around the Collection<T>.
(Inherited from Collection<XmlCommentsFile>)
RaiseListChangedEventsGets or sets a value indicating whether adding or removing items within the list raises ListChanged events.
(Inherited from BindingList<XmlCommentsFile>)
SortDirectionCoreGets the direction the list is sorted.
(Inherited from BindingList<XmlCommentsFile>)
SortPropertyCoreGets the property descriptor that is used for sorting the list if sorting is implemented in a derived class; otherwise, returns null.
(Inherited from BindingList<XmlCommentsFile>)
SupportsChangeNotificationCoreGets a value indicating whether ListChanged events are enabled.
(Inherited from BindingList<XmlCommentsFile>)
SupportsSearchingCoreGets a value indicating whether the list supports searching.
(Inherited from BindingList<XmlCommentsFile>)
SupportsSortingCoreGets a value indicating whether the list supports sorting.
(Inherited from BindingList<XmlCommentsFile>)

Methods

AddAdds an object to the end of the Collection<T>.
(Inherited from Collection<XmlCommentsFile>)
AddNewAdds a new item to the collection.
(Inherited from BindingList<XmlCommentsFile>)
AddNewCoreAdds a new item to the end of the collection.
(Inherited from BindingList<XmlCommentsFile>)
ApplySortCoreSorts the items if overridden in a derived class; otherwise, throws a NotSupportedException.
(Inherited from BindingList<XmlCommentsFile>)
CancelNewDiscards a pending new item.
(Inherited from BindingList<XmlCommentsFile>)
ClearRemoves all elements from the Collection<T>.
(Inherited from Collection<XmlCommentsFile>)
ClearItemsRemoves all elements from the collection.
(Inherited from BindingList<XmlCommentsFile>)
ContainsDetermines whether an element is in the Collection<T>.
(Inherited from Collection<XmlCommentsFile>)
CopyToCopies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from Collection<XmlCommentsFile>)
EndNewCommits a pending new item to the collection.
(Inherited from BindingList<XmlCommentsFile>)
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 BindingList<XmlCommentsFile>)
FindMember Search all comments files for the specified member. If not found, add the blank member to the first file.
GetEnumeratorReturns an enumerator that iterates through the Collection<T>.
(Inherited from Collection<XmlCommentsFile>)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetReferencedNamespaces This is used to get an enumerable list of unique namespaces referenced in the XML comments files
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 Collection<T>.
(Inherited from Collection<XmlCommentsFile>)
InsertInserts an element into the Collection<T> at the specified index.
(Inherited from Collection<XmlCommentsFile>)
InsertItemInserts the specified item in the list at the specified index.
(Inherited from BindingList<XmlCommentsFile>)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OnAddingNewRaises the AddingNew event.
(Inherited from BindingList<XmlCommentsFile>)
OnListChangedRaises the ListChanged event.
(Inherited from BindingList<XmlCommentsFile>)
RemoveRemoves the first occurrence of a specific object from the Collection<T>.
(Inherited from Collection<XmlCommentsFile>)
RemoveAtRemoves the element at the specified index of the Collection<T>.
(Inherited from Collection<XmlCommentsFile>)
RemoveItemRemoves the item at the specified index.
(Inherited from BindingList<XmlCommentsFile>)
RemoveSortCoreRemoves any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException.
(Inherited from BindingList<XmlCommentsFile>)
ReplaceNamespaceDocEntries This will search for all type member comments where the ID contains NamespaceDoc or NamespaceGroupDoc and convert them to namespace and namespace group entries for the containing namespace.
ResetBindingsRaises a ListChanged event of type Reset.
(Inherited from BindingList<XmlCommentsFile>)
ResetItemRaises a ListChanged event of type ItemChanged for the item at the specified position.
(Inherited from BindingList<XmlCommentsFile>)
Save Save the comments files
SetItemReplaces the item at the specified index with the specified item.
(Inherited from BindingList<XmlCommentsFile>)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Events

AddingNewOccurs before an item is added to the list.
(Inherited from BindingList<XmlCommentsFile>)
ListChangedOccurs when the list or an item in the list changes.
(Inherited from BindingList<XmlCommentsFile>)

See Also