 | TocEntryCollection Class |
This collection class is used to hold the table of contents entries for additional content items
Inheritance HierarchySystemObject
System.Collections.ObjectModelCollectionTocEntry
System.ComponentModelBindingListTocEntry
SandcastleBuilder.Utils.ConceptualContentTocEntryCollection
System.Collections.ObjectModelCollectionTocEntry
System.ComponentModelBindingListTocEntry
SandcastleBuilder.Utils.ConceptualContentTocEntryCollection
Namespace: SandcastleBuilder.Utils.ConceptualContent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
SyntaxThe TocEntryCollection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TocEntryCollection |
Default constructor
|
| TocEntryCollection(FileItem) |
Constructor
|
Methods| Name | Description | |
|---|---|---|
| Add | Adds an object to the end of the CollectionT. (Inherited from CollectionTocEntry.) |
| AddNew | Adds a new item to the collection. (Inherited from BindingListTocEntry.) |
 | AddNewCore | Adds a new item to the end of the collection. (Inherited from BindingListTocEntry.) |
| AddTopicsFromFolder |
Add all topics from the specified folder recursively to the
collection and to the given project file.
|
| All |
This is used to enumerate all topics recursively
|
| ApplySortCore | Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException. (Inherited from BindingListTocEntry.) |
| CancelNew | Discards a pending new item. (Inherited from BindingListTocEntry.) |
| Clear | Removes all elements from the CollectionT. (Inherited from CollectionTocEntry.) |
| ClearItems | Removes all elements from the collection. (Inherited from BindingListTocEntry.) |
| Contains | Determines whether an element is in the CollectionT. (Inherited from CollectionTocEntry.) |
| CopyTo | Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionTocEntry.) |
| EndNew | Commits a pending new item to the collection. (Inherited from BindingListTocEntry.) |
| Equals | (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.) |
| Find(String) |
Find a TOC entry with the same source filename
|
| Find(PredicateTocEntry, Boolean) |
This is used to find all topics and sub-topics that match the specified predicate recursively
|
| 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 BindingListTocEntry.) |
| FindDefaultTopic |
This is used to locate the default topic if one exists
|
| GenerateTableOfContents |
This is used to merge this TOC with another one
|
| GetEnumerator | Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionTocEntry.) |
| 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 CollectionTocEntry.) |
| Insert | Inserts an element into the CollectionT at the specified index. (Inherited from CollectionTocEntry.) |
| InsertItem |
This is overridden to set the inserted item's parent to this
collection.
(Overrides BindingListTInsertItem(Int32, T).) |
| Load |
This is used to load the table of contents entries from the site
map file associated with the collection.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnAddingNew | Raises the AddingNew event. (Inherited from BindingListTocEntry.) |
| OnListChanged | Raises the ListChanged event. (Inherited from BindingListTocEntry.) |
| Remove | Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionTocEntry.) |
| RemoveAt | Removes the element at the specified index of the CollectionT. (Inherited from CollectionTocEntry.) |
| RemoveExcludedNodes |
This will remove excluded nodes from a TOC created off of the
additional content items in a project. In addition, it merges
the information from folder entries into the folder nodes.
|
| RemoveItem |
This is overridden to clear the parent on the removed item
(Overrides BindingListTRemoveItem(Int32).) |
| RemoveSortCore | Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException. (Inherited from BindingListTocEntry.) |
| ResetBindings | Raises a ListChanged event of type Reset. (Inherited from BindingListTocEntry.) |
| ResetItem | Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingListTocEntry.) |
| ResetSortOrder |
Reset the sort order on all items in the collection
|
| Save |
This is used to save the table of contents entries to the site map
file associated with the collection.
|
| SaveToIntermediateTocFile |
This is used to save the TOC information to an intermediate TOC file used in the conceptual content
build.
|
| SetItem |
This is overridden to set the inserted item's parent to this
collection.
(Overrides BindingListTSetItem(Int32, T).) |
| Sort |
This is used to sort the collection
|
| ToString |
Convert the table of contents entry and its children to a string
(Overrides ObjectToString.) |
| ToString(HelpFileFormats) |
Convert the table of contents entry and its children to a string
in the specified help file format.
|
Properties| Name | Description | |
|---|---|---|
 | AllowEdit | Gets or sets a value indicating whether items in the list can be edited. (Inherited from BindingListTocEntry.) |
| AllowNew | Gets or sets a value indicating whether you can add items to the list using the AddNew method. (Inherited from BindingListTocEntry.) |
| AllowRemove | Gets or sets a value indicating whether you can remove items from the collection. (Inherited from BindingListTocEntry.) |
| ApiContentInsertionPoint |
This is used to get the topic at which the API table of contents is
to be inserted or parented.
|
| ApiContentParent |
This is used to get the parent item that will contain the API table
of contents.
|
| ApiContentParentCollection |
This is used to get the parent collection that contains the item
where the API table of contents is to be inserted.
|
| ContentLayoutFile |
This is used to get the site map file associated with the
collection.
|
| Count | Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionTocEntry.) |
| DefaultTopic |
This is used to get the default topic
|
| FileItem |
This read-only property returns the project file item associated
with the collection.
|
 | IsSortedCore | Gets a value indicating whether the list is sorted. (Inherited from BindingListTocEntry.) |
| ItemInt32 | Gets or sets the element at the specified index. (Inherited from CollectionTocEntry.) |
| ItemString |
This can be used to get a topic by its unique ID (case-insensitive)
|
| Items | Gets a IListT wrapper around the CollectionT. (Inherited from CollectionTocEntry.) |
| RaiseListChangedEvents | Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events. (Inherited from BindingListTocEntry.) |
| SortDirectionCore | Gets the direction the list is sorted. (Inherited from BindingListTocEntry.) |
| 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 BindingListTocEntry.) |
| SupportsChangeNotificationCore | Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingListTocEntry.) |
| SupportsSearchingCore | Gets a value indicating whether the list supports searching. (Inherited from BindingListTocEntry.) |
| SupportsSortingCore | Gets a value indicating whether the list supports sorting. (Inherited from BindingListTocEntry.) |
Events| Name | Description | |
|---|---|---|
 | AddingNew | Occurs before an item is added to the list. (Inherited from BindingListTocEntry.) |
| ListChanged | Occurs when the list or an item in the list changes. (Inherited from BindingListTocEntry.) |
See Also