ApiFilterCollection Class

This collection class is used to hold the API filter entries for MRefBuilder to remove

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionApiFilter
    System.ComponentModelBindingListApiFilter
      SandcastleBuilder.UtilsApiFilterCollection

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

Syntax

C++

Copy

public class ApiFilterCollection : BindingList<ApiFilter>, 
	ICloneable

Public Class ApiFilterCollection
	Inherits BindingList(Of ApiFilter)
	Implements ICloneable

public ref class ApiFilterCollection : public BindingList<ApiFilter^>, 
	ICloneable

type ApiFilterCollection =  
    class
        inherit BindingList<ApiFilter>
        interface ICloneable
    end

The ApiFilterCollection type exposes the following members.

Constructors

	Name	Description
	ApiFilterCollection	Constructor

Top

Methods

	Name	Description
	Add	Adds an object to the end of the CollectionT. (Inherited from CollectionApiFilter.)
	AddNamespaceChild	Add a new type entry to this namespace collection
	AddNew	Adds a new item to the collection. (Inherited from BindingListApiFilter.)
	AddNewCore	Adds a new item to the end of the collection. (Inherited from BindingListApiFilter.)
	AddTypeChild	Add a new member entry to this type collection
	ApplySortCore	Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException. (Inherited from BindingListApiFilter.)
	CancelNew	Discards a pending new item. (Inherited from BindingListApiFilter.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionApiFilter.)
	ClearItems	Removes all elements from the collection. (Inherited from BindingListApiFilter.)
	Clone	Clone the API filter collection
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionApiFilter.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionApiFilter.)
	EndNew	Commits a pending new item to the collection. (Inherited from BindingListApiFilter.)
	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 BindingListApiFilter.)
	FromXml	This is used to load existing API filter items from the project file.
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionApiFilter.)
	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 CollectionApiFilter.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionApiFilter.)
	InsertItem	Inserts the specified item in the list at the specified index. (Inherited from BindingListApiFilter.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MergeEntry	This is used to merge an entry with the filter collection
	OnAddingNew	Raises the AddingNew event. (Inherited from BindingListApiFilter.)
	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 CollectionApiFilter.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionApiFilter.)
	RemoveItem	Removes the item at the specified index. (Inherited from BindingListApiFilter.)
	RemoveSortCore	Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException. (Inherited from BindingListApiFilter.)
	ResetBindings	Raises a ListChanged event of type Reset. (Inherited from BindingListApiFilter.)
	ResetItem	Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingListApiFilter.)
	SetItem	Replaces the item at the specified index with the specified item. (Inherited from BindingListApiFilter.)
	Sort	This is used to sort the collection
	ToString	Convert the API filter entry and its children to a string (Overrides ObjectToString.)
	ToXml	This is used to write the API filter 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 BindingListApiFilter.)
	AllowNew	Gets or sets a value indicating whether you can add items to the list using the AddNew method. (Inherited from BindingListApiFilter.)
	AllowRemove	Gets or sets a value indicating whether you can remove items from the collection. (Inherited from BindingListApiFilter.)
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionApiFilter.)
	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 BindingListApiFilter.)
	Item	Gets or sets the element at the specified index. (Inherited from CollectionApiFilter.)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from CollectionApiFilter.)
	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 BindingListApiFilter.)
	SortDirectionCore	Gets the direction the list is sorted. (Inherited from BindingListApiFilter.)
	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 BindingListApiFilter.)
	SupportsChangeNotificationCore	Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingListApiFilter.)
	SupportsSearchingCore	Gets a value indicating whether the list supports searching. (Inherited from BindingListApiFilter.)
	SupportsSortingCore	Gets a value indicating whether the list supports sorting. (Inherited from BindingListApiFilter.)

Top

Events

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

Top

Remarks

Note
Unlike other collections in the project, this one is cleared and rebuilt if it changes. As such, the contained items do not notify the project when they change as they are created anew each time the collection is rebuilt.

Reference

SandcastleBuilder.Utils Namespace