TocEntryCollection Class
Definition
- Namespace
- Sandcastle.Core.ConceptualContent
- Assembly
- Sandcastle.Core.dll
This collection class is used to hold the table of contents entries for content layout and site map files
public class TocEntryCollection : BindingList<TocEntry>, IList<TocEntry>, ICollection<TocEntry>, IReadOnlyList<TocEntry>, IReadOnlyCollection<TocEntry>, IEnumerable<TocEntry>, IBindingList, IList, ICollection, IEnumerable, ICancelAddNew, IRaiseItemChangedEvents, ITableOfContents- Inheritance
-
TocEntryCollection
- Implements
Constructors
| TocEntryCollection() |
Default constructor |
| TocEntryCollection(ContentFile) |
Constructor |
Properties
| AddingNew | (Inherited from BindingList<TocEntry>) |
| AllowEdit | (Inherited from BindingList<TocEntry>) |
| AllowNew | (Inherited from BindingList<TocEntry>) |
| AllowRemove | (Inherited from BindingList<TocEntry>) |
| 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 content layout file metadata |
| Count | (Inherited from Collection<TocEntry>) |
| DefaultTopic |
This is used to get the default topic |
| IsSortedCore | (Inherited from BindingList<TocEntry>) |
| Items | (Inherited from Collection<TocEntry>) |
| ListChanged | (Inherited from BindingList<TocEntry>) |
| RaiseListChangedEvents | (Inherited from BindingList<TocEntry>) |
| SortDirectionCore | (Inherited from BindingList<TocEntry>) |
| SortPropertyCore | (Inherited from BindingList<TocEntry>) |
| SupportsChangeNotificationCore | (Inherited from BindingList<TocEntry>) |
| SupportsSearchingCore | (Inherited from BindingList<TocEntry>) |
| SupportsSortingCore | (Inherited from BindingList<TocEntry>) |
| this[int] | (Inherited from Collection<TocEntry>) |
| this[string] |
This can be used to get a topic by its unique ID (case-insensitive) |
Methods
| Add(T) | (Inherited from Collection<TocEntry>) |
| AddNew() | (Inherited from BindingList<TocEntry>) |
| AddNewCore() | (Inherited from BindingList<TocEntry>) |
| 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<TocEntry>) |
| CancelNew(int) | (Inherited from BindingList<TocEntry>) |
| Clear() | (Inherited from Collection<TocEntry>) |
| ClearItems() | (Inherited from BindingList<TocEntry>) |
| Contains(T) | (Inherited from Collection<TocEntry>) |
| CopyTo(T[], int) | (Inherited from Collection<TocEntry>) |
| EndNew(int) | (Inherited from BindingList<TocEntry>) |
| Find(Predicate<TocEntry>, bool) |
This is used to find all topics and sub-topics that match the specified predicate recursively |
| Find(string) |
Find a TOC entry with the same source filename |
| FindCore(PropertyDescriptor, object) | (Inherited from BindingList<TocEntry>) |
| FindDefaultTopic() |
This is used to locate the default topic if one exists |
| GenerateTableOfContents(TocEntryCollection, bool) |
Generate the table of contents for the conceptual topics |
| GetEnumerator() | (Inherited from Collection<TocEntry>) |
| IndexOf(T) | (Inherited from Collection<TocEntry>) |
| Insert(int, T) | (Inherited from Collection<TocEntry>) |
| InsertItem(int, TocEntry) |
This is overridden to set the inserted item's parent to this collection |
| Load() |
This is used to load the table of contents entries from the site map file associated with the collection. |
| OnAddingNew(AddingNewEventArgs) | (Inherited from BindingList<TocEntry>) |
| OnListChanged(ListChangedEventArgs) | (Inherited from BindingList<TocEntry>) |
| Remove(T) | (Inherited from Collection<TocEntry>) |
| RemoveAt(int) | (Inherited from Collection<TocEntry>) |
| RemoveItem(int) |
This is overridden to clear the parent on the removed item |
| RemoveSortCore() | (Inherited from BindingList<TocEntry>) |
| ResetBindings() | (Inherited from BindingList<TocEntry>) |
| ResetItem(int) | (Inherited from BindingList<TocEntry>) |
| 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(string, int, string) |
This is used to save the TOC information to an intermediate TOC file used in the conceptual content build. |
| SetItem(int, TocEntry) |
This is overridden to set the inserted item's parent to this collection |
| Sort() |
This is used to sort the collection |
| ToString() |
Convert the table of contents entry and its children to a string |