You are here: Working with Projects > Help Target Properties > Microsoft Help 2.0

Microsoft Help 2.0

This target produces the standard Microsoft Help 2.0.

Appearance Properties

BackGroundColor

Displays the current background color setting for the Help pane.

BackgroundImage

Displays the image file to be used as a background in the Help pane.

BackGroundRepeat

Defines how the background image is arranged in the Help pane.

Caption

Represents the string to be displayed in the caption bar of the help window.

Theme

Determines the appearance of the Help pane and framesets for HTML-based targets.

Build Properties

AttributeExpression

Specifies an advanced conditional build expression for a help target.

GenerateCSS

When set to False, the existing cascading stylesheet will not be overwritten when building the Help target.

OwnTOC

Determines whether TOC customization performed on the Contents tab applies only to the current help target or to other targets as well.

Display Properties

BreadcrumbsLabel

Specifies the text that precedes topic breadcrumbs.

ButtonLabel

Specifies the text that precedes the subtopic buttons.

ButtonLabelStyle

Lists the name of the style used to format the label that precedes the subtopic buttons.

ButtonSeparator

When enabled, a dividing line separates the topic text from the subtopic buttons.

ButtonStyle

Lists the name of the style used to format automatically generated subtopic buttons.

ColorReduction

Determines the color threshold for images that are saved with source documents.

 

Value

Description

 

None

Images are not converted.

 

16 Colors

Images with more than 16 colors are reduced to 16.

 

256 Colors

Images with more than 256 colors are reduced to 256.

GraphicsScaleWithFonts

When set to True, all graphics in Word source documents are resized proportionally when system font size is changed.

ImageFormat

Determines graphic format in which images originated from Word source documents are stored in image files in the online help target.

ScaleGraphics

Determines what scaling is applied to the graphics in Word source document.

Localization Properties

Charset

Specifies one of the character set aliases listed in HTML Character Sets and Named Entities.

CodePage

Defines the windows codepage number to be used by the Help file. This property is most commonly used when producing Help files in foreign languages, providing special character sets for translation on the screen or in print.

Locale

This property is used to specify the language in the resulting target files. Each target has its own way of specifying language. For example, HTML Help has a Language option in the [OPTIONS] section of the project file (.hhp).

Miscellaneous Properties

BaseName

Base file name to be used for generating Help target files. By default, this name will be the same as the file name for the Help project itself.

CopyFolder

Defines the folder name where ancillary build files will reside.

Folder

Defines the folder name where the Help files will reside.

Name

Returns a string containing the name of a specified Help target (read-only).

StyleSheet

Specifies the name of the cascading style sheet applied to intermediate files during compilation.

Template

The document template to apply to the intermediate files during compilation.

Strings Properties

Namespace

Specifies the Help 2.0 namespace that is used to register the Help file after a successful build.

ParentNamespace

Specifies the namespace for the built help collection to plug into. Usually, that will be the namespace of the Visual Studio .NET Combined Collection. Set this property if you want the built Help to be automatically registered as a plug-in for Visual Studio help. For example, for Visual Studio .NET 2003, set ParentNamespace to "MS.VSCC.2003".