Click or drag to resize
Sandcastle Help File BuilderXmlCommentsFileCollection Class
This collection class is used to hold the XML comments files during the build process
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionXmlCommentsFile
    System.ComponentModelBindingListXmlCommentsFile
      SandcastleBuilder.Utils.BuildEngineXmlCommentsFileCollection

Namespace: SandcastleBuilder.Utils.BuildEngine
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax
Copy
public class XmlCommentsFileCollection : BindingList<XmlCommentsFile>

The XmlCommentsFileCollection type exposes the following members.

Constructors
  NameDescription
Public methodXmlCommentsFileCollection
Initializes a new instance of the XmlCommentsFileCollection class
Top
Methods
  NameDescription
Public methodAdd
Adds an object to the end of the CollectionT.
(Inherited from CollectionXmlCommentsFile.)
Public methodAddNew
Adds a new item to the collection.
(Inherited from BindingListXmlCommentsFile.)
Protected methodAddNewCore
Adds a new item to the end of the collection.
(Inherited from BindingListXmlCommentsFile.)
Protected methodApplySortCore
Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException.
(Inherited from BindingListXmlCommentsFile.)
Public methodCancelNew
Discards a pending new item.
(Inherited from BindingListXmlCommentsFile.)
Public methodClear
Removes all elements from the CollectionT.
(Inherited from CollectionXmlCommentsFile.)
Protected methodClearItems
Removes all elements from the collection.
(Inherited from BindingListXmlCommentsFile.)
Public methodContains
Determines whether an element is in the CollectionT.
(Inherited from CollectionXmlCommentsFile.)
Public methodCopyTo
Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from CollectionXmlCommentsFile.)
Public methodEndNew
Commits a pending new item to the collection.
(Inherited from BindingListXmlCommentsFile.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodFindCore
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 BindingListXmlCommentsFile.)
Public methodFindMember
Search all comments files for the specified member. If not found, add the blank member to the first file.
Public methodGetEnumerator
Returns an enumerator that iterates through the CollectionT.
(Inherited from CollectionXmlCommentsFile.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetReferencedNamespaces
This is used to get an enumerable list of unique namespaces referenced in the XML comments files
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire CollectionT.
(Inherited from CollectionXmlCommentsFile.)
Public methodInsert
Inserts an element into the CollectionT at the specified index.
(Inherited from CollectionXmlCommentsFile.)
Protected methodInsertItem
Inserts the specified item in the list at the specified index.
(Inherited from BindingListXmlCommentsFile.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAddingNew
Raises the AddingNew event.
(Inherited from BindingListXmlCommentsFile.)
Protected methodOnListChanged
Raises the ListChanged event.
(Inherited from BindingListXmlCommentsFile.)
Public methodRemove
Removes the first occurrence of a specific object from the CollectionT.
(Inherited from CollectionXmlCommentsFile.)
Public methodRemoveAt
Removes the element at the specified index of the CollectionT.
(Inherited from CollectionXmlCommentsFile.)
Protected methodRemoveItem
Removes the item at the specified index.
(Inherited from BindingListXmlCommentsFile.)
Protected methodRemoveSortCore
Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException.
(Inherited from BindingListXmlCommentsFile.)
Public methodReplaceNamespaceDocEntries
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.
Public methodResetBindings
Raises a ListChanged event of type Reset.
(Inherited from BindingListXmlCommentsFile.)
Public methodResetItem
Raises a ListChanged event of type ItemChanged for the item at the specified position.
(Inherited from BindingListXmlCommentsFile.)
Public methodSave
Save the comments files
Protected methodSetItem
Replaces the item at the specified index with the specified item.
(Inherited from BindingListXmlCommentsFile.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyAllowEdit
Gets or sets a value indicating whether items in the list can be edited.
(Inherited from BindingListXmlCommentsFile.)
Public propertyAllowNew
Gets or sets a value indicating whether you can add items to the list using the AddNew method.
(Inherited from BindingListXmlCommentsFile.)
Public propertyAllowRemove
Gets or sets a value indicating whether you can remove items from the collection.
(Inherited from BindingListXmlCommentsFile.)
Public propertyContainsInheritedDocumentation
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.
Public propertyCount
Gets the number of elements actually contained in the CollectionT.
(Inherited from CollectionXmlCommentsFile.)
Protected propertyIsSortedCore
Gets a value indicating whether the list is sorted.
(Inherited from BindingListXmlCommentsFile.)
Public propertyItem
Gets or sets the element at the specified index.
(Inherited from CollectionXmlCommentsFile.)
Protected propertyItems
Gets a IListT wrapper around the CollectionT.
(Inherited from CollectionXmlCommentsFile.)
Public propertyRaiseListChangedEvents
Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events.
(Inherited from BindingListXmlCommentsFile.)
Protected propertySortDirectionCore
Gets the direction the list is sorted.
(Inherited from BindingListXmlCommentsFile.)
Protected propertySortPropertyCore
Gets the property descriptor that is used for sorting the list if sorting is implemented in a derived class; otherwise, returns null.
(Inherited from BindingListXmlCommentsFile.)
Protected propertySupportsChangeNotificationCore
Gets a value indicating whether ListChanged events are enabled.
(Inherited from BindingListXmlCommentsFile.)
Protected propertySupportsSearchingCore
Gets a value indicating whether the list supports searching.
(Inherited from BindingListXmlCommentsFile.)
Protected propertySupportsSortingCore
Gets a value indicating whether the list supports sorting.
(Inherited from BindingListXmlCommentsFile.)
Top
Events
  NameDescription
Public eventAddingNew
Occurs before an item is added to the list.
(Inherited from BindingListXmlCommentsFile.)
Public eventListChanged
Occurs when the list or an item in the list changes.
(Inherited from BindingListXmlCommentsFile.)
Top
See Also