Help Topics for the HotDocs Application Programming Interface (API)
This Help file is a technical guide to integrating HotDocs with other software applications. It is written with the assumption that you have experience in software development and an understanding of a high-level programming language such as Visual Basic, C++, or C#. Because the type of application you integrate with HotDocs and the extent of that integration will vary from project to project, this file provides only broad guidelines on how to accomplish your task. You must adapt this information to the requirements of your project.
Organization of the Help File
Content within the help file is categorized into several areas:
- New Features and Enhancements: What's new in HotDocs 11 (and prior versions)
- About HotDocs API: Conceptual information about the role HotDocs API plays.
- Using Command Line Option: A reference guide to the Command Line Options.
- COM API: A reference guide to the COM APIs, arranged by class.
- Answer Source API: A reference guide to the Answer Source APIs.
- Plug-in API: A reference guide to the Plug-in API.
Find Topics in the Help File
To use the help file, you have several options:
- Click the Index tab to view a listing of all the topics in the help file, referenced by index keyword.
- Enter a search term or phrase in the Search box and click Search to view topics that contain your search phrase. If the search phrase is found, a Search Results list is displayed, showing the different topics that meet your criteria.
See Form a Help Search Query for detailed instructions on creating a search query.
Other Help Resources
There are four buttons in the navigation bar where you can access the following options
Hide: Hide the left hand pane, the button then changes to the
Show button.
Back: Go back to the previous page.
Print: View the Print dialog box to print a copy of the current page.
Options: Show the options drop-down menu where you can choose from: Hide Tabs, Back, Forward, Home, Stop, Refresh, Internet Options, Print, and Search Highlights Off.
For additional help using HotDocs, you can view the online HotDocs Wiki. See http://wiki.hotdocs.com.
When you view a topic in a search results list, the help system highlights your search terms. If you want to remove these highlights, select Search Highlights Off from the Options menu and refresh the page. To turn them back on again select Search Highlights On and refresh the page..