XmlCommentsFileCollection Class

Definition

Namespace

Sandcastle.Core.BuildEngine

Assembly

Sandcastle.Core.dll

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

public class XmlCommentsFileCollection : BindingList<XmlCommentsFile>, IList<XmlCommentsFile>, ICollection<XmlCommentsFile>, IReadOnlyList<XmlCommentsFile>, IReadOnlyCollection<XmlCommentsFile>, IEnumerable<XmlCommentsFile>, IBindingList, IList, ICollection, IEnumerable, ICancelAddNew, IRaiseItemChangedEvents

Inheritance

object

Collection<XmlCommentsFile>

BindingList<XmlCommentsFile>

XmlCommentsFileCollection

Implements

IList<XmlCommentsFile>

ICollection<XmlCommentsFile>

IReadOnlyList<XmlCommentsFile>

IReadOnlyCollection<XmlCommentsFile>

IEnumerable<XmlCommentsFile>

IBindingList

IList

ICollection

IEnumerable

ICancelAddNew

IRaiseItemChangedEvents

Properties

AddingNew	(Inherited from BindingList<XmlCommentsFile>)
AllowEdit	(Inherited from BindingList<XmlCommentsFile>)
AllowNew	(Inherited from BindingList<XmlCommentsFile>)
AllowRemove	(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.
Count	(Inherited from Collection<XmlCommentsFile>)
IsSortedCore	(Inherited from BindingList<XmlCommentsFile>)
Items	(Inherited from Collection<XmlCommentsFile>)
ListChanged	(Inherited from BindingList<XmlCommentsFile>)
RaiseListChangedEvents	(Inherited from BindingList<XmlCommentsFile>)
SortDirectionCore	(Inherited from BindingList<XmlCommentsFile>)
SortPropertyCore	(Inherited from BindingList<XmlCommentsFile>)
SupportsChangeNotificationCore	(Inherited from BindingList<XmlCommentsFile>)
SupportsSearchingCore	(Inherited from BindingList<XmlCommentsFile>)
SupportsSortingCore	(Inherited from BindingList<XmlCommentsFile>)
this[int]	(Inherited from Collection<XmlCommentsFile>)

Methods

Add(T)	(Inherited from Collection<XmlCommentsFile>)
AddNew()	(Inherited from BindingList<XmlCommentsFile>)
AddNewCore()	(Inherited from BindingList<XmlCommentsFile>)
ApplySortCore(PropertyDescriptor, ListSortDirection)	(Inherited from BindingList<XmlCommentsFile>)
CancelNew(int)	(Inherited from BindingList<XmlCommentsFile>)
Clear()	(Inherited from Collection<XmlCommentsFile>)
ClearItems()	(Inherited from BindingList<XmlCommentsFile>)
CommentFileList(string)	Returns a list of the comment file paths in a format suitable for inserting into a Sandcastle configuration file.
Contains(T)	(Inherited from Collection<XmlCommentsFile>)
CopyTo(T[], int)	(Inherited from Collection<XmlCommentsFile>)
EndNew(int)	(Inherited from BindingList<XmlCommentsFile>)
FindCore(PropertyDescriptor, object)	(Inherited from BindingList<XmlCommentsFile>)
FindMember(string)	Search all comments files for the specified member. If not found, add the blank member to the first file.
GetEnumerator()	(Inherited from Collection<XmlCommentsFile>)
GetReferencedNamespaces(IEnumerable<string>)	This is used to get an enumerable list of unique namespaces referenced in the XML comments files
IndexOf(T)	(Inherited from Collection<XmlCommentsFile>)
Insert(int, T)	(Inherited from Collection<XmlCommentsFile>)
InsertItem(int, T)	(Inherited from BindingList<XmlCommentsFile>)
OnAddingNew(AddingNewEventArgs)	(Inherited from BindingList<XmlCommentsFile>)
OnListChanged(ListChangedEventArgs)	(Inherited from BindingList<XmlCommentsFile>)
Remove(T)	(Inherited from Collection<XmlCommentsFile>)
RemoveAt(int)	(Inherited from Collection<XmlCommentsFile>)
RemoveItem(int)	(Inherited from BindingList<XmlCommentsFile>)
RemoveSortCore()	(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.
ResetBindings()	(Inherited from BindingList<XmlCommentsFile>)
ResetItem(int)	(Inherited from BindingList<XmlCommentsFile>)
Save()	Save the comments files
SetItem(int, T)	(Inherited from BindingList<XmlCommentsFile>)