Provides core help system for the platform.
Package SpecificationThere is a general mechanism (defined at the plug-in level) by which individual plug-ins contribute online help and context-sensitive help for their component. This package defines interfaces for data objects managed by help systems, as well as
HelpSystemclass which static methods can be used to obtain objects managed by the help system.
Interface Summary Interface Description IAnchorSpecifies a location in a document where other plug-ins may contribute additional content. ICommandLinkRepresents a link with text that invokes a specific command with parameters. IContentExtensionAn extension of a document's content. IContextA context registered for context-sensitive help. IContext2Extends
IContextto provide support for styled text and topic categorization.
IContext2to provide support for related command links.
IContextProviderDynamic context provider. ICriteriaA directive indicating the criteria information of a Toc or Topic described in xml ICriteriaDefinitionICriteriaDefinition represents the criteria definition of one plug-in. ICriteriaDefinitionContributionRepresents criteria definition contribution ICriterionDefinitionICriterionDefinition represents a single criterion definition of the help content. ICriterionValueDefinitionICriterionValueDefinition represents one criterion value definition of one criterion. IHelp Deprecated.marked for deletion, see Bug 442959. IHelpContentProducerProducer capable of generating or otherwise obtaining contents for help resources. IHelpResourceA help resource, usually a help topic. IIncludeA directive indicating the content at the given path should be included in this document, and replace this node. IIndexIIndex represents metaphor of the book index. IIndexContributionRepresents either a complete or partial keyword index, as well as its metadata. IIndexEntryIIndexEntry represents a single entry of the help index. IIndexEntry2IIndexEntry2 is an index entry which may have see elements as children IIndexSeeAn entry that represents a see also node in the index. IIndexSubpathA directive indicating the content at the given path should be included in this document, and replace this node. ILinkA directive indicating a link to another toc to be inserted at (and replace) this link. ILiveHelpActionLive Help Extension. ITocAn
ITocrepresents the root node of a toc, for either a complete toc (book) or a part of one to be assembled into a larger one.
ITocby adding methods to support functionality for criteria, topic sorting and custom icons
ITocContributionRepresents either a complete or partial table of contents, as well as its metadata. ITopicAn
ITopicis one topic in the table of contents, which may contain subtopics.
ITopicby adding methods to support functionality for criteria, topic sorting and custom icons
IUAElementAn element in a UA document, which may have conditional enablement (may be filtered based on certain conditions) and may have sub-elements, or children.
Class Summary Class Description AbstractContentExtensionProviderAn
AbstractContentExtensionProvideris a mechanism to provide arbitrary content extensions (e.g. contributions to anchors or element replacements).
AbstractContextProvideris a mechanism to provide arbitrary context-sensitive help for any part of the UI.
AbstractCriteriaDefinitionProvideris a mechanism to provide display name for criteria attached to toc or topic.
AbstractCriteriaProvideris a mechanism for assigning criteria to
ITocelements independent of a table of contents file.
AbstractIndexProvideris a mechanism to provide arbitrary content to the keyword index.
AbstractTocProvideris a mechanism to provide arbitrary content to the table of contents (TOC).
HelpSystemThis class provides general access to help content contributed to the
UAContentFilterThis class provides the ability to filter out user assistance model elements that support filtering (e.g.