TocEntry Class

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

Definition

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

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

Public Class TocEntry
	Implements IComparable(Of TocEntry), ICloneable, 
	INotifyPropertyChanged

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

type TocEntry = 
    class
        interface IComparable<TocEntry>
        interface ICloneable
        interface INotifyPropertyChanged
    end

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	Compares this instance to another instance and returns an indication of their relative values
ContainsMatch	See if this entry or one of its children is a match to the specified source filename
Equals	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(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)
GetHashCode	Get a hash code for this item (Overrides ObjectGetHashCode)
GetType	Gets the Type of the current instance. (Inherited from Object)
LoadSiteMapNode	This will load information about the entry from the node and will also load all child nodes
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
OnPropertyChanged	This raises the PropertyChanged event
ResetSortOrder	Reset the sort order on this item and its children
SaveAsSiteMapNode	Save this node and its children to the specified root node as site map nodes
ToAnchor	Convert the entry to its <a> element form
ToString	Convert the table of contents entry and its children to a string (Overrides ObjectToString)

The property changed event

Equality(TocEntry, TocEntry)	Overload for equal operator
GreaterThan(TocEntry, TocEntry)	Overload for greater than operator
Inequality(TocEntry, TocEntry)	Overload for not equal operator
LessThan(TocEntry, TocEntry)	Overload for less than operator