Click or drag to resize

Installing the Visual Studio help

The Microsoft Help Viewer (MSHC) version of this document can be installed in the Microsoft Visual Studio 2010 or higher Help system. This makes the entire contents of this document available alongside the Visual Studio documentation in the same window. The content appears in the Table of Contents, is searchable, and is context-sensitive.

Before you begin

You must be an administrator of your PC or perform the following task with administrator privileges to install the Meridian Enterprise .NET API Reference Guide. The Visual Studio 2010 help content must be installed first either by the setup program or by using Help Library Manager. Your preferred help experience must be set to I want to use local help in Help Library Manager as described in the following task.

To install in the Visual Studio Help system:

  1. In Microsoft Visual Studio, on the Help menu, click Manage Help Settings. The Help Library Manager window appears.

  2. Click Choose online or local help. The Settings page appears.

  3. Click I want to use local help and then click OK. The main Help Library Manager page reappears.

  4. Click Install content from disk. The Install Content from Disk page appears.

  5. Click Browse, select the HelpContentSetup.msha file provided with the .NET SDK, and click Open. The file path appears in the Location of help media text box.

  6. Click Next. The book Meridian Enterprise .NET API Reference Guide appears in the list of installed and installable books. Its state in the Status column is empty, which indicates that it has not yet been installed.

  7. Click the Add hyperlink next to the book name in the Actions column. The state in the Status column changes to Update Pending.

  8. Click Update. The Updating Local Library page appears while the book is added to the library's indexes.

  9. If the Security Alert page appears, click Yes.

  10. When the indexes have completed updating, click Finish. The main Help Library Manager page reappears and installation is complete.

  11. Click Exit to close Help Library Manager.

The Meridian Enterprise .NET API Reference Guide content can be found in the help system as a book in the Visual Studio help content catalog.

To view context-sensitive help:

  1. In Microsoft Visual Studio, open the file in code view that contains the API name that you want to view. The file must reference one of the Meridian Enterprise .NET API namespaces.

  2. Highlight the API name that for which you want to view help.

  3. Press F1. The topic related to the highlighted name appears in the Help Viewer window.