Class DocFXTOC

A TOC for DocFX. Currently only simple, one level TOCs are implemented.

Inheritance

object

List<TOCItem>

DocFXTOC

Implements

IList<TOCItem>

ICollection<TOCItem>

IReadOnlyList<TOCItem>

IReadOnlyCollection<TOCItem>

IEnumerable<TOCItem>

IList

ICollection

IEnumerable

Inherited Members

List<TOCItem>.Add(TOCItem)

List<TOCItem>.AddRange(IEnumerable<TOCItem>)

List<TOCItem>.AsReadOnly()

List<TOCItem>.BinarySearch(int, int, TOCItem, IComparer<TOCItem>)

List<TOCItem>.BinarySearch(TOCItem)

List<TOCItem>.BinarySearch(TOCItem, IComparer<TOCItem>)

List<TOCItem>.Clear()

List<TOCItem>.Contains(TOCItem)

List<TOCItem>.ConvertAll<TOutput>(Converter<TOCItem, TOutput>)

List<TOCItem>.CopyTo(int, TOCItem[], int, int)

List<TOCItem>.CopyTo(TOCItem[])

List<TOCItem>.CopyTo(TOCItem[], int)

List<TOCItem>.Exists(Predicate<TOCItem>)

List<TOCItem>.Find(Predicate<TOCItem>)

List<TOCItem>.FindAll(Predicate<TOCItem>)

List<TOCItem>.FindIndex(int, int, Predicate<TOCItem>)

List<TOCItem>.FindIndex(int, Predicate<TOCItem>)

List<TOCItem>.FindIndex(Predicate<TOCItem>)

List<TOCItem>.FindLast(Predicate<TOCItem>)

List<TOCItem>.FindLastIndex(int, int, Predicate<TOCItem>)

List<TOCItem>.FindLastIndex(int, Predicate<TOCItem>)

List<TOCItem>.FindLastIndex(Predicate<TOCItem>)

List<TOCItem>.ForEach(Action<TOCItem>)

List<TOCItem>.GetEnumerator()

List<TOCItem>.GetRange(int, int)

List<TOCItem>.IndexOf(TOCItem)

List<TOCItem>.IndexOf(TOCItem, int)

List<TOCItem>.IndexOf(TOCItem, int, int)

List<TOCItem>.Insert(int, TOCItem)

List<TOCItem>.InsertRange(int, IEnumerable<TOCItem>)

List<TOCItem>.LastIndexOf(TOCItem)

List<TOCItem>.LastIndexOf(TOCItem, int)

List<TOCItem>.LastIndexOf(TOCItem, int, int)

List<TOCItem>.Remove(TOCItem)

List<TOCItem>.RemoveAll(Predicate<TOCItem>)

List<TOCItem>.RemoveAt(int)

List<TOCItem>.RemoveRange(int, int)

List<TOCItem>.Reverse()

List<TOCItem>.Reverse(int, int)

List<TOCItem>.Sort()

List<TOCItem>.Sort(IComparer<TOCItem>)

List<TOCItem>.Sort(Comparison<TOCItem>)

List<TOCItem>.Sort(int, int, IComparer<TOCItem>)

List<TOCItem>.ToArray()

List<TOCItem>.TrimExcess()

List<TOCItem>.TrueForAll(Predicate<TOCItem>)

List<TOCItem>.Capacity

List<TOCItem>.Count

List<TOCItem>.this[int]

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEditor.PackageManager.DocumentationTools.UI

Assembly: Unity.PackageManagerDocTools.Editor.dll

Syntax

public class DocFXTOC : List<TOCItem>, IList<TOCItem>, ICollection<TOCItem>, IReadOnlyList<TOCItem>, IReadOnlyCollection<TOCItem>, IEnumerable<TOCItem>, IList, ICollection, IEnumerable

Methods

Name	Description
AddAfter(string, TOCItem)	Adds a new TOC entry after an existing entry.
AddBefore(string, TOCItem)	Adds a new TOC entry before an existing entry.
AddChild(string, TOCItem)
AddItem(TOCItem, int)	Add a toc item after the item with the specified name. Currently only simple, one-level TOCs are implemented.
FindIndexForEntry(string)	Finds the index of a TOC entry given its href field.
ToString()
WriteTOC(string)