NamespaceSummaryItemCollection Class

This collection class is used to hold the namespace summary items for a project

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionNamespaceSummaryItem
    System.ComponentModelBindingListNamespaceSummaryItem
      SandcastleBuilder.UtilsNamespaceSummaryItemCollection

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public class NamespaceSummaryItemCollection : BindingList<NamespaceSummaryItem>

Public Class NamespaceSummaryItemCollection
	Inherits BindingList(Of NamespaceSummaryItem)

public ref class NamespaceSummaryItemCollection : public BindingList<NamespaceSummaryItem^>

type NamespaceSummaryItemCollection =  
    class
        inherit BindingList<NamespaceSummaryItem>
    end

The NamespaceSummaryItemCollection type exposes the following members.

Constructors

	Name	Description
	NamespaceSummaryItemCollection	Constructor

Top

Methods

	Name	Description
	Add(T)	Adds an object to the end of the CollectionT. (Inherited from CollectionNamespaceSummaryItem.)
	Add(String, Boolean, Boolean, String)	Add a new item to the collection
	AddNew	Adds a new item to the collection. (Inherited from BindingListNamespaceSummaryItem.)
	AddNewCore	Adds a new item to the end of the collection. (Inherited from BindingListNamespaceSummaryItem.)
	ApplySortCore	Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException. (Inherited from BindingListNamespaceSummaryItem.)
	CancelNew	Discards a pending new item. (Inherited from BindingListNamespaceSummaryItem.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionNamespaceSummaryItem.)
	ClearItems	Removes all elements from the collection. (Inherited from BindingListNamespaceSummaryItem.)
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionNamespaceSummaryItem.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionNamespaceSummaryItem.)
	CreateTemporaryItem	Create a temporary item that isn't part of the project
	EndNew	Commits a pending new item to the collection. (Inherited from BindingListNamespaceSummaryItem.)
	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 BindingListNamespaceSummaryItem.)
	FromXml	This is used to load existing namespace summary items from the project file
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionNamespaceSummaryItem.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	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 CollectionT. (Inherited from CollectionNamespaceSummaryItem.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionNamespaceSummaryItem.)
	InsertItem	Inserts the specified item in the list at the specified index. (Inherited from BindingListNamespaceSummaryItem.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAddingNew	Raises the AddingNew event. (Inherited from BindingListNamespaceSummaryItem.)
	OnListChanged	This is overridden to mark the collection as dirty when it changes (Overrides BindingListTOnListChanged(ListChangedEventArgs).)
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionNamespaceSummaryItem.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionNamespaceSummaryItem.)
	RemoveItem	Removes the item at the specified index. (Inherited from BindingListNamespaceSummaryItem.)
	RemoveSortCore	Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException. (Inherited from BindingListNamespaceSummaryItem.)
	ResetBindings	Raises a ListChanged event of type Reset. (Inherited from BindingListNamespaceSummaryItem.)
	ResetItem	Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingListNamespaceSummaryItem.)
	SetItem	Replaces the item at the specified index with the specified item. (Inherited from BindingListNamespaceSummaryItem.)
	Sort	This is used to sort the namespace items by name
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ToXml	This is used to write the namespace summary info to an XML fragment ready for storing in the project file.

Top

Properties

	Name	Description
	AllowEdit	Gets or sets a value indicating whether items in the list can be edited. (Inherited from BindingListNamespaceSummaryItem.)
	AllowNew	Gets or sets a value indicating whether you can add items to the list using the AddNew method. (Inherited from BindingListNamespaceSummaryItem.)
	AllowRemove	Gets or sets a value indicating whether you can remove items from the collection. (Inherited from BindingListNamespaceSummaryItem.)
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionNamespaceSummaryItem.)
	IsDirty	This is used to get or set the dirty state of the collection
	IsSortedCore	Gets a value indicating whether the list is sorted. (Inherited from BindingListNamespaceSummaryItem.)
	ItemInt32	Gets or sets the element at the specified index. (Inherited from CollectionNamespaceSummaryItem.)
	ItemString	Indexer. This can be used to retrieve the summary information for the specified namespace
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionNamespaceSummaryItem.)
	Project	This is used to get a reference to the project that owns the collection
	RaiseListChangedEvents	Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events. (Inherited from BindingListNamespaceSummaryItem.)
	SortDirectionCore	Gets the direction the list is sorted. (Inherited from BindingListNamespaceSummaryItem.)
	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 BindingListNamespaceSummaryItem.)
	SupportsChangeNotificationCore	Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingListNamespaceSummaryItem.)
	SupportsSearchingCore	Gets a value indicating whether the list supports searching. (Inherited from BindingListNamespaceSummaryItem.)
	SupportsSortingCore	Gets a value indicating whether the list supports sorting. (Inherited from BindingListNamespaceSummaryItem.)

Top

Events

	Name	Description
	AddingNew	Occurs before an item is added to the list. (Inherited from BindingListNamespaceSummaryItem.)
	ListChanged	Occurs when the list or an item in the list changes. (Inherited from BindingListNamespaceSummaryItem.)

Top

Remarks

Namespaces that appear in the assemblies but not in this list are documented by default and will appear without a namespace summary.

Reference

SandcastleBuilder.Utils Namespace