TocEntry Class

TocEntry Class

This represents a table of contents entry. This is used to build the table of contents entries for additional content items.

Inheritance Hierarchy

SystemObject
SandcastleBuilder.Utils.ConceptualContentTocEntry

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

Syntax

C++

Copy

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

The TocEntry type exposes the following members.

Constructors

	Name	Description
	TocEntry	Constructor

Top

Methods

	Name	Description
	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.)
	ToString(HelpFileFormats)	Convert the table of contents entry and its children to a string in the specified help file format.

Top

Operators

	Name	Description
	Equality	Overload for equal operator
	GreaterThan	Overload for greater than operator
	Inequality	Overload for not equal operator
	LessThan	Overload for less than operator

Top

Properties

	Name	Description
	ApiParentMode	This is used to get or set whether or not the table of contents is split after this entry.
	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.
	HasCodeBlocks	This is used to get or set whether or not the topic has <code /> blocks that need expanding.
	HasLinks	This is used to get or set whether or not the topic has links that need to be resolved when the file is copied.
	HasProjectTags	This is used to get or set whether or not the topic has tags that should be resolved to project options.
	Id	The ID of the item when it represents a TOC entry from a content layout file.
	IncludePage	This is used to get or set whether or not the page will appear in the table of contents.
	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
	NeedsColorizing	This is used to get or set whether or not the topic has <pre> blocks that have a lang attribute to indicate that they should be colorized.
	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 tooltip
	UniqueId	This is used to get or set a unique ID to work around a legacy additional content support issue.

Top

Events

	Name	Description
	PropertyChanged	The property changed event

Top

Reference

SandcastleBuilder.Utils.ConceptualContent Namespace