The Topic class provides information about an individual Help Builder topic. It maps essentially to the underlying fields in the database.
This class also supports an indexer for custom fields so you can reference any fields that exist in the table but are not exposed as properties via the generic indexer:
string s = (string) Help.Topic["MyCustomField"];
Westwind.wwHelp.wwHelpComWrapper
Westwind.wwHelp.wwHelpTopic
public class wwHelpTopic : wwHelpComWrapper
Class Members
Member | Description | |
---|---|---|
Constructor |
Overridden Constructor that must be passed a COM reference to the wwHelp Com object. All properties then map via Reflection. | |
Assembly |
Name of an .NET assembly for .NET class topics. | |
Body |
The body content of the topic | |
Class |
Name of the Class that this topic belongs to. Used only for CLASS... types. | |
Example |
An example code snippet. The text in this snippet is automatically formmated as in a PRE tag. | |
External |
Determines whether the content of this topic points to an external link. | |
FollowUp |
Determines whether follow up is required | |
HelpId |
Help Id/Context ID used in older applications | |
Implements |
The interfaces this class implements. | |
Inherits |
The immediate parent class for this class | |
Inh_Tree |
An Html based list of the Inheritance structure. | |
Item |
||
Keywords |
Additional Search Keywords for this topic for the index | |
Member |
The name of the class member method/property/event/field | |
Namespace |
Name of the namespace this class lives in. | |
Parameters |
Any parameters that are passed. This content is fully formatted as an HTML string. | |
ParentPk |
The parent topics Pk. Used manage self referential tree display. | |
Pk |
The primary key for the topic. Primary identifier. | |
Remarks |
Any special notes for this topic. | |
Returns |
Describes the return value for a function | |
Scope |
The Scope of a class member: Public/Private/Protected | |
SeeAlso |
Related Links. The content in this topic is formatted as individual lines Use wwHelp.InsertSeeAlsoTopics() to convert this field into HTML links. | |
Signature |
.NET namespace.member signature for the member. | |
SortOrder |
The sort order for this topic. 0 means default order which is by type and then alpha numeric. Higher numbers override the default and sort to the top. | |
Static |
returns whether this class member is static | |
Syntax |
The prototype sytnax for the topic | |
Topic |
The title of the topic | |
Type |
The Topic Type: TOPIC/HEADER/CLASSHEADER/CLASSMETHOD etc. | |
Updated |
Timestamp for the topic |
Requirements
Namespace: Westwind.wwHelpAssembly: wwReflection.DLL
© West Wind Techologies, 1996-2023 • Updated: 10/20/12
Comment or report problem with topic