Click or drag to resize
Sandcastle Help File BuilderTopicCollection Methods

The TopicCollection type exposes the following members.

Methods
  NameDescription
Public methodAdd (Inherited from CollectionTopic.)
Public methodAddNew
Adds a new item to the collection.
(Inherited from BindingListTopic.)
Protected methodAddNewCore
Adds a new item to the end of the collection.
(Inherited from BindingListTopic.)
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 BindingListTopic.)
Public methodCancelNew
Discards a pending new item.
(Inherited from BindingListTopic.)
Public methodClear (Inherited from CollectionTopic.)
Protected methodClearItems
Removes all elements from the collection.
(Inherited from BindingListTopic.)
Public methodContains (Inherited from CollectionTopic.)
Public methodCopyTo (Inherited from CollectionTopic.)
Public methodEndNew
Commits a pending new item to the collection.
(Inherited from BindingListTopic.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFind
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 BindingListTopic.)
Public methodGenerateConceptualTopics
This creates copies of the conceptual topic files in the build process's working folder.
Public methodGenerateTableOfContents
Generate the table of contents for the conceptual topics
Public methodGetEnumerator (Inherited from CollectionTopic.)
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 CollectionT.
(Inherited from CollectionTopic.)
Public methodInsert (Inherited from CollectionTopic.)
Protected methodInsertItem
This is overridden to set the inserted item's parent to this collection.
(Overrides BindingListTInsertItem(Int32, T).)
Public methodLoad
Load the collection from the related file
Public methodMatchProjectFilesToTopics
This gets all possible content files from the project and attempts to match them to the topics in the collection by ID.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAddingNew
Raises the AddingNew event.
(Inherited from BindingListTopic.)
Protected methodOnListChanged
Raises the ListChanged event.
(Inherited from BindingListTopic.)
Public methodRemove (Inherited from CollectionTopic.)
Public methodRemoveAt (Inherited from CollectionTopic.)
Protected methodRemoveItem
This is overridden to clear the parent on the removed item
(Overrides BindingListTRemoveItem(Int32).)
Protected methodRemoveSortCore
Removes any sort applied with ApplySortCore(PropertyDescriptor, ListSortDirection) if sorting is implemented in a derived class; otherwise, raises NotSupportedException.
(Inherited from BindingListTopic.)
Public methodResetBindings
Raises a ListChanged event of type Reset.
(Inherited from BindingListTopic.)
Public methodResetItem
Raises a ListChanged event of type ItemChanged for the item at the specified position.
(Inherited from BindingListTopic.)
Public methodSave
Save the topic collection to the related content layout file
Protected methodSetItem
This is overridden to set the inserted item's parent to this collection.
(Overrides BindingListTSetItem(Int32, T).)
Public methodSort
This is used to sort the collection
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also