You are here: Customizing Help Windows > HTML Help Window Properties

HTML Help Window Properties

Appearance Properties

TriPaneWindow

When True, enables the standard tripane format for HTML Help.

Buttons Properties

Jump1Caption

Contains the caption for the Jump1 button.

Jump1URL

Contains the URL of the HTML file for the Jump1 button.

Jump2Caption

Contains the caption for the Jump2 button.

Jump2URL

Contains the URL of the HTML file for the Jump2 button.

ShowBackButton

When selected, the Back button is included in the Help window.

ShowForwardButton

When selected, the Forward button is included in the Help window.

ShowHideShowButton

When selected, the Hide and Show buttons are included in the Help window.

ShowHomeButton

When selected, the Home button is included in the Help window.

ShowJump1Button

When selected, the Jump1 button is included in the Help window. Chose the caption and URL for this button with the Jump1Caption and Jump1URL properties.

ShowJump2Button

When selected, the Jump2 button is included in the Help window. Chose the caption and URL for this button with the Jump2Caption and Jump2URL properties.

ShowLocateButton

When selected, the Locate button is included in the Help window.

ShowNextButton

When selected, the Next button is included in the Help window. The BinaryTOC property must be set to True for the navigation buttons to function.

ShowOptionsButton

When selected, the Options button is included in the Help window.

ShowPreviousButton

When selected, the Previous button is included in the Help window. The BinaryTOC property must be set to True for the navigation buttons to function.

ShowPrintButton

When selected, the Print button is included in the Help window.

ShowRefreshButton

When selected, the Refresh button is included in the Help window.

ShowStopButton

When selected, the Stop button is included in the Help window.

Miscellaneous Properties

Caption

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

Global

When True, $global_ is prepended to the window name in generated files and <OBJECT> tags.

Name

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

Navigation Properties

AutoHideNavigationPane

Minimizes the HTML Help navigation pane when HTML Help is not the active window.

AutoSyncNavigationPane

Allows the heading or topic in the Navigation pane to automatically synchronize with whatever topic appears in the Topic pane.

HideNavigationPane

When True, the navigation pane for the Help file is hidden by default.

NavigationPaneWidth

Defines the width of the navigation pane of the Help file in pixels.

Position Properties

AlwaysOnTop

When True, the Help window remains on top of all other windows in the desktop.

Height

Determines the height of the Help window.

Left

Determines the location of the left edge of the Help window. In conjunction with the Top property, determines the position of the Help window on the screen.

Maximized

If True, the Help window is automatically maximized when displayed.

SaveUserPosition

When True, stores the size and position of the Help window in the registry when the user modifies it.

Top

Determines the location of the top edge of the Help window. In conjunction with the Left property, determines the position of the Help window on the screen.

Width

Determines the width of the Help window.

Tab Properties

FavoritesTab

When enabled, the favorites tab is added to the Help window.

SearchTab

Adds a search tab to the Help window.

SearchTabAdvanced

Adds additional functionality to the search tab. Note this property is only available when the SearchTab property is True.