Sandcastle Help File Builder Documentation
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
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
C#
public class XmlCommentsFileCollection : BindingList<XmlCommentsFile>VB
Public Class XmlCommentsFileCollection
Inherits BindingList(Of XmlCommentsFile)C++
public ref class XmlCommentsFileCollection : public BindingList<XmlCommentsFile^>F#
type XmlCommentsFileCollection =
class
inherit BindingList<XmlCommentsFile>
end- Inheritance
- Object Collection<XmlCommentsFile> BindingList<XmlCommentsFile> XmlCommentsFileCollection
Constructors
| XmlCommentsFileCollection | Initializes a new instance of the XmlCommentsFileCollection class |
Properties
| AllowEdit | Gets or sets a value indicating whether items in the list can be edited. (Inherited from BindingList<XmlCommentsFile>) |
| AllowNew | Gets or sets a value indicating whether you can add items to the list using the AddNew() method. (Inherited from BindingList<XmlCommentsFile>) |
| AllowRemove | Gets 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. |
| Count | Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<XmlCommentsFile>) |
| IsSortedCore | Gets a value indicating whether the list is sorted. (Inherited from BindingList<XmlCommentsFile>) |
| Item | Gets or sets the element at the specified index. (Inherited from Collection<XmlCommentsFile>) |
| Items | Gets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<XmlCommentsFile>) |
| RaiseListChangedEvents | Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events. (Inherited from BindingList<XmlCommentsFile>) |
| SortDirectionCore | Gets the direction the list is sorted. (Inherited from BindingList<XmlCommentsFile>) |
| 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 BindingList<XmlCommentsFile>) |
| SupportsChangeNotificationCore | Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingList<XmlCommentsFile>) |
| SupportsSearchingCore | Gets a value indicating whether the list supports searching. (Inherited from BindingList<XmlCommentsFile>) |
| SupportsSortingCore | Gets a value indicating whether the list supports sorting. (Inherited from BindingList<XmlCommentsFile>) |
Methods
| Add | Adds an object to the end of the Collection<T>. (Inherited from Collection<XmlCommentsFile>) |
| AddNew | Adds a new item to the collection. (Inherited from BindingList<XmlCommentsFile>) |
| AddNewCore | Adds a new item to the end of the collection. (Inherited from BindingList<XmlCommentsFile>) |
| ApplySortCore | Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException. (Inherited from BindingList<XmlCommentsFile>) |
| CancelNew | Discards a pending new item. (Inherited from BindingList<XmlCommentsFile>) |
| Clear | Removes all elements from the Collection<T>. (Inherited from Collection<XmlCommentsFile>) |
| ClearItems | Removes all elements from the collection. (Inherited from BindingList<XmlCommentsFile>) |
| Contains | Determines whether an element is in the Collection<T>. (Inherited from Collection<XmlCommentsFile>) |
| CopyTo | Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<XmlCommentsFile>) |
| EndNew | Commits a pending new item to the collection. (Inherited from BindingList<XmlCommentsFile>) |
| 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 BindingList<XmlCommentsFile>) |
| FindMember | Search all comments files for the specified member. If not found, add the blank member to the first file. |
| GetEnumerator | Returns an enumerator that iterates through the Collection<T>. (Inherited from Collection<XmlCommentsFile>) |
| GetHashCode | Serves 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 |
| 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 Collection<T>. (Inherited from Collection<XmlCommentsFile>) |
| Insert | Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<XmlCommentsFile>) |
| InsertItem | Inserts the specified item in the list at the specified index. (Inherited from BindingList<XmlCommentsFile>) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnAddingNew | Raises the AddingNew event. (Inherited from BindingList<XmlCommentsFile>) |
| OnListChanged | Raises the ListChanged event. (Inherited from BindingList<XmlCommentsFile>) |
| Remove | Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<XmlCommentsFile>) |
| RemoveAt | Removes the element at the specified index of the Collection<T>. (Inherited from Collection<XmlCommentsFile>) |
| RemoveItem | Removes the item at the specified index. (Inherited from BindingList<XmlCommentsFile>) |
| RemoveSortCore | Removes 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. |
| ResetBindings | Raises a ListChanged event of type Reset. (Inherited from BindingList<XmlCommentsFile>) |
| ResetItem | Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingList<XmlCommentsFile>) |
| Save | Save the comments files |
| SetItem | Replaces the item at the specified index with the specified item. (Inherited from BindingList<XmlCommentsFile>) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events
| AddingNew | Occurs before an item is added to the list. (Inherited from BindingList<XmlCommentsFile>) |
| ListChanged | Occurs when the list or an item in the list changes. (Inherited from BindingList<XmlCommentsFile>) |