TopicCollection Class
Definition
- Namespace
- Sandcastle.Core.ConceptualContent
- Assembly
- Sandcastle.Core.dll
This collection class is used to hold the conceptual content topics for a project
public class TopicCollection : BindingList<Topic>, IList<Topic>, ICollection<Topic>, IReadOnlyList<Topic>, IReadOnlyCollection<Topic>, IEnumerable<Topic>, IBindingList, IList, ICollection, IEnumerable, ICancelAddNew, IRaiseItemChangedEvents, ITableOfContents- Inheritance
-
TopicCollection
- Implements
Constructors
| TopicCollection(ContentFile) |
Constructor |
Properties
| AddingNew | (Inherited from BindingList<Topic>) |
| AllowEdit | (Inherited from BindingList<Topic>) |
| AllowNew | (Inherited from BindingList<Topic>) |
| AllowRemove | (Inherited from BindingList<Topic>) |
| 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 content layout file metadata |
| Count | (Inherited from Collection<Topic>) |
| DefaultTopic |
This is used to get the default topic |
| IsSortedCore | (Inherited from BindingList<Topic>) |
| Items | (Inherited from Collection<Topic>) |
| ListChanged | (Inherited from BindingList<Topic>) |
| MSHVRootContentContainer |
This is used to get the topic that will serve as the root content container in MS Help Viewer output |
| RaiseListChangedEvents | (Inherited from BindingList<Topic>) |
| SortDirectionCore | (Inherited from BindingList<Topic>) |
| SortPropertyCore | (Inherited from BindingList<Topic>) |
| SupportsChangeNotificationCore | (Inherited from BindingList<Topic>) |
| SupportsSearchingCore | (Inherited from BindingList<Topic>) |
| SupportsSortingCore | (Inherited from BindingList<Topic>) |
| this[int] | (Inherited from Collection<Topic>) |
| this[string] |
This can be used to get a topic by its unique ID (case-insensitive) |
Methods
| Add(T) | (Inherited from Collection<Topic>) |
| AddNew() | (Inherited from BindingList<Topic>) |
| AddNewCore() | (Inherited from BindingList<Topic>) |
| AddTopicsFromFolder(string, string, ISandcastleProject) |
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(PropertyDescriptor, ListSortDirection) | (Inherited from BindingList<Topic>) |
| CancelNew(int) | (Inherited from BindingList<Topic>) |
| Clear() | (Inherited from Collection<Topic>) |
| ClearItems() | (Inherited from BindingList<Topic>) |
| Contains(T) | (Inherited from Collection<Topic>) |
| CopyTo(T[], int) | (Inherited from Collection<Topic>) |
| EndNew(int) | (Inherited from BindingList<Topic>) |
| Find(Predicate<Topic>, bool) |
This is used to find all topics and sub-topics that match the specified predicate recursively |
| FindCore(PropertyDescriptor, object) | (Inherited from BindingList<Topic>) |
| GenerateTableOfContents(TocEntryCollection, bool) |
Generate the table of contents for the conceptual topics |
| GetEnumerator() | (Inherited from Collection<Topic>) |
| IndexOf(T) | (Inherited from Collection<Topic>) |
| Insert(int, T) | (Inherited from Collection<Topic>) |
| InsertItem(int, Topic) |
This is overridden to set the inserted item's parent to this collection |
| 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. |
| OnAddingNew(AddingNewEventArgs) | (Inherited from BindingList<Topic>) |
| OnListChanged(ListChangedEventArgs) | (Inherited from BindingList<Topic>) |
| Remove(T) | (Inherited from Collection<Topic>) |
| RemoveAt(int) | (Inherited from Collection<Topic>) |
| RemoveItem(int) |
This is overridden to clear the parent on the removed item |
| RemoveSortCore() | (Inherited from BindingList<Topic>) |
| ResetBindings() | (Inherited from BindingList<Topic>) |
| ResetItem(int) | (Inherited from BindingList<Topic>) |
| Save() |
Save the topic collection to the related content layout file |
| SetItem(int, Topic) |
This is overridden to set the inserted item's parent to this collection |
| Sort() |
This is used to sort the collection |