TocEntry Class

Definition

This represents a table of contents entry. This is used to build the table of contents entries for content layout and site map files.

public class TocEntry : IComparable<TocEntry>, ICloneable, INotifyPropertyChanged

Constructor

ApiParentMode	This is used to specify how API content is parented to this topic or the topic's parent
BasePathProvider	This returns the IBasePathProvider for the entry.
Children	This returns the child table of contents collection for this entry
DestinationFile	This is used to get or set the entry's destination file path.
Id	The ID of the item when it represents a TOC entry from a content layout file
IsDefaultTopic	This is used to get or set whether or not the item is the default topic for the help file
IsExpanded	This is used to get or set whether or not the entity is expanded
IsSelected	This is used to get or set whether or not the entity is selected
LinkText	The link text for the topic previewer
Parent	This is used to track the topic's parent collection
PreviewerTitle	The display title for the topic previewer
SortOrder	This is used to get or set the sort order for the entry within its group
SourceFile	This is used to get or set the entry's source file path.
Title	This is used to get or set the entry's title in the table of contents
ToolTip	This returns a description of the topic that can be used as a tool tip
UniqueId	This is used to get or set a unique ID to work around a legacy additional content support issue

Clone()	Clone this table of contents entry
CompareTo(TocEntry)	Compares this instance to another instance and returns an indication of their relative values
ContainsMatch(string)	See if this entry or one of its children is a match to the specified source filename
Equals(object)
GetHashCode()	Get a hash code for this item
LoadSiteMapNode(XmlNode)	This will load information about the entry from the node and will also load all child nodes
OnPropertyChanged(string)	This raises the PropertyChanged event
ResetSortOrder()	Reset the sort order on this item and its children
SaveAsSiteMapNode(XmlNode)	Save this node and its children to the specified root node as site map nodes
ToAnchor(string)	Convert the entry to its `<a>` element form
ToString()	Convert the table of contents entry and its children to a string

PropertyChanged

The property changed event

operator !=(TocEntry, TocEntry)	Overload for not equal operator
operator <(TocEntry, TocEntry)	Overload for less than operator
operator ==(TocEntry, TocEntry)	Overload for equal operator
operator >(TocEntry, TocEntry)	Overload for greater than operator