TopicCollection Class

This collection class is used to hold the conceptual content topics for a project.

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionTopic
    System.ComponentModelBindingListTopic
      SandcastleBuilder.Utils.ConceptualContentTopicCollection

Namespace: SandcastleBuilder.Utils.ConceptualContent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public class TopicCollection : BindingList<Topic>, 
	ITableOfContents

Public Class TopicCollection
	Inherits BindingList(Of Topic)
	Implements ITableOfContents

public ref class TopicCollection : public BindingList<Topic^>, 
	ITableOfContents

type TopicCollection =  
    class
        inherit BindingList<Topic>
        interface ITableOfContents
    end

The TopicCollection type exposes the following members.

Constructors

	Name	Description
	TopicCollection	Constructor

Top

Methods

	Name	Description
	Add	Adds an object to the end of the CollectionT. (Inherited from CollectionTopic.)
	AddNew	Adds a new item to the collection. (Inherited from BindingListTopic.)
	AddNewCore	Adds a new item to the end of the collection. (Inherited from BindingListTopic.)
	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 BindingListTopic.)
	CancelNew	Discards a pending new item. (Inherited from BindingListTopic.)
	Clear	Removes all elements from the CollectionT. (Inherited from CollectionTopic.)
	ClearItems	Removes all elements from the collection. (Inherited from BindingListTopic.)
	Contains	Determines whether an element is in the CollectionT. (Inherited from CollectionTopic.)
	CopyTo	Copies the entire CollectionT to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionTopic.)
	EndNew	Commits a pending new item to the collection. (Inherited from BindingListTopic.)
	Equals	Determines whether the specified Object is equal to the current Object. (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	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 BindingListTopic.)
	GenerateConceptualTopics	This creates copies of the conceptual topic files in the build process's working folder.
	GenerateTableOfContents	Generate the table of contents for the conceptual topics
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from CollectionTopic.)
	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 CollectionTopic.)
	Insert	Inserts an element into the CollectionT at the specified index. (Inherited from CollectionTopic.)
	InsertItem	This is overridden to set the inserted item's parent to this collection. (Overrides BindingListTInsertItem(Int32, T).)
	Load	Load the collection from the related file
	MatchProjectFilesToTopics	This gets all possible content files from the project and attempts to match them to the topics in the collection by ID.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAddingNew	Raises the AddingNew event. (Inherited from BindingListTopic.)
	OnListChanged	Raises the ListChanged event. (Inherited from BindingListTopic.)
	Remove	Removes the first occurrence of a specific object from the CollectionT. (Inherited from CollectionTopic.)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from CollectionTopic.)
	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 BindingListTopic.)
	ResetBindings	Raises a ListChanged event of type Reset. (Inherited from BindingListTopic.)
	ResetItem	Raises a ListChanged event of type ItemChanged for the item at the specified position. (Inherited from BindingListTopic.)
	Save	Save the topic collection to the related content layout file
	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	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	AllowEdit	Gets or sets a value indicating whether items in the list can be edited. (Inherited from BindingListTopic.)
	AllowNew	Gets or sets a value indicating whether you can add items to the list using the AddNew method. (Inherited from BindingListTopic.)
	AllowRemove	Gets or sets a value indicating whether you can remove items from the collection. (Inherited from BindingListTopic.)
	ApiContentInsertionPoint	This is used to get the topic at which the API table of contents is to be inserted or parented.
	ContentLayoutFile	This is used to get the build item related to the content layout file containing the collection items.
	Count	Gets the number of elements actually contained in the CollectionT. (Inherited from CollectionTopic.)
	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 BindingListTopic.)
	ItemInt32	Gets or sets the element at the specified index. (Inherited from CollectionTopic.)
	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 CollectionTopic.)
	MSHVRootContentContainer	This is used to get the topic that will serve as the root content container in MS Help Viewer output.
	RaiseListChangedEvents	Gets or sets a value indicating whether adding or removing items within the list raises ListChanged events. (Inherited from BindingListTopic.)
	SortDirectionCore	Gets the direction the list is sorted. (Inherited from BindingListTopic.)
	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 BindingListTopic.)
	SupportsChangeNotificationCore	Gets a value indicating whether ListChanged events are enabled. (Inherited from BindingListTopic.)
	SupportsSearchingCore	Gets a value indicating whether the list supports searching. (Inherited from BindingListTopic.)
	SupportsSortingCore	Gets a value indicating whether the list supports sorting. (Inherited from BindingListTopic.)

Top

Events

	Name	Description
	AddingNew	Occurs before an item is added to the list. (Inherited from BindingListTopic.)
	ListChanged	Occurs when the list or an item in the list changes. (Inherited from BindingListTopic.)

Top

Remarks

This class is serializable so that it can be copied to the clipboard.

Reference

SandcastleBuilder.Utils.ConceptualContent Namespace