Click or drag to resize
Sandcastle Help File BuilderTocEntry Properties

The TocEntry type exposes the following members.

Properties
  NameDescription
Public propertyApiParentMode
This is used to get or set whether or not the table of contents is split after this entry.
Public propertyBasePathProvider
This returns the IBasePathProvider for the entry.
Public propertyChildren
This returns the child table of contents collection for this entry
Public propertyDestinationFile
This is used to get or set the entry's destination file path.
Public propertyHasCodeBlocks
This is used to get or set whether or not the topic has <code /> blocks that need expanding.
Public propertyHasLinks
This is used to get or set whether or not the topic has links that need to be resolved when the file is copied.
Public propertyHasProjectTags
This is used to get or set whether or not the topic has tags that should be resolved to project options.
Public propertyId
The ID of the item when it represents a TOC entry from a content layout file.
Public propertyIncludePage
This is used to get or set whether or not the page will appear in the table of contents.
Public propertyIsDefaultTopic
This is used to get or set whether or not the item is the default topic for the help file.
Public propertyIsExpanded
This is used to get or set whether or not the entity is expanded
Public propertyIsSelected
This is used to get or set whether or not the entity is selected
Public propertyLinkText
The link text for the topic previewer
Public propertyNeedsColorizing
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.
Public propertyParent
This is used to track the topic's parent collection
Public propertyPreviewerTitle
The display title for the topic previewer
Public propertySortOrder
This is used to get or set the sort order for the entry within its group.
Public propertySourceFile
This is used to get or set the entry's source file path.
Public propertyTitle
This is used to get or set the entry's title in the table of contents.
Public propertyToolTip
This returns a description of the topic that can be used as a tooltip
Public propertyUniqueId
This is used to get or set a unique ID to work around a legacy additional content support issue.
Top
See Also