Sandcastle Help File Builder Documentation
Namespace
This collection class is used to hold the namespace summary items for a project
Definition
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
C#
public class NamespaceSummaryItemCollection : List<NamespaceSummaryItem>VB
Public Class NamespaceSummaryItemCollection
Inherits List(Of NamespaceSummaryItem)C++
public ref class NamespaceSummaryItemCollection : public List<NamespaceSummaryItem^>F#
type NamespaceSummaryItemCollection =
class
inherit List<NamespaceSummaryItem>
end- Inheritance
- Object ListNamespaceSummaryItem NamespaceSummaryItemCollection
Remarks
Namespaces that appear in the assemblies but not in this list are documented by default and
will appear without a namespace summary.
Constructors
| NamespaceSummaryItemCollection | Initializes a new instance of the NamespaceSummaryItemCollection class |
Properties
| Capacity | Gets or sets the total number of elements the internal data structure can hold without resizing. (Inherited from ListNamespaceSummaryItem) |
| Count | Gets the number of elements contained in the ListT. (Inherited from ListNamespaceSummaryItem) |
| ItemInt32 | Gets or sets the element at the specified index. (Inherited from ListNamespaceSummaryItem) |
| ItemString | Indexer. This can be used to retrieve the summary information for the specified namespace |
| Project | This is used to get or set a reference to the project that owns the collection |
Methods
| Add(T) | Adds an object to the end of the ListT. (Inherited from ListNamespaceSummaryItem) |
| Add(String, Boolean, Boolean, String) | Add a new item to the collection |
| AddRange | Adds the elements of the specified collection to the end of the ListT. (Inherited from ListNamespaceSummaryItem) |
| AsReadOnly | Returns a read-only ReadOnlyCollectionT wrapper for the current collection. (Inherited from ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| Clear | Removes all elements from the ListT. (Inherited from ListNamespaceSummaryItem) |
| Contains | Determines whether an element is in the ListT. (Inherited from ListNamespaceSummaryItem) |
| ConvertAllTOutput | Converts the elements in the current ListT to another type, and returns a list containing the converted elements. (Inherited from ListNamespaceSummaryItem) |
| CopyTo(T) | Copies the entire ListT to a compatible one-dimensional array, starting at the beginning of the target array. (Inherited from ListNamespaceSummaryItem) |
| CopyTo(T, Int32) | Copies the entire ListT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| CreateTemporaryItem | Create a temporary item that isn't part of the project |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Exists | Determines whether the ListT contains elements that match the conditions defined by the specified predicate. (Inherited from ListNamespaceSummaryItem) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Find | Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire ListT. (Inherited from ListNamespaceSummaryItem) |
| FindAll | Retrieves all the elements that match the conditions defined by the specified predicate. (Inherited from ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| FindLast | Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire ListT. (Inherited from ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| ForEach | Performs the specified action on each element of the ListT. (Inherited from ListNamespaceSummaryItem) |
| FromXml | This is used to load existing namespace summary items from the project file |
| GetEnumerator | Returns an enumerator that iterates through the ListT. (Inherited from ListNamespaceSummaryItem) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetRange | Creates a shallow copy of a range of elements in the source ListT. (Inherited from ListNamespaceSummaryItem) |
| GetType | Gets 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 ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| Insert | Inserts an element into the ListT at the specified index. (Inherited from ListNamespaceSummaryItem) |
| InsertRange | Inserts the elements of a collection into the ListT at the specified index. (Inherited from ListNamespaceSummaryItem) |
| LastIndexOf(T) | Searches for the specified object and returns the zero-based index of the last occurrence within the entire ListT. (Inherited from ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| 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 ListNamespaceSummaryItem) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Remove | Removes the first occurrence of a specific object from the ListT. (Inherited from ListNamespaceSummaryItem) |
| RemoveAll | Removes all the elements that match the conditions defined by the specified predicate. (Inherited from ListNamespaceSummaryItem) |
| RemoveAt | Removes the element at the specified index of the ListT. (Inherited from ListNamespaceSummaryItem) |
| RemoveRange | Removes a range of elements from the ListT. (Inherited from ListNamespaceSummaryItem) |
| Reverse | Reverses the order of the elements in the entire ListT. (Inherited from ListNamespaceSummaryItem) |
| Reverse(Int32, Int32) | Reverses the order of the elements in the specified range. (Inherited from ListNamespaceSummaryItem) |
| Sort | Sorts the elements in the entire ListT using the default comparer. (Inherited from ListNamespaceSummaryItem) |
| Sort(ComparisonT) | Sorts the elements in the entire ListT using the specified ComparisonT. (Inherited from ListNamespaceSummaryItem) |
| Sort(IComparerT) | Sorts the elements in the entire ListT using the specified comparer. (Inherited from ListNamespaceSummaryItem) |
| Sort(Int32, Int32, IComparerT) | Sorts the elements in a range of elements in ListT using the specified comparer. (Inherited from ListNamespaceSummaryItem) |
| ToArray | Copies the elements of the ListT to a new array. (Inherited from ListNamespaceSummaryItem) |
| 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. |
| TrimExcess | Sets the capacity to the actual number of elements in the ListT, if that number is less than a threshold value. (Inherited from ListNamespaceSummaryItem) |
| TrueForAll | Determines whether every element in the ListT matches the conditions defined by the specified predicate. (Inherited from ListNamespaceSummaryItem) |