The MS Help Viewer category properties control the features of MS Help Viewer (MSHC) files.
- CatalogProductId
- CatalogProductVersion
- MSHelpViewerSdkLinkType
- ProductTitle
- SelfBranded
- TocOrder
- TocParentId
- TocParentVersion
- TopicVersion
- VendorName
Due to the requirement that MS Help Viewer files be installed before you can view them which can be time consuming, it is recommended that you generate one of the other help formats such as Help 1 or website while developing and proofreading your help file. |
For information on deploying MS Help Viewer files, see the Deploying an MS Help Viewer File and Help Library Manager Launcher Utility topics. |
CatalogProductId
This property is used to specify the catalog product ID to use for the installation script. If not set, it defaults to "VS" to use the standard Visual Studio catalog.
CatalogProductVersion
This property is used to specify the catalog version number to use for the installation script. If not set, it defaults to "100" to use the standard Visual Studio catalog version.
MSHelpViewerSdkLinkType
This property is used to define the type of links used to reference other help topics referring to framework (SDK) help topics. It can be set to None which renders non-clickable links, Id which renders MS Help Viewer style ms-xhelp style links, or MSDN (the default) which renders links to the online MSDN help content for the topic. When set to MSDN, the SdkLinkTarget property is used to define where the MSDN links will open in the browser.
ProductTitle
This property is used to set the product title that appears in the help content setup file. If not set, the HelpTitle property value will be used.
SelfBranded
This property is used to indicate whether the topics are marked as self-branded thus allowing them to use their own stylesheets, scripts, etc. Typically, you should leave this property set to True.
TocOrder
This property is used in conjunction with the TocParentId property to set the placement and ordering of your help topics amongst existing topics in the parent location. If left set to -1, the help file builder will start ordering your topics at zero.
TocParentId
This property allows you to define the location of your help file's content within the entire collection of help viewer content. If left set to -1, your help content will appear in the top level of the table of contents. If you want to parent your content at a different location, specify the value of the parent topic's Microsoft.Help.Id metadata item. You can find the value by going to the parent topic in the help viewer, viewing the source for the page, and finding the Microsoft.Help.Id metadata item.
See the Content Placement Options topic for more information on content placement and parenting help file viewer output. |
TocParentVersion
This property is used to specify the version of the parent topic identified in the TocParentId property. You can find the value by going to the parent topic in the help viewer, viewing the source for the page, and finding the Microsoft.Help.TopicVersion metadata item.
TopicVersion
This property is used to specify the version value that should be applied to all topics in your help file.
VendorName
This property is used to set the vendor name that appears in the help content setup file. If not set, a default value of "Vendor Name" will be used.