ApiFilterCollection Class

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

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
public class ApiFilterCollection : List<ApiFilter>
Inheritance
Object    ListApiFilter    ApiFilterCollection

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.

Constructors

ApiFilterCollectionInitializes a new instance of the ApiFilterCollection class

Properties

CapacityGets or sets the total number of elements the internal data structure can hold without resizing.
(Inherited from ListApiFilter)
CountGets the number of elements contained in the ListT.
(Inherited from ListApiFilter)
ItemGets or sets the element at the specified index.
(Inherited from ListApiFilter)
Project This is used to get or set a reference to the project that owns the collection

Methods

AddAdds an object to the end of the ListT.
(Inherited from ListApiFilter)
AddNamespaceChild Add a new type entry to this namespace collection
AddRangeAdds the elements of the specified collection to the end of the ListT.
(Inherited from ListApiFilter)
AddTypeChild Add a new member entry to this type collection
AsReadOnlyReturns a read-only ReadOnlyCollectionT wrapper for the current collection.
(Inherited from ListApiFilter)
BinarySearch(T)Searches the entire sorted ListT for an element using the default comparer and returns the zero-based index of the element.
(Inherited from ListApiFilter)
BinarySearch(T, IComparerT)Searches the entire sorted ListT for an element using the specified comparer and returns the zero-based index of the element.
(Inherited from ListApiFilter)
BinarySearch(Int32, Int32, T, IComparerT)Searches a range of elements in the sorted ListT for an element using the specified comparer and returns the zero-based index of the element.
(Inherited from ListApiFilter)
ClearRemoves all elements from the ListT.
(Inherited from ListApiFilter)
ContainsDetermines whether an element is in the ListT.
(Inherited from ListApiFilter)
ConvertAllTOutputConverts the elements in the current ListT to another type, and returns a list containing the converted elements.
(Inherited from ListApiFilter)
CopyTo(T)Copies the entire ListT to a compatible one-dimensional array, starting at the beginning of the target array.
(Inherited from ListApiFilter)
CopyTo(T, Int32)Copies the entire ListT to a compatible one-dimensional array, starting at the specified index of the target array.
(Inherited from ListApiFilter)
CopyTo(Int32, T, Int32, Int32)Copies a range of elements from the ListT to a compatible one-dimensional array, starting at the specified index of the target array.
(Inherited from ListApiFilter)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
ExistsDetermines whether the ListT contains elements that match the conditions defined by the specified predicate.
(Inherited from ListApiFilter)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
FindSearches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire ListT.
(Inherited from ListApiFilter)
FindAllRetrieves all the elements that match the conditions defined by the specified predicate.
(Inherited from ListApiFilter)
FindIndex(PredicateT)Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire ListT.
(Inherited from ListApiFilter)
FindIndex(Int32, PredicateT)Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the ListT that extends from the specified index to the last element.
(Inherited from ListApiFilter)
FindIndex(Int32, Int32, PredicateT)Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the ListT that starts at the specified index and contains the specified number of elements.
(Inherited from ListApiFilter)
FindLastSearches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire ListT.
(Inherited from ListApiFilter)
FindLastIndex(PredicateT)Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire ListT.
(Inherited from ListApiFilter)
FindLastIndex(Int32, PredicateT)Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the ListT that extends from the first element to the specified index.
(Inherited from ListApiFilter)
FindLastIndex(Int32, Int32, PredicateT)Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the ListT that contains the specified number of elements and ends at the specified index.
(Inherited from ListApiFilter)
ForEachPerforms the specified action on each element of the ListT.
(Inherited from ListApiFilter)
FromXml This is used to load existing API filter items from the project file
GetEnumeratorReturns an enumerator that iterates through the ListT.
(Inherited from ListApiFilter)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetRangeCreates a shallow copy of a range of elements in the source ListT.
(Inherited from ListApiFilter)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IndexOf(T)Searches for the specified object and returns the zero-based index of the first occurrence within the entire ListT.
(Inherited from ListApiFilter)
IndexOf(T, Int32)Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the ListT that extends from the specified index to the last element.
(Inherited from ListApiFilter)
IndexOf(T, Int32, Int32)Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the ListT that starts at the specified index and contains the specified number of elements.
(Inherited from ListApiFilter)
InsertInserts an element into the ListT at the specified index.
(Inherited from ListApiFilter)
InsertRangeInserts the elements of a collection into the ListT at the specified index.
(Inherited from ListApiFilter)
LastIndexOf(T)Searches for the specified object and returns the zero-based index of the last occurrence within the entire ListT.
(Inherited from ListApiFilter)
LastIndexOf(T, Int32)Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the ListT that extends from the first element to the specified index.
(Inherited from ListApiFilter)
LastIndexOf(T, Int32, Int32)Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the ListT that contains the specified number of elements and ends at the specified index.
(Inherited from ListApiFilter)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
MergeExclusionEntry This is used to merge an exclusion entry with the filter collection
RemoveRemoves the first occurrence of a specific object from the ListT.
(Inherited from ListApiFilter)
RemoveAllRemoves all the elements that match the conditions defined by the specified predicate.
(Inherited from ListApiFilter)
RemoveAtRemoves the element at the specified index of the ListT.
(Inherited from ListApiFilter)
RemoveRangeRemoves a range of elements from the ListT.
(Inherited from ListApiFilter)
ReverseReverses the order of the elements in the entire ListT.
(Inherited from ListApiFilter)
Reverse(Int32, Int32)Reverses the order of the elements in the specified range.
(Inherited from ListApiFilter)
SortSorts the elements in the entire ListT using the default comparer.
(Inherited from ListApiFilter)
Sort(ComparisonT)Sorts the elements in the entire ListT using the specified ComparisonT.
(Inherited from ListApiFilter)
Sort(IComparerT)Sorts the elements in the entire ListT using the specified comparer.
(Inherited from ListApiFilter)
Sort(Int32, Int32, IComparerT)Sorts the elements in a range of elements in ListT using the specified comparer.
(Inherited from ListApiFilter)
ToArrayCopies the elements of the ListT to a new array.
(Inherited from ListApiFilter)
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
TrimExcessSets the capacity to the actual number of elements in the ListT, if that number is less than a threshold value.
(Inherited from ListApiFilter)
TrueForAllDetermines whether every element in the ListT matches the conditions defined by the specified predicate.
(Inherited from ListApiFilter)

See Also