Partager via


ITopic interface

Help topic interface, contains methods to retrieve topic information

Members

The ITopic interface inherits from the IDispatch interface. ITopic also has these types of members:

Methods

The ITopic interface has these methods.

Method Description
Category Returns topic categories (if defined in the content)
ContentFilter Returns the content filter values for the topic
ContentType Returns this topic's content types (if defined in the content)
FetchContent method FetchContent - returns a data stream containing the XHTML data for the topic

Properties

The ITopic interface has these properties.

Property Access type Description
Catalog
Read-only
Returns the catalog interface associated with the topic
Description
Read-only
Returns topic description
DisplayVersion
Read-only
Returns display version
Id
Read-only
Returns topic identifier
locale
Read-only
Returns locale
Package
Read-only
Returns the package that the topic resides in
ParentId
Read-only
Returns topic parent identifier. The value will be -1 if the topic is a root (no parent) topic
ParentTopicLocale
Read-only
Returns parent topic locale
ParentTopicVersion
Read-only
Returns parent topic version
TableOfContentsHasChildren
Read-only
For TableOfContents calls, returns true if the topic has children. It will not be relevant data for non-TOC calls.
TableOfContentsPosition
Read-only
Returns topics position in the table of contents
Title
Read-only
Returns topic title
TopicLocale
Read-only
Returns topic locale
TopicVersion
Read-only
Returns topic version
Url
Read-only
Returns topic url
Vendor
Read-only
Returns the vendor name for the topic

Requirements

Minimum supported client
Windows 8 [desktop apps only]
Minimum supported server
Windows Server 2012 [desktop apps only]
IDL
Windows.Help.Runtime.idl