TocEntry Properties |
The TocEntry type exposes the following members.
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.
|