The TocEntryCollection type exposes the following members.

Constructors

  NameDescription
Public methodTocEntryCollection()()()()
Default constructor
Public methodTocEntryCollection(FileItem)
Constructor

Methods

  NameDescription
Public methodAdd
Adds an object to the end of the Collection<(Of <(<'T>)>)>.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public methodAddNew
Adds a new item to the collection.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Protected methodAddNewCore
Adds a new item to the end of the collection.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public methodAddTopicsFromFolder
Add all topics from the specified folder recursively to the collection and to the given project file.
Public methodAll
This is used to enumerate all topics recursively
Protected methodApplySortCore
Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public methodCancelNew
Discards a pending new item.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public methodClear
Removes all elements from the Collection<(Of <(<'T>)>)>.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Protected methodClearItems
Removes all elements from the collection.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public methodContains
Determines whether an element is in the Collection<(Of <(<'T>)>)>.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public methodCopyTo
Copies the entire Collection<(Of <(<'T>)>)> to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public methodEndNew
Commits a pending new item to the collection.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFind(String)
Find a TOC entry with the same source filename
Public methodFind(Predicate<(Of <<'(TocEntry>)>>), Boolean)
This is used to find all topics and sub-topics that match the specified predicate recursively
Protected methodFindCore
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 BindingList<(Of <(<'TocEntry>)>)>.)
Public methodFindDefaultTopic
This is used to locate the default topic if one exists
Public methodGenerateTableOfContents
This is used to merge this TOC with another one
Public methodGetEnumerator
Returns an enumerator that iterates through the Collection<(Of <(<'T>)>)>.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<(Of <(<'T>)>)>.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public methodInsert
Inserts an element into the Collection<(Of <(<'T>)>)> at the specified index.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Protected methodInsertItem
This is overridden to set the inserted item's parent to this collection.
(Overrides BindingList<(Of <(<'T>)>)>..::..InsertItem(Int32, T).)
Public methodLoad
This is used to load the table of contents entries from the site map file associated with the collection.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAddingNew
Raises the AddingNew event.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Protected methodOnListChanged
Raises the ListChanged event.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public methodRemove
Removes the first occurrence of a specific object from the Collection<(Of <(<'T>)>)>.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public methodRemoveAt
Removes the element at the specified index of the Collection<(Of <(<'T>)>)>.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public methodRemoveExcludedNodes
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.
Protected methodRemoveItem
This is overridden to clear the parent on the removed item
(Overrides BindingList<(Of <(<'T>)>)>..::..RemoveItem(Int32).)
Protected methodRemoveSortCore
Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public methodResetBindings
Raises a ListChanged event of type Reset.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public methodResetItem
Raises a ListChanged event of type ItemChanged for the item at the specified position.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public methodResetSortOrder
Reset the sort order on all items in the collection
Public methodSave
This is used to save the table of contents entries to the site map file associated with the collection.
Public methodSaveToIntermediateTocFile
This is used to save the TOC information to an intermediate TOC file used in the conceptual content build.
Protected methodSetItem
This is overridden to set the inserted item's parent to this collection.
(Overrides BindingList<(Of <(<'T>)>)>..::..SetItem(Int32, T).)
Public methodSort
This is used to sort the collection
Public methodToString()()()()
Convert the table of contents entry and its children to a string
(Overrides Object..::..ToString()()()().)
Public methodToString(HelpFileFormat)
Convert the table of contents entry and its children to a string in the specified help file format.

Properties

  NameDescription
Public propertyAllowEdit
Gets or sets a value indicating whether items in the list can be edited.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public propertyAllowNew
Gets or sets a value indicating whether you can add items to the list using the AddNew()()()() method.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public propertyAllowRemove
Gets or sets a value indicating whether you can remove items from the collection.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public propertyApiContentInsertionPoint
This is used to get the topic at which the API table of contents is to be inserted or parented.
Public propertyApiContentParent
This is used to get the parent item that will contain the API table of contents.
Public propertyApiContentParentCollection
This is used to get the parent collection that contains the item where the API table of contents is to be inserted.
Public propertyContentLayoutFile
This is used to get the site map file associated with the collection.
Public propertyCount
Gets the number of elements actually contained in the Collection<(Of <(<'T>)>)>.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public propertyDefaultTopic
This is used to get the default topic
Public propertyFileItem
This read-only property returns the project file item associated with the collection.
Protected propertyIsSortedCore
Gets a value indicating whether the list is sorted.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public propertyItem[([( Int32])])
Gets or sets the element at the specified index.
(Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public propertyItem[([( String])])
This can be used to get a topic by its unique ID (case-insensitive)
Protected propertyItems (Inherited from Collection<(Of <(<'TocEntry>)>)>.)
Public propertyRaiseListChangedEvents
Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Protected propertySortDirectionCore
Gets the direction the list is sorted.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Protected propertySortPropertyCore
Gets the property descriptor that is used for sorting the list if sorting is implemented in a derived class; otherwise, returns null.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Protected propertySupportsChangeNotificationCore
Gets a value indicating whether ListChanged events are enabled.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Protected propertySupportsSearchingCore
Gets a value indicating whether the list supports searching.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Protected propertySupportsSortingCore
Gets a value indicating whether the list supports sorting.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)

Events

  NameDescription
Public eventAddingNew
Occurs before an item is added to the list.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)
Public eventListChanged
Occurs when the list or an item in the list changes.
(Inherited from BindingList<(Of <(<'TocEntry>)>)>.)

See Also