IHelpTopic interface
[This documentation is preliminary and is subject to change.]
Help topic interface, contains methods to retrieve topic information.
Members
The IHelpTopic interface inherits from the IDispatch interface. IHelpTopic also has the following types of members:
- Methods
- Properties
Methods
The IHelpTopic interface has the following methods.
| Method | Description |
|---|---|
| Category | method Category-Returns topic category (if defined in the content). |
| ContentFilter | method ContentFilter-Returns the content filter value for the topic. |
| ContentType | method ContentType-Returns topics content type (if defined in the content). |
| FetchContent | method FetchContent - Returns a data stream containing the XHTML data for the topic. |
Properties
The IHelpTopic interface has the following properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Returns topic description. |
|
| Read-only | Returns topic identifier. |
|
| Read-only | Returns locale. |
|
| Read-only | Returns the package that the topic resides in. |
|
| Read-only | Returns topic parent identifier. The value will be -1 if the topic is a root (no parent) topic. |
|
| Read-only | For TableOfContents calls, returns true if the topic has children. It will not be relevant data for non-TOC calls. |
|
| Read-only | Returns topics position in the table of contents. |
|
| Read-only | Returns topic title. |
|
| Read-only | Returns topic locale. |
|
| Read-only | Returns topic version. |
|
| Read-only | Returns topic url. |
|
| Read-only | Returns the vendor name for the topic. |
Requirements
Minimum supported client |
Windows Developer Preview |
Minimum supported server |
Windows Server Developer Preview |
IDL |
Windows.Help.Runtime.idl |
Build date: 9/7/2011