How to add Help files to an Outlook custom form (292007)



The information in this article applies to:

  • Microsoft Office Outlook 2003
  • Microsoft Outlook 2002
  • Microsoft Outlook 2000

This article was previously published under Q292007

INTRODUCTION

When you create a custom form by using Microsoft Office Outlook or Microsoft Outlook, there is no direct way to add a Help file. This article describes two ways to work around this limitation.

MORE INFORMATION

Note This article assumes that you have a working knowledge of how to customize Outlook forms, including how to use Microsoft Visual Basic Scripting Edition (VBScript), fields, and controls. Because each custom solution has different requirements, the workaround in this article is provided as a starting point for achieving the result that you want. You should use this workaround in a way that best suits the requirements of the solution.

The Outlook object model does not provide a method for displaying Help files. Additionally, the standard controls that are available for Outlook are not designed to display Help files.

To work around this limitation, use one of the following methods.

Method 1: Create a "Help" page on the form

To add a page of explanatory text to your form, follow these steps:
  1. Click to select the page to which you want to add text.
  2. On the Form menu, click Rename Page.
  3. In the Page Name box, type Help, and then click OK.
  4. Add a text box control to the form.
  5. Right-click the text box control, and then click Properties.
  6. On the Display page, click to select the Multi-line check box.
  7. Type the explanatory text that you want in the text box control.
  8. Right-click the text box control, and then click Properties.
  9. On the Display page, click to select the Read Only check box, and then set any other display attributes that you need.
Because a Help file cannot be associated with a form, you cannot use the HelpContextId property to create Help for an Outlook form. If the Compose page differs from the Read page, you may have to create separate Help pages.

Method 2: Use a custom ActiveX control

Create a custom ActiveX control by using a separate development environment that supports creating ActiveX controls. For example, you can use Microsoft Visual Basic. Then set up the ActiveX control to display the Help file. By using this approach, you can then use the following method:
  1. Add an Outlook command button control to the Outlook form.
  2. Set the caption of the control to "Help."
  3. Create a CommandButton_Click sub procedure in VBScript to run VBScript code when the user clicks the button.
  4. Have the code use the CreateObject method to access your custom ActiveX control.

Modification Type:MajorLast Reviewed:6/19/2006
Keywords:kbhowto KB292007