Media Help properties - On Premises 6.4

Object Properties

The Help tab contains properties that define the Windows Help windows. Define up to 255 secondary help windows in WinHelp 4.0, and use these to display your topics. These properties define things like, the window name, title, size, position, colors, and which macros to execute when the window opens.

Media - Help Tab

Window name

Defines the name of the help window. Use this name when building a Macro Procedure object, to specify a help window. It is mandatory and must be unique.

Window title

Defines the text that appears in the title bar of this Help window. If you do not specify the window title, the Help Title from the book object isn't.

Window macro

Sets a relationship to a Macro Procedure object that defines the Windows Help Macros that will be executed when the window opens for the first time.

Auto-size height

Determines if the height of the help window changes automatically to accommodate the amount of text in it. The Help window with a Window Name of "main" cannot be automatically sized.

Keep window on top

Determines if the help window remains in the foreground, even when users switch to a different window or program. This feature is especially useful for procedures because the Help topic remains visible while the user carries out a task.

Maximize window

Determines if the help window covers a user's entire screen. This property and the Auto-Size Height property cannot be set to on at the same time.

Window position

Defines the position of the top left hand corner of the help window, as the number of pixels from the top left hand corner of the screen. A value of -1 means that the Windows Help default position will be used.

Window size

Defines the size of the help window in pixels, as the height and width from the top left hand corner of the window. A value of -1 means that the Windows Help default position will be used.

Auto sizer button

Choose this to display a sample window that you can position and size by dragging the window's borders. When you are finished, the Left, Top, Width, and Height properties are automatically filled in, based on the size and position of the sample window.

Default positions button

Cancels customized size and position settings and allows Windows Help to determine the size and position of the window.

Contents button

Determines if a Contents button appears on the button bar in the Help window. If a contents (.cnt) file is present, the Contents button displays the Contents tab in the Help Topics dialog box. Otherwise, the Contents button displays either the default topic or the first topic in your help file.

Index button

Determines if an Index button appears on the button bar in the help window. The Index button displays the Index tab in the Help Topics dialog box.

Find button

Determines if a Find button appears on the button bar in the Help window. The Find button displays the Find tab in the Help Topics dialog box.

Options button

Determines if an Options button appears on the button bar in the Help window. The Options button displays a menu containing the following commands:

  • Annotate
  • Copy
  • Print Topic
  • Font
  • Keep Help On Top
  • Use System Colors

This menu also appears when users click a topic using the right mouse button.

Help topics button

Determines if a Help Topics button appears on the button bar in the Help window. If a contents (.cnt) file is present, clicking the Help Topics button for the first time displays the Contents tab in the Help Topics dialog box. Thereafter, clicking the Help Topics button displays the tab that a user most recently worked with.

If there is no contents file, the Help Topics button displays either the default topic or the first topic in your help file.

Print button

Determines if a Print button appears on the button bar in the Help window. The Print button prints the current topic.

Back button

Determines if a Back button appears on the button bar in the Help window. The Back button displays the previously viewed topic in the current window.

Browse buttons

Determines if a pair of browse buttons, << and >> appear on the button bar in the Help window. The browse buttons enable users to move from one topic to another, as specified by Include in Browse Sequence, and Start a New Browse Sequence properties of the Topic object.

Window non-scrolling color

Defines the color of the non-scrolling area of the Help window. The Help Heading will be displayed in this area if the Non-Scrolling property is set on.

Click the Change button to change the color.

Window scrolling color

Defines the color of the scrolling area of the Help window. The topic text will be displayed in this area of the Help window.

Click the Change button to change the color.