Table of Contents

ApiFilterCollection Class

Definition

Namespace
Sandcastle.Core.Project
Assembly
Sandcastle.Core.dll

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

public class ApiFilterCollection : List<ApiFilter>, IList<ApiFilter>, ICollection<ApiFilter>, IReadOnlyList<ApiFilter>, IReadOnlyCollection<ApiFilter>, IEnumerable<ApiFilter>, IList, ICollection, IEnumerable
Inheritance
ApiFilterCollection
Implements

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.

Properties

Capacity (Inherited from List<ApiFilter>)
Count (Inherited from List<ApiFilter>)
Project

This is used to get or set a reference to the project that owns the collection
this[int] (Inherited from List<ApiFilter>)

Methods

Add(T) (Inherited from List<ApiFilter>)
AddNamespaceChild(string, string, string, string)

Add a new type entry to this namespace collection
AddRange(IEnumerable<T>) (Inherited from List<ApiFilter>)
AddTypeChild(string, string, string)

Add a new member entry to this type collection
AsReadOnly() (Inherited from List<ApiFilter>)
BinarySearch(T) (Inherited from List<ApiFilter>)
BinarySearch(T, IComparer<T>) (Inherited from List<ApiFilter>)
BinarySearch(int, int, T, IComparer<T>) (Inherited from List<ApiFilter>)
Clear() (Inherited from List<ApiFilter>)
Contains(T) (Inherited from List<ApiFilter>)
ConvertAll<TOutput>(Converter<T, TOutput>) (Inherited from List<ApiFilter>)
CopyTo(T[]) (Inherited from List<ApiFilter>)
CopyTo(T[], int) (Inherited from List<ApiFilter>)
CopyTo(int, T[], int, int) (Inherited from List<ApiFilter>)
Exists(Predicate<T>) (Inherited from List<ApiFilter>)
Find(Predicate<T>) (Inherited from List<ApiFilter>)
FindAll(Predicate<T>) (Inherited from List<ApiFilter>)
FindIndex(int, int, Predicate<T>) (Inherited from List<ApiFilter>)
FindIndex(int, Predicate<T>) (Inherited from List<ApiFilter>)
FindIndex(Predicate<T>) (Inherited from List<ApiFilter>)
FindLast(Predicate<T>) (Inherited from List<ApiFilter>)
FindLastIndex(int, int, Predicate<T>) (Inherited from List<ApiFilter>)
FindLastIndex(int, Predicate<T>) (Inherited from List<ApiFilter>)
FindLastIndex(Predicate<T>) (Inherited from List<ApiFilter>)
ForEach(Action<T>) (Inherited from List<ApiFilter>)
FromXml(string)

This is used to load existing API filter items from the project file
GetEnumerator() (Inherited from List<ApiFilter>)
GetRange(int, int) (Inherited from List<ApiFilter>)
IndexOf(T) (Inherited from List<ApiFilter>)
IndexOf(T, int) (Inherited from List<ApiFilter>)
IndexOf(T, int, int) (Inherited from List<ApiFilter>)
Insert(int, T) (Inherited from List<ApiFilter>)
InsertRange(int, IEnumerable<T>) (Inherited from List<ApiFilter>)
LastIndexOf(T) (Inherited from List<ApiFilter>)
LastIndexOf(T, int) (Inherited from List<ApiFilter>)
LastIndexOf(T, int, int) (Inherited from List<ApiFilter>)
MergeExclusionEntry(ApiEntryType, string)

This is used to merge an exclusion entry with the filter collection
Remove(T) (Inherited from List<ApiFilter>)
RemoveAll(Predicate<T>) (Inherited from List<ApiFilter>)
RemoveAt(int) (Inherited from List<ApiFilter>)
RemoveRange(int, int) (Inherited from List<ApiFilter>)
Reverse() (Inherited from List<ApiFilter>)
Reverse(int, int) (Inherited from List<ApiFilter>)
Sort() (Inherited from List<ApiFilter>)
Sort(Comparison<T>) (Inherited from List<ApiFilter>)
Sort(IComparer<T>) (Inherited from List<ApiFilter>)
Sort(int, int, IComparer<T>) (Inherited from List<ApiFilter>)
ToArray() (Inherited from List<ApiFilter>)
ToString()

Convert the API filter entry and its children to a string
ToXml()

This is used to write the API filter info to an XML fragment ready for storing in the project file
TrimExcess() (Inherited from List<ApiFilter>)
TrueForAll(Predicate<T>) (Inherited from List<ApiFilter>)
Edit this page