ComponentOne

DynamicHelp for WinForms

Copyright © 1987-2015 GrapeCity, Inc. All rights reserved.

ComponentOne, a division of GrapeCity
201 South Highland Avenue, Third Floor
Pittsburgh, PA 15206 USA

Website:
Sales:
Telephone:

http://www.componentone.com
sales@componentone.com
1.800.858.2739 or 1.412.681.4343 (Pittsburgh, PA USA Office)

Trademarks
The ComponentOne product name is a trademark and ComponentOne is a registered trademark of GrapeCity, Inc.
All other trademarks used herein are the properties of their respective owners.

Warranty
ComponentOne warrants that the media on which the software is delivered is free from defects in material and
workmanship, assuming normal use, for a period of 90 days from the date of purchase. If a defect occurs during this
time, you may return the defective media to ComponentOne, along with a dated proof of purchase, and
ComponentOne will replace it at no charge. After 90 days, you can obtain a replacement for the defective media by
sending it and a check for $25 (to cover postage and handling) to ComponentOne.
Except for the express warranty of the original media on which the software is delivered is set forth here,
ComponentOne makes no other warranties, express or implied. Every attempt has been made to ensure that the
information contained in this manual is correct as of the time it was written. ComponentOne is not responsible for
any errors or omissions. ComponentOne’s liability is limited to the amount you paid for the product. ComponentOne
is not liable for any special, consequential, or other damages for any reason.

Copying and Distribution
While you are welcome to make backup copies of the software for your own use and protection, you are not
permitted to make copies for the use of anyone else. We put a lot of time and effort into creating this product, and
we appreciate your support in seeing that it is used by licensed users only.

Table of Contents
DynamicHelp for WinForms Overview ......................................................................................... 8
Help with WinForms Edition ..................................................................................................... 8
Key Features.................................................................................................................................. 8
DynamicHelp for WinForms Samples ........................................................................................... 9
Using DynamicHelp for WinForms .............................................................................................. 11
For Developers: Mapping at Design Time............................................................................... 11
Specifying the Source Help File ........................................................................................... 13
Mapping a Topic to a Control at Design Time..................................................................... 14
Preparing C1DynamicHelp for Authoring Mode ................................................................. 15
For Help Authors: Mapping in Authoring Mode ..................................................................... 16
Mapping a Topic to a Control in Authoring Mode .............................................................. 19
Removing the Topic Mapping for a Selected Control ......................................................... 20
Assign a Topic to a Parent Control ...................................................................................... 20
Advanced Features ................................................................................................................. 21
Displaying any Help Format ................................................................................................ 22
Mapping to Control Parts or Custom Controls ................................................................... 22
DynamicHelp for WinForms Tutorials......................................................................................... 23
Tutorial 1: Mapping Help Topics at Design Time .................................................................... 23
Step 1 of 6: Add controls to the Windows form ................................................................. 24
Step 2 of 6: Set up the C1DynamicHelp control ................................................................. 25
Step 3 of 6: Associate topics with controls on the form ..................................................... 25
Step 4 of 6: Associate a topic with the form ....................................................................... 26
Step 5 of 6: Show topics programmatically ........................................................................ 27
Step 6 of 6: Run the application.......................................................................................... 28
Tutorial 2: Mapping Help Topics in Authoring Mode ............................................................. 29
Step 1 of 4: Add controls to the Windows form ................................................................. 29
Step 2 of 4: Set up the C1DynamicHelp control ................................................................. 30
Step 3 of 4: Using authoring mode ..................................................................................... 33
Step 4 of 4: Run the Application ......................................................................................... 34
API Reference.............................................................................................................................. 35
C1.Win.C1DynamicHelp.4 Assembly ....................................................................................... 35
Namespaces ........................................................................................................................ 35
C1.Win.C1DynamicHelp Namespace .............................................................................. 35

1

............................................................................................................................. 39 C1DynamicHelp Constructor .................................................................................... 57 ShowTopic(Int32) Method ............................................................ 35 Classes ...................................................................... 55 ShowTopic(String) Method ................ 73 TopicMap Property ............................................................................................................................................................................................... 70 IsPinnedDown Property ........................................................................ 66 ContextMenu Property ........................................................................... 75 2 ........................................................................... 68 CurrentTopic Property ................................................................................................... 71 MouseHoverDelay Property ................................. 51 SetHelpTopic Method ................................... 56 ShowTopic(HelpTopic) Method ................................ 59 ShowTopicForActiveControl Method .......... 69 HelpSource Property ............................................................................................Object) Method ....................................................................................................................... 69 Dock Property .................................................................... 54 ShowTopic Method .................... 54 ShowExternalHelp(HelpTab.......................................................................................................... 52 ShowDefaultTopic Method .................................................................................. 60 AuthoringMode Property........................................................................................Overview ................... 38 Members .......................................................................... 58 ShowTopic(Object) Method ............................................................................... 72 Resolver Property .................................. 52 ShowExternalHelp Method ............................ 49 GetHelpTopic Method ......................................................................................................................... 66 Browser Property ..................... 59 Properties................ 74 Events ................................... 37 C1DynamicHelp ................................................................................................................................................................................................................. 48 Methods ................................................. 70 MainControl Property ........................................................................................... 65 BorderStyle Property .... 68 DefaultTrigger Property ......................... 53 ShowExternalHelp(HelpTab) Method ................................................... 37 Overview .................................. 72 Provider Property.................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................... 67 ContextMenuStrip Property...........................................................................................................................................................

CurrentTopicChanged Event ........................................................................... 76
CurrentTopicChanging Event .......................................................................... 77
Conflict .................................................................................................................... 78
Overview ............................................................................................................. 79
Members ............................................................................................................. 79
Properties............................................................................................................ 80
DynamicItem Property .................................................................................... 81
Name Property ................................................................................................ 81
StaticItem Property ......................................................................................... 82
UIElementPath Property ................................................................................. 82
HelpTopic ................................................................................................................ 83
Overview ............................................................................................................. 83
Members ............................................................................................................. 84
HelpTopic Constructor ........................................................................................ 85
HelpTopic Constructor(String,String,HelpTopicList) ....................................... 86
HelpTopic Constructor(String,String) .............................................................. 87
Methods .............................................................................................................. 88
SetCtxtId Method ............................................................................................ 88
ToString Method ............................................................................................. 89
Properties............................................................................................................ 90
ContextID Property ......................................................................................... 90
SubTopics Property ......................................................................................... 91
Title Property .................................................................................................. 91
Url Property..................................................................................................... 92
HelpTopicList ........................................................................................................... 92
Overview ............................................................................................................. 93
Members ............................................................................................................. 94
HelpTopicList Constructor................................................................................... 96
MapItem.................................................................................................................. 97
Overview ............................................................................................................. 98
Members ............................................................................................................. 99
MapItem Constructor ....................................................................................... 100
Methods ............................................................................................................ 100
ToString Method ........................................................................................... 100
Properties.......................................................................................................... 101
HelpTopic Property ....................................................................................... 102

3

HelpTopicTrigger Property ............................................................................ 102
ItemType Property ........................................................................................ 103
ShowDefaultTopicFirst Property ................................................................... 104
UIElement Property ...................................................................................... 104
Url Property................................................................................................... 105
UseDefaultTrigger Property .......................................................................... 105
TopicEventArgs ..................................................................................................... 106
Overview ........................................................................................................... 107
Members ........................................................................................................... 108
Properties.......................................................................................................... 108
Cancel Property............................................................................................. 108
Topic Property............................................................................................... 109
TopicMap .............................................................................................................. 109
Overview ........................................................................................................... 111
Members ........................................................................................................... 112
Methods ............................................................................................................ 114
Add Method .................................................................................................. 115
Add(Object,MapItem) Method ................................................................. 116
Add(String,MapItem) Method .................................................................. 117
Contains Method .......................................................................................... 118
Load Method ................................................................................................. 119
Load(String) Method ................................................................................. 120
Load() Method .......................................................................................... 120
Refresh Method ............................................................................................ 121
Remove Method ........................................................................................... 122
Remove(Object) Method .......................................................................... 122
Remove(String) Method ........................................................................... 123
Save Method ................................................................................................. 124
Save() Method........................................................................................... 125
Save(String) Method ................................................................................. 125
Properties.......................................................................................................... 126
Conflicts Property ......................................................................................... 127
HasChanges Property .................................................................................... 128
Item Property ................................................................................................ 128
XmlSource Property ...................................................................................... 129
Events ................................................................................................................ 130

4

TopicMapChanged Event .............................................................................. 131
TopicMapSaved Event................................................................................... 131
UIElementInfo ....................................................................................................... 132
Overview ........................................................................................................... 132
Members ........................................................................................................... 133
UIElementInfo Constructor ............................................................................... 134
UIElementInfo Constructor(Object) .............................................................. 134
UIElementInfo Constructor(Object,String,Object) ........................................ 135
Properties.......................................................................................................... 137
Name Property .............................................................................................. 137
Parent Property............................................................................................. 138
UIElement Property ...................................................................................... 138
UIElementResolver................................................................................................ 139
Overview ........................................................................................................... 140
Members ........................................................................................................... 141
Methods ............................................................................................................ 141
HandleUIElementEvent Method ................................................................... 141
Enumerations ............................................................................................................ 143
DisplayTarget ........................................................................................................ 143
HelpTab ................................................................................................................. 144
HelpTopicTrigger ................................................................................................... 145
MapItemType ........................................................................................................ 146
UIElementEvents ................................................................................................... 147
Delegates .................................................................................................................. 148
HelpTopicEventHandler ........................................................................................ 148
C1.Win.C1DynamicHelp.Providers Namespace ............................................................ 149
Overview ................................................................................................................... 149
Classes ....................................................................................................................... 149
ChmProvider ......................................................................................................... 149
Overview ........................................................................................................... 150
Members ........................................................................................................... 151
ChmProvider Constructor ................................................................................. 152
Methods ............................................................................................................ 152
CorrectUrl Method........................................................................................ 153
GetCtxtIdMap Method.................................................................................. 154
GetFullUrl Method ........................................................................................ 154

5

....................................................................... 177 Properties....................................... 166 ShowExternalHelp Method .............................................................. 157 ShowExternalHelp(HelpTab....... 172 CorrectUrl Method.. 156 ShowExternalHelp Method .................... 171 Methods ............................................................................................................................................................. 165 GetTopics Method ............................... 168 Properties..................Object) Method ................................................................................................................Object) Method .................................... 170 Members .......................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................... 157 Properties....................................................Object) Method ...................................................................................................................................................................................................................................................................................................... 176 ShowExternalHelp(HelpTab................................................................................................................................ 159 NetHelpProvider .................................................................. 176 ShowExternalHelp(HelpTab) Method ............................................................. 178 6 .................................................................................................................................................................................................... 167 ShowExternalHelp(HelpTab.......................................................... 168 Source Property .................................. 169 Overview .. 161 NetHelpProvider Constructor ........................................................................................ 158 Source Property ............................................... 174 GetTopics Method .................................. 156 ShowExternalHelp(HelpTab) Method ................. 175 GetUrlMap Method ................... 166 ShowExternalHelp(HelpTab) Method ................................................................................... 164 GetFullUrl Method ............................... 165 GetUrlMap Method .............................................................................................................................. 169 IHelpProvider ....................... 173 GetCtxtIdMap Method............................................................... 169 Interfaces ................................................................. 163 GetCtxtIdMap Method................................................. 162 CorrectUrl Method.................................................................................. 160 Members ..................................................................................... 175 ShowExternalHelp Method ...............................................................GetTopics Method ......................................................................................................................... 155 GetUrlMap Method ....................................... 159 Overview ............. 174 GetFullUrl Method .................. 162 Methods .................

...... 178 7 .................Source Property ......................................................................

No additional code needs to be added once C1DynamicHelp is integrated with the application. A separate Help system doesn't need to be opened and searched. The C1DynamicHelp WinForms control displays context-sensitive help corresponding to the control that is being hovered over or the control that has the focus. Topic mapping can be done by software developers or Help authors.  Developers or Help Authors can easily perform topic mapping Software developers can map topics to controls at design time. right within the interface of the application. or Help Authors can use authoring mode. images.DynamicHelp for WinForms Overview DynamicHelp for WinForms is a container that allows you to view Help files in WinForms applications. and so on. Doc-To-Help. C1DynamicHelp is conceptually similar to using tooltips to provide Help on individual controls and components. typically contains more content. 8 . and others. An actual Help topic. namespaces and creating a project with the control. This type of Help system is an advanced feature available in applications such as Visual Studio. a special run-time mode with a simple interface. The following topics provide detailed instructions for both groups. Microsoft Office. by contrast. Key Features  C1DynamicHelp integrates with the application interface C1DynamicHelp improves the usability of your application by offering immediate and relevant Help as it is needed. tables. often including hyperlinks. Developers or Help authors can also use DynamicHelp to assign specific Help topics to controls within an application.   For Developers: Mapping at Design Time For Help Authors: Mapping in Authoring Mode See Also Help with WinForms Edition Help with WinForms Edition Getting Started For information on installing ComponentOne Studio WinForms Edition. please visit Getting Started with WinForms Edition. The main difference is that tooltips typically contain only a single sentence or paragraph. to do the mapping themselves. licensing. technical support. A C1DynamicHelp Help topic also supports selection and can be copied to the Clipboard.

DynamicHelp for WinForms Samples Please be advised that this ComponentOne software tool is accompanied by various sample projects and/or demos which may make use of other development tools included with the ComponentOne Studio.  Allows users to open the Help file in an external window on a specified tab. Supports Help content selection and copying The Help that is displayed in the C1DynamicHelp Help window can be selected and copied to the Clipboard to be pasted into another application.  Allows users to pin the current topic down in order to temporarily disable changing topics. Any method can be used. Please refer to the pre-installed product samples through the following path: Documents\ComponentOne Samples\WinForms The following tables provide a short description for each sample. MultipleForms This sample demonstrates how to use C1DynamicHelp controls on multiple forms.  Quickly activate/deactivate authoring mode The software developer can specify a way for Help authors to quickly activate and deactivate authoring mode for topic mapping. and so on. how to set them up to use a single help source. a . This sample uses the C1DynamicHelp control. an environment variable. such as a keystroke combination. This sample uses the C1DynamicHelp control.config file. 9 . and how to refresh the TopicMap to support controls created dynamically. Visual Basic Samples Sample Description AddingUICommands This sample shows how to add a toolbar to a C1DynamicHelp control to provide more functionality:  Allows users to navigate back/forward through help navigation history.

This sample uses the C1DynamicHelp control. It also shows how to save a modified topic map to different locations. C# Samples Sample Description AddingUICommands This sample shows how to add a toolbar to a C1DynamicHelp control to provide more functionality:  Allows users to navigate back/forward through help navigation history. This sample uses the C1DynamicHelp control. This sample uses the C1DynamicHelp control. This sample uses the C1DynamicHelp control. from a custom file. 10 . and how to refresh the TopicMap to support controls created dynamically. This sample uses the C1DynamicHelp control.  Allows users to pin the current topic down in order to temporarily disable changing topics. from application resources. MultipleForms This sample demonstrates how to use C1DynamicHelp controls on multiple forms. how to set them up to use a single help source. WorkingWithTopicMap This sample demonstrates how to load topic map from different locations: from a default topic map file. from application resources.UsingUIElementResolver This sample demonstrates how to create a custom UIElementResolver and use it in the C1DynamicHelp control. WorkingWithTopicMap This sample demonstrates how to load topic map from different locations: from a default topic map file. This sample uses the C1DynamicHelp control.  Allows users to open the Help file in an external window on a specified tab. It also shows how to save a modified topic map to different locations. from a custom file. UsingUIElementResolver This sample demonstrates how to create a custom UIElementResolver and use it in the C1DynamicHelp control.

The For Help Authors: Mapping in Authoring Mode topic provides all the information needed for topic mapping at run time in authoring mode. Note: If you are the software developer of the application and would like the Help author to map topics to controls. See the Advanced Features topic of this documentation for more information on mapping to control parts or custom controls. DynamicHelp for WinForms eliminates that painful process by providing two options:  Software developers can use C1DynamicHelp at design time to map the topics to controls. C1DynamicHelp Smart Tag 11 . You can use the C1DynamicHelp smart tag and Select Help Topic dialog box to quickly perform topic mapping.Using DynamicHelp for WinForms The process of mapping Help topics to controls within a software application has often been thought of as an error-prone process of passing a topic map back and forth between Help authors and software developers. the software developer must specify the Help file that is going to be used in the application before mapping can occur.NET controls and even parts of those controls. or  Help authors can map topics to controls themselves using the C1DynamicHelp authoring mode. without having to go through a software developer. DynamicHelp for WinForms supports several Help formats including HTML Help and NetHelp. You can also map to custom controls. The following topics explain both ways to perform topic mapping. See Also For Developers: Mapping at Design Time For Help Authors: Mapping in Authoring Mode Advanced Features For Developers: Mapping at Design Time C1DynamicHelp provides visual editing at design time to make it easier to map specific Help topics to controls within an application. please provide them with this documentation. C1DynamicHelp gives you the ability to map a topic to any standard . No matter who is going to perform the topic mapping.

the mouse is hovering over the control (MouseEnter). or you can choose the topic's context ID from the Context IDs tab. you can specify the topic to map to the control through the Table of Contents tab by simply selecting it.htm file that will be used for topic mapping. both. or neither. the mouse hovers over it. Select Help Topic Dialog Box Within this dialog box.In Visual Studio. Note:If using NetHelp. use the default. the C1DynamicHelp component includes a smart tag. you can specify here whether a topic should be shown when: the control gets focus.  HelpSource Property Click the ellipsis button to locate and select the . you can show the topic programmatically. or not at all (None). To access the C1DynamicHelp Tasks menu. Additionally.chm or NetHelp . 12 .htm or the file name that was used as the base URL for the NetHelp target. click the smart tag in the upper-right corner of the C1DynamicHelp control. A smart tag ( ) represents a short-cut tasks menu that provides the most commonly used properties for a control. in which case.  DefaultTrigger Property The DefaultTrigger property allows you to specify whether the Help topic will appear when the control has the focus (Enter).

Any other types of Help files can be used. From the Toolbox. double-click the C1DynamicHelp control to add it to your form. If you have not already added the C1DynamicHelp control to the Toolbox. To specify the source Help file to be used: 1. all NetHelp project files must be deployed with your application. If using NetHelp. Note: In Doc-To-Help.chm (compiled HTML Help) can be used by C1DynamicHelp. 13 . If using HTML Help. the software developer must specify the Help file that is going to be used in the application before mapping can occur. see Adding the C1DynamicHelp Component to a Project. only the .See Also Specifying the Source Help File Mapping a Topic to a Control at Design Time Preparing C1DynamicHelp for Authoring Mode Specifying the Source Help File No matter who is going to perform the topic mapping. you can use the Provider property and IHelpProvider interface. but this requires some additional programming. NetHelp project files are stored by default in the NetHelp folder. the compiled HTML Help file is stored in the HTMLHelp folder. Either NetHelp or a .chm must be included.

By default. Click Open. Locate and select the desired Help file.2. 4. Locate and select the desired Help file.htm or the file name that was used as the base URL for the NetHelp target). To change the default options. 5. Click the ellipsis button next to the HelpSource property. is added to all controls when C1DynamicHelp is added to the form. double-click the C1DynamicHelp control to add it to your form. Help Topic on C1DynamicHelp.chm file or NetHelp *. Mapping a Topic to a Control at Design Time Once a source Help file is specified. 4. Click the C1DynamicHelp smart tag ( ) to open the Tasks menu. 14 . and click Open. you can easily map topics to controls within your application through C1DynamicHelp. clear the Use default events check box and select either the Got focus or Mouse hover check box. You can use any *. Got focus sets the Help topic to display when the control has been selected. Click the C1DynamicHelp smart tag ( ) to open the Tasks menu. 5. The Select Help Topic dialog box appears and shows the Table of Contents tab and TOC from the specified Help file. 2. An extender property. From the Toolbox. Click the ellipsis button next to the HelpSource property. Select one of the controls on your form and click the ellipsis button next to the HelpTopic on C1DynamicHelp property in the Properties window. 3. Mouse hover sets the Help topic to display when the control has been hovered over.htm file (use the default. 3. the Use default events check box is selected (the selected options will vary by the control you’ve chosen to map to). 1.

Table of Contents tab. Specify a source Help file for C1DynamicHelp. Select your Form and set the KeyPreview property to True in the Properties window. choose a topic. The topic is mapped to the control and appears in the C1DynamicHelp Help window at run time when a user clicks or mouses over the control. 15 . Context ID tab. Also. if the Help author renames one of the TOC items.o o If mapping to the TOC: From the Select Help Topic dialog box. otherwise. You can use anything from a special keystroke combination to a registry node that. Note: In order to map to a topic. Click OK to close the Select Help Topic dialog box. the topic must be in the Help TOC or have a context ID assigned to it. 6. Preparing C1DynamicHelp for Authoring Mode To allow Help authors to activate and deactivate C1DynamicHelp authoring mode so that they can map topics in your application. choose the context ID/Topic pairing. you have a wide variety of options. 1. the mapping will break. You must get the updated Help and re-create the mapping with the updated TOC. activates authoring mode. it will not appear in the Select Help Topic dialog box. This example shows how to specify a keystroke combination. if present. 2. If mapping to the context ID list: From the Select Help Topic dialog box.

AuthoringMode = Not C1DynamicHelp1. Select View | Code so you can add code to override the OnKeyDown method and specify a keystroke combination to activate and deactivate authoring mode. The files used for mapping include: 16 . For Help Authors: Mapping in Authoring Mode Topic mapping is generally performed by the application Help author or Information Developer. 4. the roles of the Information Developer and Software Developer in the process are clearly defined here.Shift) { c1DynamicHelp1.Windows.A And e.AuthoringMode.OnKeyDown(e) End Sub To write code in C# C# Copy Code // toggle authoring mode when the user hits Ctrl+Shift+A override protected void OnKeyDown(KeyEventArgs e) { if (e.Control && e.KeyEventArgs) If (e.AuthoringMode End If MyBase.KeyCode = Keys.OnKeyDown(e).3.KeyCode == Keys.A && e.AuthoringMode = !c1DynamicHelp1.Forms.Shift) Then C1DynamicHelp1. for that reason. } C1DynamicHelp authoring mode will be activated or deactivated when the user presses the Ctrl+Shift+A keys. although one person may perform both roles. } base. Add the following code: To write code in Visual Basic Visual Basic Copy Code ' toggle authoring mode when the user hits Ctrl+Shift+A Protected Overrides Sub OnKeyDown(ByVal e As System.Control And e.

the .chm. for Help authors to use for assigning topics to controls within an application. the authoring mode panel and toolbar appear.chm files should be copied to the install folder specified by the software developer for your application (for example: \program files\componentone\DocToHelp\Help). authoring mode. When you have finished mapping topics. the compiled HTML Help file is stored in the HTMLHelp folder. If mappings need to be deleted. only the .chm. NetHelp project files are stored by default in the NetHelp folder. If using NetHelp. NetHelp project files or .htm.chm (compiled HTML Help) The Help file format is specified by the software developer. use the C1DynamicHelp authoring mode (see below). all of the files in the output folder of your Help project must be deployed with the application.htm.xml located in the same directory as your source Help file.xml mapping file should never be edited manually. When activated. Note: The .xml When you create mappings. This XML is used to show the topics when the application runs. 17 . by default. they are saved to the default.xml containing the topic mappings must be given to the software developer.xml or HelpFileName. If using HTML Help.chm must be included. You cannot begin mapping until you place your Help into the correct folder. Note: In Doc-To-Help.chm or NetHelp project files and the . C1DynamicHelp Authoring Mode DynamicHelp for WinForms provides a special run-time mode.  Default.xml or HelpFileName. NetHelp or .

Path The path of the control relative to its placement on the form. Type Type of control. which is made up of the following fields: Control Control name : type of control. For example. Topic Topic to associate with the control. a Node within a TreeView control may have a path that looks like this: Form1\TreeView1\Node0. The software developer controls how you to activate and deactivate authoring mode. See Also Mapping a Topic to a Control in Authoring Mode Removing the Topic Mapping for a Selected Control Assign a Topic to a Parent Control 18 .Information about the control being mapped to is provided in the Selected control area of the panel.

19 . the Use default events check box is selected (the selected options will vary by the control you’ve chosen to map to). The authoring mode panel appears. Mouse hover sets the Help topic to display when the control has been hovered over. Click the Attach topic to control button . if applicable. you will see information about them in the authoring mode panel: Control name. Got focus sets the Help topic to display when the control has been selected. clear the Use default events check box and select either the Got focus or Mouse hover check box. if you are going to map ribbons. Click the item you would like to map a Help topic to. To change the default options. By default. If you are going to map windows. make sure they are all open. Display the area of the application's interface that you would like to map. 2. and associated Topic. use the following steps: 1. 4. The Select Help Topic dialog box appears and shows the Table of Contents tab and TOC from the source Help file. control Type. 5. make sure they are all available. Click the Select control button . Activate authoring mode using the method specified by the software developer.Mapping a Topic to a Control in Authoring Mode To map a control to a topic using the C1DynamicHelp authoring mode. Path. As you move the mouse over the controls. 3. For example.

4. if you rename one of the TOC items. there is a special provision to do it in authoring mode. 9. Context ID tab. Simply drop the updated Help into the proper folder and re-create the mapping with the updated TOC. use the following steps: 1. Since the parent can be completely covered by child controls and thus unselectable. Activate authoring mode using the method specified by the software developer. Removing the Topic Mapping for a Selected Control To remove the topic mapping for a selected control. If you uninstall or reinstall your software product. The topic chosen will display in the Topic field of the authoring mode panel. Note: After mapping. The topic chosen will display in the Topic field of the authoring mode panel. but to its parent or ancestor. choose the context ID/Topic pairing. 3. so you can make sure the correct control has been selected. the . otherwise. use the method specified by the software developer. 20 . If mapping to the context ID list: From the Select Help Topic dialog box. The authoring mode panel appears. Assign a Topic to a Parent Control There may be times you need to attach a topic not to a control you can select. choose a topic. To close the window. you should backup the . Click OK. Note: In order to map to a topic.xml mapping file to the software developer. the topic must be in the Help TOC or have a context ID assigned to it. the mapping will break. Click the Save button . Continue mapping. 8.xml mapping file to the software developer. 2. Notice there is no longer a topic specified in the Topic field. Deliver the . 7. Also. Click OK. Click the Select Control button and select the control that you would like to remove the topic mapping from. Click the Detach Topic from Control button .o o If mapping to the TOC: From the Select Help Topic dialog box.xml mapping file elsewhere on your machine. Click the Save button .xml mapping file will be deleted and replaced. Close the mapping window and deliver the proper Help and . The topic mapping is removed. 5. Table of Contents tab. 6. it will not appear in the Select Help Topic dialog box. The control name appears in the Control field of the authoring mode panel.

5. But if you want to extend it to your needs. The authoring mode panel appears. 7. Click the child control of the parent or ancestor control you would like to map a Help topic to. and specify any desired events. 8. The Select Help Topic dialog box appears and shows the Table of Contents tab and TOC from the source Help file. Select the topic from the Table of Contents tab or select the context ID/Topic pairing on the Context IDs tab. The following advanced features are described in this topic:  Displaying any Help format C1DynamicHelp allows you to use different help formats. 2.Net controls derived from the System. and how to implement your own help provider to display a help file in the format you want. Click the Attach topic to control button . Close the mapping window and deliver the proper Help and . See Also Displaying any Help Format Mapping to Control Parts or Custom Controls 21 .Forms. Click the Save button . 4. Advanced Features DynamicHelp for WinForms requires almost no programming to be used in most cases. 3. Click the Select control button .1. Click the drop-down arrow in the Control combo box and select the parent or ancestor to map to.Windows. This topic describes two builtin help providers. 6. C1DynamicHelp provides this feature for standard .xml mapping file to the software developer.  Mapping to part of a control or custom controls C1DynamicHelp gives you the ability to map a topic not only to standard controls but also to parts of controls or to custom controls.Control class. you can create your own UI element resolver class. but sometimes you may want to use the best of it. Activate authoring mode using the method specified by the software developer. ChmProvider and NetHelpProvider.

which is the full code actually used in the C1DynamicHelp control.Windows. In this case you will have to create your own help provider class that implements the IHelpProvider interface. To inform the C1DynamicHelp control how to handle UI elements. and so on.chm or an . 22 . to open help in an external window. After creating your own help provider. This interface provides all necessary information about a help format to the C1DynamicHelp control. NetHelp. You will need to create a class derived from the UIElementResolver only if you are using custom controls that cannot be handled by the C1DynamicHelp control automatically and then only if you need to associate help topics with parts (UI elements) of those controls. correspondingly. Mapping to Control Parts or Custom Controls Mapping to Control Parts or Custom Controls C1DynamicHelp allows you to map a help topic to any control derived from the System.htm/html file. For more details see:    the IHelpProvider interface. WinHelp.Control. which must be implemented by every help provider. but this requires some additional programming.Forms. So any help provider can read data from a help source and provides methods to get help topics. We will refer to these parts of controls and the custom controls as UI elements. not with the controls themselves. C1DynamicHelp provides means for displaying these or any other help formats.Control class. In most cases it will be enough.0. Any other types of help files can be used. which are used automatically when the HelpSource property points to a .Windows. to get a topic URL that can be displayed by the C1DynamicHelp control.Displaying any Help Format You may want to use different help formats in your application:       HTML help. the NetHelpProvider sample. There are two built-in help providers in C1DynamicHelp.Forms. the Provider property. but sometimes you may want to map a topic not to a control itself but to some part of it or map a topic to a custom control which is not derived from the System. MS Help 2. and so on. all you need is to set it to the Provider property. you will need to create your own class derived from the UIElementResolver class and set it as the Resolver property. ChmProvider and NetHelpProvider. HTML Help and NetHelp formats can be displayed by the C1DynamicHelp control without any additional programming. RoboHelp WebHelp. to get context IDs.

groups. See Also Tutorial 1: Mapping Help Topics at Design Time Tutorial 2: Mapping Help Topics in Authoring Mode Tutorial 1: Mapping Help Topics at Design Time This tutorial explains how to use C1DynamicHelp to map Help topics to controls on a form at design time within Visual Studio.Net controls and to their parts. it is sufficient to define a class derived from UIElementResolver and override its virtual methods. the UsingUIElementResolver sample. which shows how to create custom UI element resolver for the C1Ribbon control to allow mapping topics to items inside C1Ribbon such as tabs. etc. This is usually done by a software developer. Tutorial 1 explains how to map Help topics at design time within Visual Studio. it allows mapping a topic to all standard . coordinates. C1DynamicHelp automatically handles most popular. the Resolver property. standard controls. For example. that you can do without creating your own UIElementResolver class. Tutorial 2 explains how software developers can set up C1DynamicHelp authoring mode and how Help authors can then use it to assign topics to controls on a form. from which you derive your own UI element resolver class. So.. This is usually done by a software developer. you can associate a help topic to a separate node of the standard TreeView control or to a separate ListViewItem of the ListView control. buttons. for example. and other methods necessary for associating dynamic help to UI elements inside a control. For more details see:    the UIElementResolver class.You have no need to create objects of UIElementResolver type. See Also Step 1 of 6: Add controls to the Windows form Step 2 of 6: Set up the C1DynamicHelp control Step 3 of 6: Associate topics with controls on the form Step 4 of 6: Associate a topic with the form 23 . DynamicHelp for WinForms Tutorials The following tutorials provide step-by-step instructions on mapping Help topics to controls within an application. without having to manually edit a topic map. etc. These overridden methods must provide necessary information about UI elements inside custom controls used in your application: methods to find UI elements inside a control by name.

set the button1. It docks at the right of your form. Add a CheckBox control to the form: 1. 4. From the Properties window. 1. you will add the C1DynamicHelp control to your form. From the Toolbox. double-click the TextBox control to add it to your form. Help Topic on C1DynamicHelp. 24 . Button.Step 5 of 6: Show topics programmatically Step 6 of 6: Run the application Step 1 of 6: Add controls to the Windows form In this step.NET project and add the C1DynamicHelp control to the Toolbox. From the Toolbox. set the textBox1. From the Properties window. You have successfully added the controls to your form. Add a TextBox control to the form: 1. 2. Create a . and Checkbox.Text property to Show topic programmatically. Add a Button control to the form: 1. 5. 3.Text property to Show topic on got focus. From the Properties window. is added to all controls when C1DynamicHelp is added to the form. which should look similar to the following: In the next step you will set up the C1DynamicHelp control. double-click the Button control to add it to your form.Text property to Show topic on mouse hover. along with a TextBox. 2. From the Toolbox. double-click the CheckBox control to add it to your form. 2. An extender property. double-click the C1DynamicHelp control. From the Toolbox. 2. set the checkBox1.

you must specify the source Help file. 1.chm file or NetHelp *.chm. 2. Click the C1DynamicHelp smart tag ( ) to open the Tasks menu. Select Button1 and click the ellipsis button next to the HelpTopic on C1DynamicHelp1 property in the Properties window. by default. 3. Click Open. You can do this from the C1DynamicHelp Tasks menu by setting the HelpSource property to any *. by default. we will use the C1Sample.).Step 2 of 6: Set up the C1DynamicHelp control In order to associate topics from your Help file with form controls. 4. In this example.htm file (use the default. 1. Step 3 of 6: Associate topics with controls on the form You can associate Help topics with controls using the Select Help Topic dialog box. The Select Help Topic dialog box opens: 25 . Locate and select the C1Sample. Click the ellipsis button next to the HelpSource property.chm installed with DynamicHelp for WinForms. It is located in the Tutorials/Data folder.htm or the file name that was used as the base URL for the NetHelp target.

Select TextBox1 and set its HelpTopic on C1DynamicHelp1 property to any topic from the Table of Contents tab. Click OK. The topic associated with the form is the default topic. Unchecking Use default events allows you to specify the events on a per-control basis. but notice the Events group is different. 26 . 1. in this case. uncheck Use default events and check the Got focus checkbox next to Show on events. this will do it for all controls if it's not overridden on a per-control basis) and show topics programmatically. or in both cases. Select Form1 and click the ellipsis button next to the HelpTopic on C1DynamicHelp1 property in the Properties window. Select any help topic from the Table of Contents tab and click OK. 5. Using the Events settings makes showing topics automatic when a control obtains focus or the mouse hovers over it. In this example. 4. Otherwise. The Select Help Topic dialog box appears.2. Step 4 of 6: Associate a topic with the form You can also use the Select Help Topic dialog box to associate a topic with your form. it has one check box Always show default topic first on form open. In the Events group of the Select Help Topic dialog box. But if you want manual control over what triggers topic display. you can uncheck both check boxes (or set DefaultTrigger=None. the DefaultTrigger property is used for all controls. 3. we will select the Overview topic. It is shown when the control that displays the current topic due to a focus/mouse hover event loses focus/mouse hover.

ByVal e As System. Create a CheckedChanged event handler for CheckBox1 and add code so it looks like the following: To write code in Visual Basic Visual Basic Copy Code Private Sub CheckBox1_CheckedChanged(ByVal sender As System.htm") End Sub To write code in C# 27 . Step 5 of 6: Show topics programmatically You can show a specific topic programmatically by using the ShowTopic method.If the check box Always show default topic first on form open is checked.ShowTopic("WordDocuments/glossaryofterms. 2. Select the default topic from the Table of Contents tab.EventArgs) Handles CheckBox1. the default topic is also shown when the form is opened.CheckedChanged C1DynamicHelp1.Object.

ShowTopic("WordDocuments/glossaryofterms. When the mouse is over the button. Congratulations. it displays the specified topic. 28 . click the Start Debugging button and notice the following results:     When Form1 is loaded. you have successfully completed Tutorial 1! In this tutorial you have learned how to:    Add and set up the C1DynamicHelp control. the topic is displayed.EventArgs e) { c1DynamicHelp1. When TextBox1 gets the focus.C# Copy Code private void checkBox1_CheckedChanged(object sender. Show topics programmatically. System. Check or uncheck Show topic programmatically to display its associated topic. } Step 6 of 6: Run the application To run the application. the default topic is shown.htm"). Associate topics with controls on a form at design-time.

double-click the TextBox control to add it to your form. he doesn't need to do anything to map topics to controls! This eliminates the error-prone process of passing the topic/control map back and forth between Help authors and software developers.NET project and add the C1DynamicHelp control to the Toolbox. add nodes to the treeView1 according to the following image: 29 . Create a . From the Toolbox. From the Toolbox. Add a TextBox control to the form: 1. double-click the C1DynamicHelp control. 2. Step 3 explains how Help authors can assign topics to controls in authoring mode.Tutorial 2: Mapping Help Topics in Authoring Mode This tutorial shows the second method of assigning Help topics to controls on a form. From the Properties window. 3. From the Toolbox. See Also Step 1 of 4: Add controls to the Windows form Step 2 of 4: Set up the C1DynamicHelp control Step 3 of 4: Using authoring mode Step 4 of 4: Run the Application Step 1 of 4: Add controls to the Windows form To set up your new Form with the C1DynamicHelp control.Text property to Show topic on got focus. Add the TreeView control to the form: 1. 1. set the textBox1. 2. It docks at the right of your form. These steps should be performed by the software developer. a TextBox. double-click the TreeView control to add it to your form. complete the following steps. 4. and a TreeView control. The final step shows how the Help appears in the application. It is done entirely by Help authors. 2. The first two steps of this tutorial explain how software developers can set up their applications for authoring mode. From the Properties window. once a software developer sets up his application to use the C1DynamicHelp authoring mode.

you must specify the source Help file.In the next step you will set up the C1DynamicHelp control. In this example. we will use the C1Sample. Step 2 of 4: Set up the C1DynamicHelp control In order to associate topics from your Help file with form controls. 4. by default. 2. Once a source Help file is specified. by default. Click the C1DynamicHelp smart tag ( ) to open the Tasks menu.htm or the file name that was used as the base URL for the NetHelp target. you can prepare the C1DynamicHelp control to be used in authoring mode. Override the OnKeyDown method by adding the following code: To write code in Visual Basic Visual Basic Copy Code ' toggle authoring mode when the user hits Ctrl+Shift+A 30 . You can do this from the C1DynamicHelp Tasks menu by setting the HelpSource property to any *.). 2.htm file (use the default. 1. This step should be performed by the developer. Prepare the C1DynamicHelp control for using in authoring mode: 1.chm file or NetHelp *.chm. Click the ellipsis button next to the HelpSource property. Locate and select the C1Sample. It is located in the Tutorials/Data folder. From the Properties window. 3. set the Form1.KeyPreview property to True.chm installed with DynamicHelp for WinForms.

AuthoringMode End If MyBase.A && e.Control && e.KeyCode == Keys.Shift) Then C1DynamicHelp1. } base.Protected Overrides Sub OnKeyDown(ByVal e As System.Control And e.KeyEventArgs) If (e.AuthoringMode = Not C1DynamicHelp1.OnKeyDown(e).AuthoringMode.KeyCode = Keys. Create a handler for the Form_Load event and insert the following code to instruct the C1DynamicHelp control to subscribe the controls to the events for showing topics: To write code in Visual Basic Visual Basic Copy Code Private Sub Form1_Load(ByVal sender As System.TopicMap. } 3.Object.Shift) { c1DynamicHelp1.AuthoringMode = !c1DynamicHelp1.Forms.EventArgs) Handles MyBase.Load C1DynamicHelp1.Refresh() End Sub To write code in C# C# Copy Code 31 .OnKeyDown(e) End Sub To write code in C# C# Copy Code // toggle authoring mode when the user hits Ctrl+Shift+A override protected void OnKeyDown(KeyEventArgs e) { if (e. ByVal e As System.A And e.Windows.

FormClosingEventArgs e) { if (c1DynamicHelp1.Yes) c1DynamicHelp1. "C1DynamicHelp Tutorial". MessageBoxIcon. ByVal e As System.TopicMap. Create a handler for the Form_Closing event and insert the following code to ask the user whether to save changes made in the topic map: To write code in Visual Basic Visual Basic Copy Code Private Sub Form1_FormClosing(ByVal sender As System.Refresh().FormClosing If (C1DynamicHelp1.YesNoCancel.TopicMap.Cancel = True End If End If End Sub To write code in C# C# Copy Code private void Form1_FormClosing(object sender.TopicMap.Show("Would you like to save the changes you made to control/topic map?". if (result == DialogResult. "C1DynamicHelp Tutorial".Save(). EventArgs e) { c1DynamicHelp1.TopicMap.Windows.TopicMap.Object.Question) If (dr = DialogResult.FormClosingEventArgs) Handles MyBase.HasChanges) Then Dim dr As DialogResult dr = MessageBox.YesNoCancel .Show("Would you like to save the changes you made to control/topic map?". MessageBoxButtons. MessageBoxButtons.Cancel) Then e. } 5.Forms.HasChanges) { DialogResult result = MessageBox. 32 .Save() ElseIf (dr = DialogResult.private void Form1_Load(object sender.Question). MessageBoxIcon.Yes) Then C1DynamicHelp1.

select the Overview topic and click OK. 4. and select the Overview node. Map a topic to the TreeView nodes: 1. 2. Run the application from the software developer and press the Ctrl+Shift+A keys together to activate authoring mode. 3. Note: In authoring mode you have the ability to associate topics with objects whose class is not derived from Component. select the Glossary of Terms topic. Click the Attach topic to control button . because there is no Component to set for the HelpTopic on 33 . Click Select control button and select TextBox1. Assign the How to use C1DynamicHelp topic to the How to Use node using steps a-c. 2. Map a topic to the TextBox control: 1. Assign the Runtime support topic to the Runtime node using steps a-c. Note that the corresponding topics are displayed when the mouse hovers over each of the TreeView nodes. The authoring mode panel appears. 3. The Select Help Topic dialog box appears. Note that a topic is now displayed only when TextBox1 gets focus not when the mouse hovers over it. } } No controls have topics associated with them yet. On the Table of Contents tab. On the Table of Contents tab. 4. The Select Help Topic dialog box appears. such as TreeNode or ListBox items. Uncheck the Use default events and Mouse hover checkboxes so that only Got focus is checked. 5. Assign the Design time support topic to the Design time node using steps a-c. 1. Click OK. 5.Cancel) e.else if (result == DialogResult.Cancel = true. This cannot be done at design time. 6. The application can now be used by a Help author to map topics to controls. Step 3 of 4: Using authoring mode This step explains how the Help author can activate authoring mode and associate topics with controls. 3. Click the Attach topic to control button . Click Select control button 2.

prompting you to save the changes.htm</value> <events useDefaultEvents="True">3</events> </item> <item> <key>Form1\treeView1\Node0</key> <value>WordDocuments/overview. 6. only with an . button to save the changes to an .xml extension. if changed. 5.C1DynamicHelp1 property.htm</value> <events useDefaultEvents="True">3</events> </item> <item> <key>Form1\treeView1\Node1\Node3</key> <value>WordDocuments/runtimesupport.xml file. 4. 34 . 8. It will also have the same name as the specified Help file.chm.xml file Note: If you close the application without saving the control/topic mapping. The topic map is saved to the same location as the Help file specified in the HelpSource property. Click the Save control/topic mapping that serves as the topic map. In this example. click the Start Debugging button and notice the following results. Step 4 of 4: Run the Application To run the application.xml file.chm.htm</value> <events useDefaultEvents="False">1</events> </item> <item> <key>Form1\treeView1\Node1</key> <value>WordDocuments/howtousec1dynamichelp.htm</value> <events useDefaultEvents="True">3</events> </item> </Dictionary> Give the C1Sample. This step should be performed by the developer. It should now look like this: XML code <Dictionary> <item> <key>Form1\textBox1</key> <value>WordDocuments/glossaryofterms. 7. the topic map can be found in the C1Sample. along with the updated Help file(s). a dialog box will appear.htm</value> <events useDefaultEvents="True">3</events> </item> <item> <key>Form1\treeView1\Node1\Node2</key> <value>WordDocuments/designtimesupport. to the software developer.

Win. Only when TextBox1 gets the focus will it display a topic.C1DynamicHelp. Activate/deactivate authoring mode.Win.4 Assembly C1. you have successfully completed Tutorial 2! In this tutorial you have learned how to:     Add and set up the C1DynamicHelp control. API Reference The following topics contain the API reference for DynamicHelp for WinForms. Save changes in the topic map. See Also C1. Congratulations.C1DynamicHelp Namespace Overview Classes 35 . Associate topics to controls on a form in authoring mode. the specified topics are displayed.  When the mouse hovers over the TreeView nodes.4 Assembly Namespaces C1.Win.C1DynamicHelp.

UIElementInfo This class contains information about a UI element: its Name and Parent. HelpTopic Represents a topic in a help file. TopicEventArgs Provides data for a topic change event.Conflicts property of the TopicMap. 36 . Enumerations Enumeration Description DisplayTarget Enumeration that specifies where a topic will be displayed. MapItem Class containing a pair consisting of a topic and a user action triggering its display. HelpTopicList List of HelpTopic objects.CurrentTopicChanging event of a C1DynamicHelp. and other methods necessary for associating dynamic help to UI elements inside a control. etc. UIElementResolver This class provides methods to find UI elements inside a control by name. coordinates. Delegates Delegate Description HelpTopicEventHandler Represents a method that will handle the C1DynamicHelp. TopicMap Class used to store combinations of topics and user actions that cause their display. Conflict Class used in the TopicMap.Class Description C1DynamicHelp Provides dynamic help for applications.

UIElementEvents Enumeration that specifies which of the monitored events occurred for a UI element.C1DynamicHelp. or without programmers. using the HelpTopic extender property.4 Assembly Classes C1DynamicHelp Provides dynamic help for applications. using the control's 'authoring mode' facilities. MapItemType Enumeration that specifies topic map item type. 37 .Control Remarks The C1DynamicHelp control displays help topics from CHM.Win.Windows. Topics in the help file can be associated with components in the application either by a programmer at design time. HelpTopicTrigger Enumeration that specifies user actions that cause a HelpTopic to be displayed. The HelpSource property specifies the help file containing the documentation.HelpTab Enumeration specifying the part/element of the help file to display. See Also Reference C1.Forms.Windows. NetHelp and other help files. Object Model Syntax Visual Basic (Declaration) Public Class C1DynamicHelp Inherits System.Control C# public class C1DynamicHelp : System.Forms.

Win. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Members C1.Windows.Windows. using the control's 'authoring mode' facilities. or without programmers.C1DynamicHelp.Control C# public class C1DynamicHelp : System.C1DynamicHelp Requirements Target Platforms: Windows 7. Windows XP SP3.Forms. using the HelpTopic extender property. Windows Server 2008 R2 (Server Core supported with SP1 or later).Component System. NetHelp and other help files. Object Model Syntax Visual Basic (Declaration) Public Class C1DynamicHelp Inherits System.Object System. The HelpSource property specifies the help file containing the documentation.Control Remarks The C1DynamicHelp control displays help topics from CHM.Inheritance Hierarchy System. Windows Server 2008 (Server Core not supported). Topics in the help file can be associated with components in the application either by a programmer at design time.Win. Inheritance Hierarchy 38 .Forms. Windows Vista SP1 or later.ComponentModel.Control C1.Windows.C1DynamicHelp Namespace Overview Provides dynamic help for applications.MarshalByRefObject System.Forms.

Control) AccessibleDescription (Inherited from System. Public Constructors Name Description C1DynamicHelp Constructor Creates a new instance of the C1DynamicHelp control.Windows.Windows.Control) 39 .ComponentModel.Forms.Windows.MarshalByRefObject System.Forms.Control C1.Forms.Windows.C1DynamicHelp Namespace Members Properties Methods Events The following tables list the members exposed by C1DynamicHelp. Windows Server 2008 R2 (Server Core supported with SP1 or later).Object System.Control) AccessibleDefaultActionDescription (Inherited from System.Windows. Windows XP SP3.Windows.C1DynamicHelp.Forms.Win.C1DynamicHelp Requirements Target Platforms: Windows 7.Forms. Windows Vista SP1 or later.Win. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Members C1.System.Control) AccessibleName (Inherited from System. Windows Server 2008 (Server Core not supported).Forms.Control) AccessibleRole (Inherited from System. Top Public Properties Name Description AccessibilityObject (Inherited from System.Component System.

AutoScrollOffset (Inherited from System.Windows.ComponentModel.Forms.Control) Bounds (Inherited from System. for example.Control) CanSelect (Inherited from System.Control) BindingContext (Inherited from System.Forms.Windows. to navigate help topics inside the C1DynamicHelp control.Control) AuthoringMode Gets or sets a value indicating whether the control is currently in 'authoring mode'. CanFocus (Inherited from System.Control) CausesValidation (Inherited from System.Forms.Forms.Windows. so the programmer can use browser features programmatically.Windows.Forms.Control) Container (Inherited from System.Forms.Component) 40 .Forms.Anchor (Inherited from System.Forms.Control) Browser Provides access to the browser object used to display the topics.Windows.Windows.Forms.Control) ClientSize (Inherited from System.Forms.Windows. Bottom (Inherited from System.Windows.Windows.Control) CompanyName (Inherited from System.Windows.Windows.Control) BorderStyle Gets or sets the type of border to display around the control.Control) Capture (Inherited from System.Forms.Windows.Forms.Control) ClientRectangle (Inherited from System.

Forms.Forms.Windows.Control) DefaultTrigger Gets or sets a default HelpTopicTrigger value for the C1DynamicHelp control.Forms. Gets or sets which control borders are docked to its parent control and determines how the control is resized with its parent.Windows.Forms.Control) Height (Inherited from System.Windows.Forms.Windows.Windows.Control) CurrentTopic Gets or sets the HelpTopic that is currently displayed by the C1DynamicHelp control.Control) Disposing (Inherited from System. such as 41 .Forms. DataBindings (Inherited from System.Windows. ContextMenuStrip Overridden. Controls (Inherited from System.Control) HelpSource Gets or sets the location of the help source.Control) HasChildren (Inherited from System.Forms.Forms.Forms. DisplayRectangle (Inherited from System.Forms.Forms.Windows.Control) Dock Overridden.Control) Handle (Inherited from System.ContextMenuStrip associated with this control. Focused (Inherited from System.Control) ContextMenu Overridden.ContainsFocus (Inherited from System.Windows. Gets or sets the System.Windows.Windows.Windows. Gets or sets the shortcut menu associated with the control.Control) Created (Inherited from System.

the name of a . InvokeRequired (Inherited from System. Margin (Inherited from System.Windows.Control) MinimumSize (Inherited from System.Windows.Forms.Windows. in milliseconds.Control) MouseHoverDelay Gets or sets the interval. between the time the mouse enters a control or component and the time the associated HelpTopic is displayed in the C1DynamicHelp control.Forms.Control) IsAccessible (Inherited from System.Windows.Forms.Control) IsDisposed (Inherited from System.Windows.Windows.Forms.Forms. LayoutEngine (Inherited from System.Windows.Control) Location (Inherited from System.Windows.chm file (for HTML Help) or the name of the main .Forms.Control) 42 . Name (Inherited from System.Forms.Forms.Windows.Windows.Control) MainControl Gets or sets a reference to another C1DynamicHelp control which will be used as a source of data for the current C1DynamicHelp control.Control) IsPinnedDown Gets or sets a value indicating whether the current help topic is pinned down.Forms.Control) IsHandleCreated (Inherited from System.Control) Left (Inherited from System.Windows.Control) IsMirrored (Inherited from System.Forms.Forms.Control) MaximumSize (Inherited from System.htm file (for NetHelp).Forms.Windows.

Control) ProductVersion (Inherited from System.Forms.Windows.Control) Resolver Represents a class with virtual methods that are used to supply information about custom controls used in the application.Forms.Forms.Forms.Forms.Control) ProductName (Inherited from System.Windows.Control) Top (Inherited from System.Windows.Windows.Windows.Windows. RecreatingHandle (Inherited from System.Control) Tag (Inherited from System.Control) Region (Inherited from System.Control) Provider Gets or sets a reference to a help provider.Windows.Forms.Windows.Parent (Inherited from System.Control) TopicMap A dictionary that maps UI elements to MapItem objects.Windows.Windows.Windows.Forms.Forms.Forms.Windows.Control) 43 .Control) TabIndex (Inherited from System.Forms.Control) PreferredSize (Inherited from System.Forms.Windows.Forms.Forms. Right (Inherited from System.Control) Size (Inherited from System.Control) Visible (Inherited from System.Control) TabStop (Inherited from System.Windows.Forms. TopLevelControl (Inherited from System.Control) Site (Inherited from System.Windows.Forms.

Forms.Control) CreateObjRef (Inherited from System.Windows.Windows. (Inherited from System.Windows.Control) FindForm (Inherited from System. 44 .Forms.Forms.Windows.Control) CreateControl (Inherited from System.Control) Top Public Methods Name Description BeginInvoke Overloaded.Forms.Windows.Forms.Forms.Control) GetContainerControl (Inherited from System.Windows.Windows.MarshalByRefObject) Dispose() (Inherited from System.Forms. (Inherited from System.Width (Inherited from System.ComponentModel.Forms.Forms.Component) DoDragDrop (Inherited from System.Control) CreateGraphics (Inherited from System.Control) BringToFront (Inherited from System.Control) EndInvoke (Inherited from System.Control) DrawToBitmap (Inherited from System.Control) GetHelpTopic Gets the MapItem object currently associated with a given UI element.Windows.Forms.Forms.Forms.Forms.Windows.Windows.Windows.Windows.Windows.Control) GetChildAtPoint Overloaded.Control) Focus (Inherited from System.Control) Contains (Inherited from System.

Windows.Forms.Forms.Forms. (Inherited from System.Windows.Forms. (Inherited from System.Control) Select (Inherited from System.Forms.Control) Scale (Inherited from System.Forms.Windows.Control) ResetText (Inherited from System.Windows.Control) PointToScreen (Inherited from System.Windows.Forms.Forms. (Inherited from System.Windows.Forms.Control) PerformLayout Overloaded.Control) RectangleToScreen (Inherited from System. (Inherited from System.Windows.Control) Refresh (Inherited from System.Control) PreProcessControlMessage (Inherited from System.Control) InitializeLifetimeService (Inherited from System.Forms.Control) 45 .Control) PreProcessMessage (Inherited from System.Forms.Windows.Forms.Windows.Windows.Windows.Control) ResumeLayout Overloaded.MarshalByRefObject) Invalidate Overloaded.Windows.Control) RectangleToClient (Inherited from System.Forms.Control) GetPreferredSize (Inherited from System.Forms.GetLifetimeService (Inherited from System.Forms.Windows.Control) PointToClient (Inherited from System.Windows.Windows.Control) Hide (Inherited from System.Forms.Forms.Windows.Windows.Control) Invoke Overloaded.MarshalByRefObject) GetNextControl (Inherited from System.

Windows.Windows. Show (Inherited from System.Control) Top Public Events Name Description CausesValidationChanged (Inherited from System.Windows.Control) ShowDefaultTopic Shows the topic associated with the Form where the C1DynamicHelp control is placed. ShowExternalHelp Overloaded.Control) SetHelpTopic Associates a MapItem object with a UI element.SelectNextControl (Inherited from System.Windows.Control) ToString (Inherited from System.Control) 46 . Shows the topic with the given URL in the C1DynamicHelp control.Forms.Forms.Forms.Windows.ComponentModel.Forms.Windows.Forms. SuspendLayout (Inherited from System.Forms. (Inherited from System.Windows.Control) SendToBack (Inherited from System.Forms. ShowTopicForActiveControl Shows in DisplayTarget the topic associated with the active control (control currently in focus).Component) Update (Inherited from System.Control) ClientSizeChanged (Inherited from System.Forms.Control) SetBounds Overloaded.Windows. ShowTopic Overloaded. Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel.

Windows.Windows.Forms.Control) CurrentTopicChanged Fires after the value of the CurrentTopic has changed.Forms.Forms.Forms.Windows.Forms.Windows.Control) LostFocus (Inherited from System.Windows.Forms.Control) HandleCreated (Inherited from System.Control) MarginChanged (Inherited from System.Control) 47 .Control) PreviewKeyDown (Inherited from System.Forms.Windows.Control) Move (Inherited from System.Forms.Forms.Windows.Control) ContextMenuStripChanged (Inherited from System.ComponentModel.Control) Invalidated (Inherited from System.Forms.Component) DockChanged (Inherited from System.Forms.Forms.Control) LocationChanged (Inherited from System.Control) HandleDestroyed (Inherited from System.Control) ControlRemoved (Inherited from System.Windows.Control) RegionChanged (Inherited from System.Forms.Windows.Windows.Forms.Windows.Control) GotFocus (Inherited from System.Windows.Forms.Forms.Control) ParentChanged (Inherited from System.Windows.Windows.Windows. CurrentTopicChanging Fires before the value of the CurrentTopic changes.Windows.ContextMenuChanged (Inherited from System.Control) ControlAdded (Inherited from System. Disposed (Inherited from System.

Forms.Control) Validating (Inherited from System.Control) Top See Also Reference C1DynamicHelp Class C1.Forms.Resize (Inherited from System.Forms.Windows. Windows Vista SP1 or later.Forms. Windows Server 2003 SP2 See Also 48 . Syntax Visual Basic (Declaration) Public Function New() C# public C1DynamicHelp() Requirements Target Platforms: Windows 7.Forms.Control) SizeChanged (Inherited from System.Forms.Windows.Control) TabIndexChanged (Inherited from System.Windows. Windows XP SP3.Control) TabStopChanged (Inherited from System.Forms.Control) SystemColorsChanged (Inherited from System.Win. Windows Server 2008 (Server Core not supported).Control) Validated (Inherited from System.Windows.Control) VisibleChanged (Inherited from System.Windows.C1DynamicHelp Namespace C1DynamicHelp Constructor Creates a new instance of the C1DynamicHelp control.Forms.Windows. Windows Server 2008 R2 (Server Core supported with SP1 or later).Windows.Windows.

MarshalByRefObject) Invalidate Overloaded.Windows.Forms.Control) Focus (Inherited from System.MarshalByRefObject) GetNextControl (Inherited from System.Control) CreateObjRef (Inherited from System.Windows.Control) Contains (Inherited from System.Forms.Forms.Forms. GetLifetimeService (Inherited from System.ComponentModel.Windows.Forms.Forms.Forms.Control) GetHelpTopic Gets the MapItem object currently associated with a given UI element.Control) 49 .Windows.Windows.Control) CreateControl (Inherited from System.Control) FindForm (Inherited from System.Forms.Forms.Windows.Control) EndInvoke (Inherited from System.Control) GetPreferredSize (Inherited from System. (Inherited from System.Windows.Control) CreateGraphics (Inherited from System.MarshalByRefObject) Dispose() (Inherited from System. (Inherited from System.Windows.Forms.Reference C1DynamicHelp Class C1DynamicHelp Members Methods > Name Description BeginInvoke Overloaded.Forms.Windows.Control) GetChildAtPoint Overloaded.Forms.Windows.Windows.Windows.Control) DrawToBitmap (Inherited from System.Control) GetContainerControl (Inherited from System.Windows.Windows.Windows.Forms. (Inherited from System.Forms.Forms.Component) DoDragDrop (Inherited from System.Control) InitializeLifetimeService (Inherited from System.Control) Hide (Inherited from System.Forms.Control) BringToFront (Inherited from System.Windows.

Windows.ComponentModel. Show (Inherited from System. SuspendLayout (Inherited from System.Windows.Forms.Control) ResumeLayout Overloaded.Control) Scale (Inherited from System.Control) RectangleToScreen (Inherited from System.Control) PointToClient (Inherited from System. (Inherited from System.Windows.Forms.Control) PreProcessControlMessage (Inherited from System.Windows.Forms.Forms. Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel.Forms.Windows.Forms.Windows.Invoke Overloaded. (Inherited from System.Windows.Control) SetBounds Overloaded.Windows.Windows.Forms.Forms.Control) PreProcessMessage (Inherited from System.Forms.Forms. Shows the topic with the given URL in the C1DynamicHelp control.Control) RectangleToClient (Inherited from System. ShowTopic Overloaded.Component) Update (Inherited from System.Windows.Control) ToString (Inherited from System.Control) 50 .Forms. ShowTopicForActiveControl Shows in DisplayTarget the topic associated with the active control (control currently in focus).Control) PointToScreen (Inherited from System.Windows.Forms.Control) Select (Inherited from System. (Inherited from System.Windows. (Inherited from System.Control) SetHelpTopic Associates a MapItem object with a UI element.Windows.Control) Refresh (Inherited from System.Forms.Windows.Windows.Windows.Control) PerformLayout Overloaded.Forms.Forms.Forms.Windows.Forms. ShowExternalHelp Overloaded.Control) SendToBack (Inherited from System.Control) ShowDefaultTopic Shows the topic associated with the Form where the C1DynamicHelp control is placed.Windows.Windows.Control) SelectNextControl (Inherited from System.Control) ResetText (Inherited from System.Forms.Forms.

C1DynamicHelp Namespace GetHelpTopic Method Represents a UI element associated with a help topic. Requirements Target Platforms: Windows 7.Win. Gets the MapItem object currently associated with a given UI element. Return Value The MapItem object associated with the specified UI element. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). Syntax Visual Basic (Declaration) Public Function GetHelpTopic( _ ByVal uiElement As Component _ ) As MapItem C# public MapItem GetHelpTopic( Component uiElement ) Parameters uiElement Represents a UI element associated with a help topic. Windows XP SP3. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members 51 .Top See Also Reference C1DynamicHelp Class C1.

info The MapItem object to associate with the uiElement. Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). _ ByVal info As MapItem _ ) C# public void SetHelpTopic( Component uiElement. MapItem info ) Parameters uiElement Object associated with the help topic. Associates a MapItem object with a UI element. Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Public Sub SetHelpTopic( _ ByVal uiElement As Component. The MapItem object to associate with the uiElement.SetHelpTopic Method Object associated with the help topic. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members ShowDefaultTopic Method Shows the topic associated with the Form where the C1DynamicHelp control is placed. Windows XP SP3. Windows Vista SP1 or later. Syntax 52 .

Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. Windows XP SP3. Windows Server 2008 (Server Core not supported). Windows Server 2008 (Server Core not supported). ShowExternalHelp(HelpTab. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members ShowExternalHelp Method Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel. Requirements Target Platforms: Windows 7.Visual Basic (Declaration) Public Sub ShowDefaultTopic() C# public void ShowDefaultTopic() Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members 53 . Windows Vista SP1 or later.Object) Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel. Overload List Overload Description ShowExternalHelp(HelpTab) Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel.

Windows Server 2008 (Server Core not supported). Windows XP SP3. Requirements Target Platforms: Windows 7. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members Overload List ShowExternalHelp(HelpTab.Object) Method One of the HelpTab values. Windows Vista SP1 or later. Syntax Visual Basic (Declaration) Public Overloads Sub ShowExternalHelp( _ 54 . Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel. Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel. Syntax Visual Basic (Declaration) Public Overloads Sub ShowExternalHelp( _ ByVal tab As HelpTab _ ) C# public void ShowExternalHelp( HelpTab tab ) Parameters tab One of the HelpTab values. Windows Server 2008 R2 (Server Core supported with SP1 or later).ShowExternalHelp(HelpTab) Method One of the HelpTab values.

Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. Overload List Overload Description ShowTopic(String) Shows the topic with the given URL in the C1DynamicHelp control. ShowTopic(HelpTopic) Shows the given HelpTopic in the C1DynamicHelp control. 55 . parameter Requirements Target Platforms: Windows 7.ByVal tab As HelpTab. Windows Vista SP1 or later. ShowTopic(Int32) Shows the topic with the given context id in the C1DynamicHelp control. object parameter ) Parameters tab One of the HelpTab values. _ ByVal parameter As Object _ ) C# public void ShowExternalHelp( HelpTab tab. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members Overload List ShowTopic Method Shows the topic with the given URL in the C1DynamicHelp control. Windows Server 2008 (Server Core not supported).

ShowTopic(Object) Shows the topic associated in the TopicMap with a UI element in the C1DynamicHelp control. Windows XP SP3. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members ShowTopic(String) Method String that represents the topic's internal URL. Requirements 56 . Exceptions Exception Description System. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported).ArgumentNullException topicUrl is null. Windows Vista SP1 or later. Shows the topic with the given URL in the C1DynamicHelp control. Requirements Target Platforms: Windows 7. Syntax Visual Basic (Declaration) Public Overloads Sub ShowTopic( _ ByVal topicUrl As String _ ) C# public void ShowTopic( string topicUrl ) Parameters topicUrl String that represents the topic's internal URL.

ArgumentNullException topic is null. Windows Server 2008 (Server Core not supported). Exceptions Exception Description System. Shows the given HelpTopic in the C1DynamicHelp control. Windows Server 2008 R2 (Server Core supported with SP1 or later).Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members Overload List ShowTopic(HelpTopic) Method HelpTopic object representing the topic. Requirements Target Platforms: Windows 7. Windows XP SP3. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Vista SP1 or later. Windows XP SP3. Syntax Visual Basic (Declaration) Public Overloads Sub ShowTopic( _ ByVal topic As HelpTopic _ ) C# public void ShowTopic( HelpTopic topic ) Parameters topic HelpTopic object representing the topic. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also 57 .

Reference C1DynamicHelp Class C1DynamicHelp Members Overload List ShowTopic(Int32) Method Context id representing the topic. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members Overload List 58 .ArgumentException specified context id is unknown. Windows Vista SP1 or later. Windows XP SP3. Exceptions Exception Description System. Windows Server 2008 (Server Core not supported). Syntax Visual Basic (Declaration) Public Overloads Sub ShowTopic( _ ByVal contextID As Integer _ ) C# public void ShowTopic( int contextID ) Parameters contextID Context id representing the topic. Windows Server 2008 R2 (Server Core supported with SP1 or later). Shows the topic with the given context id in the C1DynamicHelp control. Requirements Target Platforms: Windows 7.

ShowTopic(Object) Method
Object associated with the topic to display.
Shows the topic associated in the TopicMap with a UI element in the C1DynamicHelp control.

Syntax
Visual Basic (Declaration)
Public Overloads Sub ShowTopic( _
ByVal uiElement As Object _
)
C#
public void ShowTopic(
object uiElement
)

Parameters
uiElement
Object associated with the topic to display.

Exceptions
Exception

Description

System.ArgumentNullException uiElement is null.

Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows
Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported
with SP1 or later), Windows Server 2003 SP2

See Also
Reference
C1DynamicHelp Class
C1DynamicHelp Members
Overload List

ShowTopicForActiveControl Method
DisplayTarget where a topic will be displayed.
Shows in DisplayTarget the topic associated with the active control (control currently in focus).

59

Syntax
Visual Basic (Declaration)
Public Sub ShowTopicForActiveControl( _
ByVal displayTarget As DisplayTarget _
)
C#
public void ShowTopicForActiveControl(
DisplayTarget displayTarget
)

Parameters
displayTarget
DisplayTarget where a topic will be displayed.

Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows
Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported
with SP1 or later), Windows Server 2003 SP2

See Also
Reference
C1DynamicHelp Class
C1DynamicHelp Members

Properties
%%scrap%%
" -->
For a list of all members of this type, see C1DynamicHelp members.

Public Properties
Name

Description

AccessibilityObject

(Inherited from System.Windows.Forms.Control)

AccessibleDefaultActionDescription (Inherited from System.Windows.Forms.Control)

60

AccessibleDescription

(Inherited from System.Windows.Forms.Control)

AccessibleName

(Inherited from System.Windows.Forms.Control)

AccessibleRole

(Inherited from System.Windows.Forms.Control)

Anchor

(Inherited from System.Windows.Forms.Control)

AuthoringMode

Gets or sets a value indicating whether the control is
currently in 'authoring mode'.

AutoScrollOffset

(Inherited from System.Windows.Forms.Control)

BindingContext

(Inherited from System.Windows.Forms.Control)

BorderStyle

Gets or sets the type of border to display around the
control.

Bottom

(Inherited from System.Windows.Forms.Control)

Bounds

(Inherited from System.Windows.Forms.Control)

Browser

Provides access to the browser object used to display
the topics, so the programmer can use browser
features programmatically, for example, to navigate
help topics inside the C1DynamicHelp control.

CanFocus

(Inherited from System.Windows.Forms.Control)

CanSelect

(Inherited from System.Windows.Forms.Control)

Capture

(Inherited from System.Windows.Forms.Control)

CausesValidation

(Inherited from System.Windows.Forms.Control)

ClientRectangle

(Inherited from System.Windows.Forms.Control)

ClientSize

(Inherited from System.Windows.Forms.Control)

61

Windows.Windows.Control) Created (Inherited from System.Control) DefaultTrigger Gets or sets a default HelpTopicTrigger value for the C1DynamicHelp control.Control) Container (Inherited from System.CompanyName (Inherited from System. Controls (Inherited from System.Windows. Focused (Inherited from System.Control) CurrentTopic Gets or sets the HelpTopic that is currently displayed by the C1DynamicHelp control.Windows. Gets or sets which control borders are docked to its parent control and determines how the control is resized with its parent.Windows.Windows.ContextMenuStrip associated with this control.Control) ContextMenu Overridden.Control) 62 .Windows.Forms.Forms. Gets or sets the shortcut menu associated with the control. DataBindings (Inherited from System.Control) Disposing (Inherited from System.Windows.Forms.Component) ContainsFocus (Inherited from System. Gets or sets the System.Windows. DisplayRectangle (Inherited from System.Forms.ComponentModel.Forms.Control) Dock Overridden.Forms.Windows. ContextMenuStrip Overridden.Control) Handle (Inherited from System.Forms.Forms.Forms.Forms.

Control) IsMirrored (Inherited from System. such as the name of a .Windows.Control) MouseHoverDelay Gets or sets the interval.Windows.Forms. LayoutEngine (Inherited from System.Windows.Forms.Windows.Windows.Control) MinimumSize (Inherited from System.Forms.Control) IsHandleCreated (Inherited from System.Forms.Control) Location (Inherited from System.Control) HelpSource Gets or sets the location of the help source.Windows.Forms.Control) Height (Inherited from System.htm file (for NetHelp).Control) Left (Inherited from System.Control) IsPinnedDown Gets or sets a value indicating whether the current help topic is pinned down. Margin (Inherited from System.Windows.HasChildren (Inherited from System.Forms. between the 63 .Control) IsAccessible (Inherited from System.Control) IsDisposed (Inherited from System.Control) MaximumSize (Inherited from System.Windows.Forms.Forms.Windows.Forms.Forms. InvokeRequired (Inherited from System. in milliseconds.Control) MainControl Gets or sets a reference to another C1DynamicHelp control which will be used as a source of data for the current C1DynamicHelp control.Windows.Forms.Forms.chm file (for HTML Help) or the name of the main .Forms.Windows.Windows.Windows.

Windows.Windows.Windows.Windows.Forms.Forms.Control) Provider Gets or sets a reference to a help provider.Windows.Forms.Forms.Windows.Control) 64 .Windows. Name (Inherited from System.Forms.Control) ProductName (Inherited from System.Forms. RecreatingHandle (Inherited from System.Windows.Control) PreferredSize (Inherited from System.Forms.Forms.Forms.Control) TabStop (Inherited from System.Forms.Control) Tag (Inherited from System.Windows.Forms.Control) TabIndex (Inherited from System.Control) Resolver Represents a class with virtual methods that are used to supply information about custom controls used in the application.Control) Parent (Inherited from System.Control) Site (Inherited from System.Windows.Windows.Control) Region (Inherited from System.Forms.Control) Size (Inherited from System.Windows.Windows.Forms.Control) Top (Inherited from System.Windows. Right (Inherited from System.time the mouse enters a control or component and the time the associated HelpTopic is displayed in the C1DynamicHelp control.Control) ProductVersion (Inherited from System.Forms.

Shift) { 65 . authoring mode needs to be be disabled in the release application to prevent users from accidentally activating the authoring mode. Syntax Visual Basic (Declaration) Public Property AuthoringMode As Boolean C# public bool AuthoringMode {get.Windows. In most cases.C1DynamicHelp Namespace AuthoringMode Property Gets or sets a value indicating whether the control is currently in 'authoring mode'. If a UI element appears with both dynamic and static MapItem.Win.TopicMap A dictionary that maps UI elements to MapItem objects. and save it to an XML file.KeyCode == Keys.Windows. All map items created in authoring mode have their ItemType property set to MapItemType.Control) Width (Inherited from System. the entry with the dynamic MapItem.ItemType.ItemType will be used instead of the static one.} Remarks This property allows the application user to create or modify the TopicMap at run time.Control) Visible (Inherited from System.ItemType.Forms. set.Windows. The map items with dynamic ItemType have precedence over the items with static MapItem.Forms.Dynamic. A typical implementation can look like this: // toggle authoring mode when the user hits ctrl+shift+a override protected void OnKeyDown(KeyEventArgs e) { #if AUTHOR_MODE if (e.A && e. TopLevelControl (Inherited from System.Control && e.Control) Top See Also Reference C1DynamicHelp Class C1. Authoring mode is typically enabled only in special builds used by control authors to create the dynamic topic map that is shipped with the release version of the application.Forms.

to navigate help topics inside the C1DynamicHelp control. Syntax Visual Basic (Declaration) 66 . Windows Server 2008 (Server Core not supported). Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later).c1DynamicHelp1. } #endif base. Windows XP SP3. Windows Vista SP1 or later. so the programmer can use browser features programmatically. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members Browser Property Provides access to the browser object used to display the topics. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members BorderStyle Property Gets or sets the type of border to display around the control. set.AuthoringMode.} Requirements Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3.OnKeyDown(e).AuthoringMode = !c1DynamicHelp1. for example. } Requirements Target Platforms: Windows 7. Syntax Visual Basic (Declaration) Public Property BorderStyle As BorderStyle C# public BorderStyle BorderStyle {get. Windows Vista SP1 or later.

Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later).} Property Value A System. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members ContextMenu Property Gets or sets the shortcut menu associated with the control. Windows XP SP3. Windows Server 2008 (Server Core not supported). set. Windows Vista SP1 or later. Requirements Target Platforms: Windows 7. Syntax Visual Basic (Declaration) Public Overrides Property ContextMenu As ContextMenu C# public override ContextMenu ContextMenu {get. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later).} Requirements Target Platforms: Windows 7. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members 67 . Windows XP SP3.ContextMenu that represents the shortcut menu associated with the control.Public ReadOnly Property Browser As WebBrowser C# public WebBrowser Browser {get.Forms.Windows.

Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members CurrentTopic Property Gets or sets the HelpTopic that is currently displayed by the C1DynamicHelp control.Windows.ContextMenuStrip Property Gets or sets the System. Requirements Target Platforms: Windows 7.ContextMenuStrip associated with this control. Windows Server 2008 (Server Core not supported). Syntax Visual Basic (Declaration) Public Property CurrentTopic As HelpTopic C# public HelpTopic CurrentTopic {get.ContextMenuStrip. Windows Vista SP1 or later. set. Windows XP SP3. Windows Vista SP1 or later. Syntax Visual Basic (Declaration) Public Overrides Property ContextMenuStrip As ContextMenuStrip C# public override ContextMenuStrip ContextMenuStrip {get.Forms. set. The default is null.Windows. Windows Server 2003 SP2 68 .} Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows XP SP3.Windows.Forms.Forms. or null if there is no System.ContextMenuStrip for this control. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 R2 (Server Core supported with SP1 or later).} Property Value The System.

Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members Dock Property Gets or sets which control borders are docked to its parent control and determines how the control is resized with its parent. set. Windows XP SP3. Map items that have MapItem. Syntax Visual Basic (Declaration) Public Property DefaultTrigger As HelpTopicTrigger C# public HelpTopicTrigger DefaultTrigger {get.UseDefaultTrigger property set to true (default) display their topic when the event specified in the DefaultTrigger property occurs.UseDefaultTrigger = false specify their triggers individually in HelpTopicTrigger.See Also Reference C1DynamicHelp Class C1DynamicHelp Members DefaultTrigger Property Gets or sets a default HelpTopicTrigger value for the C1DynamicHelp control.} Remarks All map items in the TopicMap that have their MapItem. Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Syntax Visual Basic (Declaration) Public Overrides Property Dock As DockStyle 69 .

C# public override DockStyle Dock {get.} Requirements Target Platforms: Windows 7. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members HelpSource Property Gets or sets the location of the help source. Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members IsPinnedDown Property Gets or sets a value indicating whether the current help topic is pinned down. Windows XP SP3. such as the name of a . Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Vista SP1 or later.} Remarks The name of the file may be absolute or relative. Requirements Target Platforms: Windows 7. In most cases. Windows XP SP3. set. 70 . set. Windows Vista SP1 or later. Syntax Visual Basic (Declaration) Public Property HelpSource As String C# public string HelpSource {get.htm file (for NetHelp). Windows Server 2008 (Server Core not supported). the name will be relative and will refer to the application's bin folder. Windows Server 2008 R2 (Server Core supported with SP1 or later).chm file (for HTML Help) or the name of the main .

Windows Vista SP1 or later. set. set. Resolver.} Remarks The current C1DynamicHelp control will use the MainControl's properties: HelpSource.} Requirements Target Platforms: Windows 7. etc instead of its own properties. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). Provider. It is used to place C1DynamicHelp controls on multiple forms that will display topics from one help source. Syntax Visual Basic (Declaration) Public Property MainControl As C1DynamicHelp C# public C1DynamicHelp MainControl {get. Windows XP SP3. and all you need to do for the other C1DynamicHelp controls is to set their MainControl property to the main C1DynamicHelp control. Requirements 71 .Syntax Visual Basic (Declaration) Public Property IsPinnedDown As Boolean C# public bool IsPinnedDown {get. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members MainControl Property Gets or sets a reference to another C1DynamicHelp control which will be used as a source of data for the current C1DynamicHelp control. In this case you will have one main C1DynamicHelp control and set properties for it.

between the time the mouse enters a control or component and the time the associated HelpTopic is displayed in the C1DynamicHelp control. Syntax Visual Basic (Declaration) Public Property MouseHoverDelay As Integer C# public int MouseHoverDelay {get.} 72 . Windows Server 2008 (Server Core not supported). Syntax Visual Basic (Declaration) Public Property Provider As IHelpProvider C# public IHelpProvider Provider {get.} Requirements Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Vista SP1 or later.Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later). set. in milliseconds. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members Provider Property Gets or sets a reference to a help provider. Windows XP SP3. set. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members MouseHoverDelay Property Gets or sets the interval. Windows XP SP3. Windows Server 2008 (Server Core not supported). Windows Vista SP1 or later.

It should provide a way to get the Name and Parent for 73 . to open help in an external window.Exceptions Exception Description System. Windows XP SP3.} Remarks This property must be set only if custom/third-party controls are used in the application and it is necessary to associate help with parts of such controls (called UI elements. Windows Server 2008 R2 (Server Core supported with SP1 or later). There are two built-in help providers in C1DynamicHelp: ChmProvider and NetHelpProvider which are used automatically when the HelpSource property points to a .ArgumentNullException Provider cannot be null. Remarks You should set this property only if you implement your own help provider class (an advanced feature). etc. Windows Vista SP1 or later.htm file correspondingly. buttons on a custom ribbon control).chm or . to get a dictionary of context ids and help topics. for example. Syntax Visual Basic (Declaration) Public Property Resolver As UIElementResolver C# public UIElementResolver Resolver {get. to get a topic URL that can be displayed in a C1DynamicHelp control. A help provider can read data from a help source and provides methods to get a help topic list.html/. Requirements Target Platforms: Windows 7. set. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members Resolver Property Represents a class with virtual methods that are used to supply information about custom controls used in the application. Windows Server 2008 (Server Core not supported).

This property enables you to obtain a reference to the topic map items that are currently stored in the C1DynamicHelp. Windows Vista SP1 or later. Windows XP SP3. get a UI element inside the control by name. or at run-time (using the controls authoring mode) and persisted as an XML file (called dynamic mappings). mouse hovering). Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members TopicMap Property A dictionary that maps UI elements to MapItem objects. The TopicMap class has members that allow users to check whether the map has changed since it was created and to persist the map to and from XML. you can add items. get a UI element inside the control by coordinates. and obtain a count of the items in the collection. Windows Server 2008 (Server Core not supported). remove items. This dictionary can be created at design time and persisted as part of the form (called static mappings). Windows XP SP3. Windows Vista SP1 or later.every UI element.} Remarks A MapItem object specifies a help topic to display and a user action that causes the display (control getting focus. Requirements Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). With this reference. etc. Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Public ReadOnly Property TopicMap As TopicMap C# public TopicMap TopicMap {get. Windows Server 2003 SP2 See Also Reference 74 . Requirements Target Platforms: Windows 7.

Forms.Control) HandleDestroyed (Inherited from System.Control) 75 .Windows.Forms.Windows.Windows.Forms.Windows.Windows.Forms.Windows.Control) HandleCreated (Inherited from System.Forms.Forms.Windows.Forms.Windows.ComponentModel. Public Events Name Description CausesValidationChanged (Inherited from System.Control) ContextMenuChanged (Inherited from System.Control) ClientSizeChanged (Inherited from System.Forms. CurrentTopicChanging Fires before the value of the CurrentTopic changes.Windows.Control) ControlAdded (Inherited from System.Forms.Windows.Control) GotFocus (Inherited from System.C1DynamicHelp Class C1DynamicHelp Members Events %%scrap%% " --> For a list of all members of this type.Control) Invalidated (Inherited from System.Control) CurrentTopicChanged Fires after the value of the CurrentTopic has changed.Control) ControlRemoved (Inherited from System. Disposed (Inherited from System.Windows.Component) DockChanged (Inherited from System.Control) ContextMenuStripChanged (Inherited from System.Forms. see C1DynamicHelp members.Forms.

Forms.LocationChanged (Inherited from System.Windows.Forms.Control) Validated (Inherited from System. 76 .Windows.Control) TabIndexChanged (Inherited from System.Forms.Windows.Forms.Windows.Control) Resize (Inherited from System.Windows.Control) ParentChanged (Inherited from System.Control) Top See Also Reference C1DynamicHelp Class C1.Forms.Forms.Control) RegionChanged (Inherited from System.Win.Control) LostFocus (Inherited from System.Windows.Control) TabStopChanged (Inherited from System.Control) VisibleChanged (Inherited from System.Forms.Control) SystemColorsChanged (Inherited from System.Windows.Forms.Forms.Control) MarginChanged (Inherited from System.Forms.Windows.C1DynamicHelp Namespace CurrentTopicChanged Event Fires after the value of the CurrentTopic has changed.Windows.Control) Validating (Inherited from System.Forms.Forms.Forms.Windows.Control) Move (Inherited from System.Windows.Windows.Windows.Control) PreviewKeyDown (Inherited from System.Control) SizeChanged (Inherited from System.Windows.Windows.Forms.Forms.

Windows XP SP3. Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members CurrentTopicChanging Event Fires before the value of the CurrentTopic changes. Windows Server 2008 R2 (Server Core supported with SP1 or later). Property Description Cancel Gets or sets a value indicating whether the event should be canceled. Syntax Visual Basic (Declaration) Public Event CurrentTopicChanging As HelpTopicEventHandler C# public event HelpTopicEventHandler CurrentTopicChanging Event Data The event handler receives an argument of type TopicEventArgs containing data related to this event. Topic Gets a value indicating the help topic becoming current. The following TopicEventArgs properties provide information specific to this event. Windows Server 2008 (Server Core not supported). Requirements 77 .Syntax Visual Basic (Declaration) Public Event CurrentTopicChanged As EventHandler C# public event EventHandler CurrentTopicChanged Requirements Target Platforms: Windows 7. Windows Vista SP1 or later.

Windows Server 2003 SP2 See Also Reference Conflict Members C1. Windows XP SP3.Object C1.Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later).Win. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 See Also Reference C1DynamicHelp Class C1DynamicHelp Members Conflict Class used in the TopicMap. the other dynamic. Windows Vista SP1 or later. Windows XP SP3.Conflict Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows Server 2008 (Server Core not supported). Object Model Syntax Visual Basic (Declaration) Public Class Conflict C# public class Conflict Remarks This class contains data describing a conflict between two map items.C1DynamicHelp. Inheritance Hierarchy System. one static. A conflict exists between two map items if they refer to the same UI element. Windows Vista SP1 or later.C1DynamicHelp Namespace 78 .Conflicts property of the TopicMap.Win.

Win. Windows Vista SP1 or later. one static. Public Properties Name Description 79 .C1DynamicHelp Namespace Members Properties The following tables list the members exposed by Conflict. Object Model Syntax Visual Basic (Declaration) Public Class Conflict C# public class Conflict Remarks This class contains data describing a conflict between two map items.Object C1. Windows Server 2008 R2 (Server Core supported with SP1 or later).Conflict Requirements Target Platforms: Windows 7. Windows XP SP3. Windows Server 2003 SP2 See Also Reference Conflict Members C1. the other dynamic.Win.Conflicts property of the TopicMap. Windows Server 2008 (Server Core not supported).C1DynamicHelp. A conflict exists between two map items if they refer to the same UI element. Inheritance Hierarchy System.Overview Class used in the TopicMap.

Win. Top See Also Reference Conflict Class C1. StaticItem Returns the static map item. Public Properties Name Description DynamicItem Returns the dynamic map item. Top See Also Reference 80 . see Conflict members. StaticItem Returns the static map item. UIElementPath Returns the UI element's path string (serving as the identifier of the dynamic map item).DynamicItem Returns the dynamic map item. Name Returns the name of the UI element (serving as the identifier of the static map item).C1DynamicHelp Namespace Properties %%scrap%% " --> For a list of all members of this type. UIElementPath Returns the UI element's path string (serving as the identifier of the dynamic map item). Name Returns the name of the UI element (serving as the identifier of the static map item).

Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported).} Requirements Target Platforms: Windows 7. Windows Server 2003 SP2 See Also 81 .Win. Windows Server 2008 (Server Core not supported). Windows XP SP3. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. Syntax Visual Basic (Declaration) Public Property DynamicItem As MapItem C# public MapItem DynamicItem {get. Windows Server 2003 SP2 See Also Reference Conflict Class Conflict Members Name Property Returns the name of the UI element (serving as the identifier of the static map item).} Requirements Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later).C1DynamicHelp Namespace DynamicItem Property Returns the dynamic map item. Syntax Visual Basic (Declaration) Public Property Name As String C# public string Name {get. set.Conflict Class C1. set.

Syntax Visual Basic (Declaration) Public Property StaticItem As MapItem C# public MapItem StaticItem {get. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 See Also Reference Conflict Class Conflict Members UIElementPath Property Returns the UI element's path string (serving as the identifier of the dynamic map item). set. Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 82 . Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later).} Requirements Target Platforms: Windows 7. Windows XP SP3. Windows XP SP3. Windows Server 2008 (Server Core not supported). Windows Vista SP1 or later.} Requirements Target Platforms: Windows 7. set. Syntax Visual Basic (Declaration) Public Property UIElementPath As String C# public string UIElementPath {get.Reference Conflict Class Conflict Members StaticItem Property Returns the static map item.

Windows Server 2008 R2 (Server Core supported with SP1 or later). 83 .Win.C1DynamicHelp. Inheritance Hierarchy System.Win.Object C1. Object Model Syntax Visual Basic (Declaration) Public Class HelpTopic C# public class HelpTopic Remarks You need to explicitly create HelpTopic objects in your code only if you implement your own help provider.HelpTopic Requirements Target Platforms: Windows 7. Windows Vista SP1 or later.See Also Reference Conflict Class Conflict Members HelpTopic Represents a topic in a help file.C1DynamicHelp Namespace Overview Represents a topic in a help file. Windows XP SP3. Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference HelpTopic Members C1.

C1DynamicHelp Namespace Members Properties Methods The following tables list the members exposed by HelpTopic.Win. Public Constructors Name Description HelpTopic Constructor Overloaded. Inheritance Hierarchy System. Top 84 .Object Model Syntax Visual Basic (Declaration) Public Class HelpTopic C# public class HelpTopic Remarks You need to explicitly create HelpTopic objects in your code only if you implement your own help provider. Windows XP SP3.Win.HelpTopic Requirements Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later).Object C1.C1DynamicHelp. Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference HelpTopic Members C1.

ToString Gets a string representation of this HelpTopic. Url Gets the topic URL relative to the help source.C1DynamicHelp Namespace HelpTopic Constructor Overload List Overload Description HelpTopic Constructor(String.String.String) Creates a new instance of HelpTopic.Win. SubTopics Gets the list of child topics.HelpTopicList) Creates a new instance of HelpTopic.Public Properties Name Description ContextID Gets the unique numeric ID of the topic within the help system used for context sensitive help purposes. HelpTopic Constructor(String. Top Public Methods Name Description SetCtxtId Set context ID for this HelpTopic. Requirements 85 . Top See Also Reference HelpTopic Class C1. Title Gets the name of the help topic.

Windows Server 2008 R2 (Server Core supported with SP1 or later). Creates a new instance of HelpTopic. Windows Server 2003 SP2 See Also Reference HelpTopic Class HelpTopic Members HelpTopic Constructor(String. HelpTopicList subtopics ) Parameters title A title for the help topic being created. url A URL for the help topic being created. Windows XP SP3. subtopics Child topics for the topic being created. Windows Vista SP1 or later.Target Platforms: Windows 7. _ ByVal url As String.HelpTopicList) A title for the help topic being created. 86 . Child topics for the topic being created. _ ByVal subtopics As HelpTopicList _ ) C# public HelpTopic( string title.String. Syntax Visual Basic (Declaration) Public Function New( _ ByVal title As String. string url. Windows Server 2008 (Server Core not supported). A URL for the help topic being created.

Windows Vista SP1 or later. Windows XP SP3. Windows Server 2008 (Server Core not supported). Creates a new instance of HelpTopic. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also Reference HelpTopic Class HelpTopic Members Overload List HelpTopic Constructor(String. Windows Server 2008 R2 (Server Core supported with SP1 or later).Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Public Function New( _ ByVal title As String. Windows Server 2003 SP2 87 . url A URL for the help topic being created. Windows XP SP3. _ ByVal url As String _ ) C# public HelpTopic( string title. Requirements Target Platforms: Windows 7. string url ) Parameters title A title for the help topic being created.String) A title for the help topic being created. A URL for the help topic being created.

Win. Public Methods Name Description SetCtxtId Set context ID for this HelpTopic. Top See Also Reference HelpTopic Class C1.See Also Reference HelpTopic Class HelpTopic Members Overload List Methods %%scrap%% " --> For a list of all members of this type. Set context ID for this HelpTopic. see HelpTopic members. Syntax Visual Basic (Declaration) Public Sub SetCtxtId( _ ByVal ctxtId As Integer _ ) C# public void SetCtxtId( int ctxtId 88 . ToString Gets a string representation of this HelpTopic.C1DynamicHelp Namespace SetCtxtId Method Context ID for thisHelpTopic.

Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported).) Parameters ctxtId Context ID for thisHelpTopic. Windows XP SP3. Windows Server 2003 SP2 See Also Reference HelpTopic Class HelpTopic Members 89 . Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). Windows Vista SP1 or later. Remarks This method should be used only for creating you own help provider class. Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. Windows XP SP3. Windows Server 2003 SP2 See Also Reference HelpTopic Class HelpTopic Members ToString Method Gets a string representation of this HelpTopic. Syntax Visual Basic (Declaration) Public Overrides Function ToString() As String C# public override string ToString() Requirements Target Platforms: Windows 7.

see HelpTopic members. Title Gets the name of the help topic.Win. SubTopics Gets the list of child topics. Syntax Visual Basic (Declaration) Public ReadOnly Property ContextID As Integer C# public int ContextID {get.C1DynamicHelp Namespace ContextID Property Gets the unique numeric ID of the topic within the help system used for context sensitive help purposes. Url Gets the topic URL relative to the help source. Windows XP SP3.Properties %%scrap%% " --> For a list of all members of this type. Windows Vista SP1 or later.} Requirements Target Platforms: Windows 7. Top See Also Reference HelpTopic Class C1. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 90 . Public Properties Name Description ContextID Gets the unique numeric ID of the topic within the help system used for context sensitive help purposes. Windows Server 2008 (Server Core not supported).

See Also Reference HelpTopic Class HelpTopic Members SubTopics Property Gets the list of child topics.} Requirements Target Platforms: Windows 7. Windows Server 2003 SP2 See Also Reference HelpTopic Class HelpTopic Members Title Property Gets the name of the help topic. Syntax Visual Basic (Declaration) Public ReadOnly Property SubTopics As HelpTopicList C# public HelpTopicList SubTopics {get.} Requirements 91 . Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Public ReadOnly Property Title As String C# public string Title {get. Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported). Windows XP SP3.

Windows Server 2008 R2 (Server Core supported with SP1 or later). Object Model Syntax 92 . Windows Server 2008 R2 (Server Core supported with SP1 or later). Full URL can be obtained from the IHelpProvider. Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows Vista SP1 or later.GetFullUrl method.} Remarks Since this is the relative URL. Windows XP SP3. Syntax Visual Basic (Declaration) Public ReadOnly Property Url As String C# public string Url {get. Windows Server 2003 SP2 See Also Reference HelpTopic Class HelpTopic Members HelpTopicList List of HelpTopic objects. Windows Vista SP1 or later. Windows XP SP3. Windows Server 2008 (Server Core not supported). the help viewer/browser may be unable to display topics given only that URL. Windows Server 2003 SP2 See Also Reference HelpTopic Class HelpTopic Members Url Property Gets the topic URL relative to the help source.Target Platforms: Windows 7.

Object Model Syntax Visual Basic (Declaration) Public Class HelpTopicList Inherits System.C1DynamicHelp Namespace Overview List of HelpTopic objects. Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported).Collections.Object System.Win. Windows XP SP3.List<T> C1.List(Of HelpTopic) C# public class HelpTopicList : System.List<HelpTopic> Inheritance Hierarchy 93 .Generic.List<HelpTopic> Inheritance Hierarchy System.List(Of HelpTopic) C# public class HelpTopicList : System.Collections.Win.Generic. Windows Server 2003 SP2 See Also Reference HelpTopicList Members C1.Visual Basic (Declaration) Public Class HelpTopicList Inherits System.Generic.C1DynamicHelp.Collections.Generic.Collections.Generic. Windows Server 2008 R2 (Server Core supported with SP1 or later).Collections.HelpTopicList Requirements Target Platforms: Windows 7.

Generic.Generic.Collections.List<T> C1.List<HelpTopic>) 94 . Windows Server 2008 R2 (Server Core supported with SP1 or later).Collections.Object System.HelpTopicList Requirements Target Platforms: Windows 7.List<HelpTopic>) Item (Inherited from System.List<HelpTopic>) Count (Inherited from System.List<HelpTopic>) Top Public Methods Name Description Add (Inherited from System. Public Constructors Name Description HelpTopicList Constructor Top Public Properties Name Description Capacity (Inherited from System.Collections.Win.Collections.Win. Windows Vista SP1 or later.C1DynamicHelp.Collections.Generic.System.Generic. Windows XP SP3. Windows Server 2003 SP2 See Also Reference HelpTopicList Members C1.Generic. Windows Server 2008 (Server Core not supported).C1DynamicHelp Namespace Members Properties Methods The following tables list the members exposed by HelpTopicList.

Collections.List<HelpTopic>) Clear (Inherited from System. (Inherited from System.List<HelpTopic>) 95 .Generic.Collections.List<HelpTopic>) BinarySearch Overloaded.Collections. (Inherited from System.Generic.Collections.Collections.Collections.List<HelpTopic>) Exists (Inherited from System.Generic.Collections.AddRange (Inherited from System.List<HelpTopic>) FindLast (Inherited from System.Collections.Generic.Collections.Collections.List<HelpTopic>) GetEnumerator (Inherited from System.Collections.Collections.Generic.Generic.Generic.Collections.Generic.Collections.Collections.Generic.List<HelpTopic>) AsReadOnly (Inherited from System.List<HelpTopic>) ForEach (Inherited from System.Generic. (Inherited from System.Collections.Generic.List<HelpTopic>) ConvertAll (Inherited from System.List<HelpTopic>) Insert (Inherited from System.List<HelpTopic>) FindIndex Overloaded.List<HelpTopic>) Find (Inherited from System.List<HelpTopic>) FindLastIndex Overloaded.List<HelpTopic>) InsertRange (Inherited from System. (Inherited from System.Generic.Generic.Generic.List<HelpTopic>) Contains (Inherited from System.Collections.Generic.List<HelpTopic>) IndexOf Overloaded.Generic.Generic.List<HelpTopic>) FindAll (Inherited from System. (Inherited from System.Generic.Generic.List<HelpTopic>) CopyTo Overloaded.Collections.List<HelpTopic>) GetRange (Inherited from System.Collections.

LastIndexOf Overloaded.List<HelpTopic>) Reverse Overloaded.List<HelpTopic>) RemoveRange (Inherited from System.Collections.Collections.Generic. (Inherited from System.Generic.Generic.Collections.List<HelpTopic>) ToArray (Inherited from System.List<HelpTopic>) TrimExcess (Inherited from System.Generic.List<HelpTopic>) Remove (Inherited from System.Win.Collections.List<HelpTopic>) TrueForAll (Inherited from System.Collections.List<HelpTopic>) RemoveAt (Inherited from System.List<HelpTopic>) RemoveAll (Inherited from System.Generic.Collections.Generic.List<HelpTopic>) Sort Overloaded.Generic.Collections.Generic. (Inherited from System.Generic.List<HelpTopic>) Top See Also Reference HelpTopicList Class C1.Generic.Collections.Collections. (Inherited from System.C1DynamicHelp Namespace HelpTopicList Constructor Syntax Visual Basic (Declaration) Public Function New() C# public HelpTopicList() Requirements 96 .Collections.

Windows XP SP3.C1DynamicHelp. Map items created at design time have their ItemType property set to MapItemType. you can set this property to any of the two values. Windows XP SP3. If you create a map item programmatically.Static.Object C1.Dynamic. Windows Server 2008 (Server Core not supported). Inheritance Hierarchy System. Windows Server 2008 R2 (Server Core supported with SP1 or later). You can also create them at run time programmatically. whereas map items created in authoring mode have their ItemType property set to MapItemType. Object Model Syntax Visual Basic (Declaration) Public Class MapItem C# public class MapItem Remarks Objects of this class are stored in the TopicMap dictionary. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later).Target Platforms: Windows 7. Windows Vista SP1 or later. Map items are created automatically at design time and in authoring mode.MapItem Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also 97 . Windows Server 2003 SP2 See Also Reference HelpTopicList Class HelpTopicList Members MapItem Class containing a pair consisting of a topic and a user action triggering its display.Win.

Windows XP SP3.Dynamic. Windows Server 2003 SP2 See Also Reference MapItem Members C1.Static.Win.Win. Inheritance Hierarchy System. Windows Server 2008 R2 (Server Core supported with SP1 or later). Object Model Syntax Visual Basic (Declaration) Public Class MapItem C# public class MapItem Remarks Objects of this class are stored in the TopicMap dictionary. If you create a map item programmatically. Map items created at design time have their ItemType property set to MapItemType.C1DynamicHelp Namespace 98 .Object C1. You can also create them at run time programmatically. Map items are created automatically at design time and in authoring mode. Windows Vista SP1 or later. whereas map items created in authoring mode have their ItemType property set to MapItemType.MapItem Requirements Target Platforms: Windows 7.C1DynamicHelp Namespace Overview Class containing a pair consisting of a topic and a user action triggering its display.Win. Windows Server 2008 (Server Core not supported). you can set this property to any of the two values.C1DynamicHelp.Reference MapItem Members C1.

which is the topic URL.C1DynamicHelp Namespace 99 . even if a UI element inside the form got focus and has a topic associated with it. UseDefaultTrigger Top Public Methods Name ToString Description Returns a string representation of a MapItem. Gets or sets a value indicating whether the default topic (the topic associated with the form) should be always displayed when the form ShowDefaultTopicFirst is loaded and becomes visible.Win.DefaultTrigger value of the C1DynamicHelp control. HelpTopicTrigger Specifies what triggers the topic display.Members " --> Public Constructors Name Description MapItem Constructor Initializes a new of instance of a MapItem Top Public Properties Name Description HelpTopic Gets the HelpTopic object by the Url value. Top See Also Reference MapItem Class C1. UIElement Gets or sets a UI element for which a help topic is displayed. Gets or sets a value indicating whether a topic will be displayed depending on its own HelpTopicTrigger value or on the C1DynamicHelp. Url Gets or sets the URL of a help topic that will be displayed. ItemType Gets or sets an item type.

Windows XP SP3. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 See Also Reference MapItem Class MapItem Members Methods > Name ToString Description Returns a string representation of a MapItem. which is the topic URL. which is the topic URL.MapItem Constructor Initializes a new of instance of a MapItem Syntax Visual Basic (Declaration) Public Function New() C# public MapItem() Requirements Target Platforms: Windows 7. Top See Also Reference MapItem Class C1.Win.C1DynamicHelp Namespace ToString Method Returns a string representation of a MapItem. Windows Server 2008 (Server Core not supported). Syntax Visual Basic (Declaration) Public Overrides Function ToString() As String 100 . Windows Vista SP1 or later.

Windows Server 2003 SP2 See Also Reference MapItem Class MapItem Members Properties %%scrap%% " --> For a list of all members of this type. ItemType Gets or sets an item type. UIElement Gets or sets a UI element for which a help topic is displayed. even if a UI element inside the form got focus and has a topic associated with it. Windows Server 2008 R2 (Server Core supported with SP1 or later). Public Properties Name Description HelpTopic Gets the HelpTopic object by the Url value. 101 .C# public override string ToString() Return Value A System. Windows Vista SP1 or later. ShowDefaultTopicFirst Gets or sets a value indicating whether the default topic (the topic associated with the form) should be always displayed when the form is loaded and becomes visible. Url Gets or sets the URL of a help topic that will be displayed. HelpTopicTrigger Specifies what triggers the topic display. Windows Server 2008 (Server Core not supported). see MapItem members. Requirements Target Platforms: Windows 7. Windows XP SP3.String that represents the current MapItem.

Syntax Visual Basic (Declaration) Public ReadOnly Property HelpTopic As HelpTopic C# public HelpTopic HelpTopic {get.UseDefaultTrigger Gets or sets a value indicating whether a topic will be displayed depending on its own HelpTopicTrigger value or on the C1DynamicHelp. Windows XP SP3.DefaultTrigger value of the C1DynamicHelp control. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later).Win. Syntax Visual Basic (Declaration) Public Property HelpTopicTrigger As HelpTopicTrigger 102 . Top See Also Reference MapItem Class C1. Windows Server 2003 SP2 See Also Reference MapItem Class MapItem Members HelpTopicTrigger Property Specifies what triggers the topic display. Windows Server 2008 (Server Core not supported).} Requirements Target Platforms: Windows 7.C1DynamicHelp Namespace HelpTopic Property Gets the HelpTopic object by the Url value.

Windows Server 2003 SP2 See Also Reference MapItem Class MapItem Members ItemType Property Gets or sets an item type. If UseDefaultTrigger is set to true. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later).C# public HelpTopicTrigger HelpTopicTrigger {get.} Remarks This property is used only if the UseDefaultTrigger property is set to false. Windows XP SP3.Dynamic are created in authoring mode and saved to an XML file.} Remarks Items with MapItemType. Requirements Target Platforms: Windows 7. Windows XP SP3. Windows Vista SP1 or later. set. Items of both types can be created programmatically at run time. Items with MapItemType. Windows Server 2003 SP2 See Also 103 . Syntax Visual Basic (Declaration) Public Property ItemType As MapItemType C# public MapItemType ItemType {get. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later). set.Static are created at design time and persisted as part of the form.DefaultTrigger property is used instead. this property is ignored and C1DynamicHelp. Windows Server 2008 (Server Core not supported). Requirements Target Platforms: Windows 7.

Reference
MapItem Class
MapItem Members

ShowDefaultTopicFirst Property
Gets or sets a value indicating whether the default topic (the topic associated with the form)
should be always displayed when the form is loaded and becomes visible, even if a UI element
inside the form got focus and has a topic associated with it.

Syntax
Visual Basic (Declaration)
Public Property ShowDefaultTopicFirst As Boolean
C#
public bool ShowDefaultTopicFirst {get; set;}

Remarks
This property is used only for top level controls (Form objects), it is ignored for other UI
elements.

Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server
2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or
later), Windows Server 2003 SP2

See Also
Reference
MapItem Class
MapItem Members

UIElement Property
Gets or sets a UI element for which a help topic is displayed.

Syntax
Visual Basic (Declaration)
Public Property UIElement As Object
C#
public object UIElement {get; set;}

104

Remarks
This property should be set only once and shouldn't be changed after that.

Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server
2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or
later), Windows Server 2003 SP2

See Also
Reference
MapItem Class
MapItem Members

Url Property
Gets or sets the URL of a help topic that will be displayed.

Syntax
Visual Basic (Declaration)
Public Property Url As String
C#
public string Url {get; set;}

Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server
2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or
later), Windows Server 2003 SP2

See Also
Reference
MapItem Class
MapItem Members

UseDefaultTrigger Property
Gets or sets a value indicating whether a topic will be displayed depending on its own
HelpTopicTrigger value or on the C1DynamicHelp.DefaultTrigger value of the C1DynamicHelp
control.

Syntax

105

Visual Basic (Declaration)
Public Property UseDefaultTrigger As Boolean
C#
public bool UseDefaultTrigger {get; set;}

Remarks
If this property is set to false, the HelpTopicTrigger property is used to determine when the
topic should be shown. Otherwise, the C1DynamicHelp.DefaultTrigger value determines when
the topic will be displayed.

Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server
2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or
later), Windows Server 2003 SP2

See Also
Reference
MapItem Class
MapItem Members

TopicEventArgs
Provides data for a topic change event.

Object Model

Syntax
Visual Basic (Declaration)
Public Class TopicEventArgs
Inherits System.ComponentModel.CancelEventArgs
C#
public class TopicEventArgs : System.ComponentModel.CancelEventArgs

Inheritance Hierarchy
System.Object
System.EventArgs

106

System.ComponentModel.CancelEventArgs
C1.Win.C1DynamicHelp.TopicEventArgs

Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server
2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or
later), Windows Server 2003 SP2

See Also
Reference
TopicEventArgs Members
C1.Win.C1DynamicHelp Namespace

Overview
Provides data for a topic change event.

Object Model

Syntax
Visual Basic (Declaration)
Public Class TopicEventArgs
Inherits System.ComponentModel.CancelEventArgs
C#
public class TopicEventArgs : System.ComponentModel.CancelEventArgs

Inheritance Hierarchy
System.Object
System.EventArgs
System.ComponentModel.CancelEventArgs
C1.Win.C1DynamicHelp.TopicEventArgs

Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server
2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or
later), Windows Server 2003 SP2

See Also
Reference

107

Win.Win.Win.TopicEventArgs Members C1.C1DynamicHelp Namespace Members Properties The following tables list the members exposed by TopicEventArgs.C1DynamicHelp Namespace Properties > Name Description Cancel Gets or sets a value indicating whether the event should be canceled. Public Properties Name Description Cancel Gets or sets a value indicating whether the event should be canceled.C1DynamicHelp Namespace Cancel Property Gets or sets a value indicating whether the event should be canceled. Top See Also Reference TopicEventArgs Class C1. Top See Also Reference TopicEventArgs Class C1. Topic Gets a value indicating the help topic becoming current. Syntax Visual Basic (Declaration) 108 . Topic Gets a value indicating the help topic becoming current.

Public Shadows Property Cancel As Boolean C# public new bool Cancel {get. Windows Server 2003 SP2 See Also Reference TopicEventArgs Class TopicEventArgs Members Topic Property Gets a value indicating the help topic becoming current. Windows Server 2008 (Server Core not supported). Windows XP SP3. Windows XP SP3. Windows Server 2003 SP2 See Also Reference TopicEventArgs Class TopicEventArgs Members TopicMap Class used to store combinations of topics and user actions that cause their display.} Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Vista SP1 or later. Object Model 109 . set.} Requirements Target Platforms: Windows 7. Syntax Visual Basic (Declaration) Public ReadOnly Property Topic As HelpTopic C# public HelpTopic Topic {get.

Map items with dynamic type are created in authoring mode. and only items of this type can be saved to an XML file with the Save method and then loaded with the Load method. The TopicMap class has members that allow users to check whether the map has changed since it was created and to persist the map to and from XML. static map items are created at design time and aren't saved to or loaded from XML file. As the controls on the form can be created dynamically.C1DynamicHelp. Windows Server 2008 R2 (Server Core supported with SP1 or later). mouse hovering). As opposed to dynamic map items. it can be done on timer).MapItem) C# public class TopicMap : System.Syntax Visual Basic (Declaration) Public Class TopicMap Inherits System. So. if you include controls that are created dynamically. Dynamic map items use a "control path" string (the name of the UI element itself prepended with the names of all its ancestors up to the form level) as the UI element identifier. Windows Vista SP1 or later. at run time.Dictionary(Of Object.Collections.Generic.Dynamic and MapItemType.Dictionary<object. and obtain a count of the items in the collection. you may need to call the Refresh method more than once (or.Collections. Windows XP SP3.MapItem> Remarks This class is a dictionary that associates UI elements to MapItem objects that specify a help topic to display and the user action that causes the display (control getting focus. This class allows you to add items.Win. Windows Server 2008 (Server Core not supported). remove items.Object System.TopicMap Requirements Target Platforms: Windows 7.Collections. for example. you need to call the Refresh method that finds UI elements by their "control path" and adds them to the dynamic help system.Generic. Inheritance Hierarchy System.Dictionary<TKey. It can contain items of two different types: MapItemType. Windows Server 2003 SP2 See Also 110 .Generic.Static.TValue> C1.

Static.Generic. remove items.Dynamic and MapItemType.Reference TopicMap Members C1. So.MapItem> Remarks This class is a dictionary that associates UI elements to MapItem objects that specify a help topic to display and the user action that causes the display (control getting focus. Map items with dynamic type are created in authoring mode. you need to call the Refresh method that finds UI elements by their "control path" and adds them to the dynamic help system. Inheritance Hierarchy 111 . static map items are created at design time and aren't saved to or loaded from XML file.Collections. This class allows you to add items. mouse hovering). As opposed to dynamic map items. The TopicMap class has members that allow users to check whether the map has changed since it was created and to persist the map to and from XML. you may need to call the Refresh method more than once (or. and only items of this type can be saved to an XML file with the Save method and then loaded with the Load method.Dictionary(Of Object.Collections.Generic. for example.Win.Dictionary<object. at run time. and obtain a count of the items in the collection. it can be done on timer). if you include controls that are created dynamically.MapItem) C# public class TopicMap : System.C1DynamicHelp Namespace Overview Class used to store combinations of topics and user actions that cause their display. As the controls on the form can be created dynamically. Object Model Syntax Visual Basic (Declaration) Public Class TopicMap Inherits System. It can contain items of two different types: MapItemType. Dynamic map items use a "control path" string (the name of the UI element itself prepended with the names of all its ancestors up to the form level) as the UI element identifier.

Dictionary<object.Win.Generic. Keys (Inherited from System.Dictionary<object.Collections. Windows Vista SP1 or later.TValue> C1.System.Xml.Generic. Windows XP SP3.C1DynamicHelp Namespace Members Properties Methods Events The following tables list the members exposed by TopicMap.Win.Generic.MapItem>) Conflicts Gets an array of conflicting map items. Count (Inherited from System.Generic.Collections. static map items aren't included).Collections.Dictionary<object.MapItem>) Values (Inherited from System. 112 .Collections.Object System. Item Gets or sets the value associated with the specified key. Windows Server 2003 SP2 See Also Reference TopicMap Members C1.C1DynamicHelp.XmlDocument value representing a TopicMap created in authoring mode (so it consists of dynamic map items.Collections.MapItem>) HasChanges Gets a value that determines whether the TopicMap has changed since it was initialized (read from an XML file).TopicMap Requirements Target Platforms: Windows 7.MapItem>) XmlSource Gets or sets an System. which is saved to an XML file. Windows Server 2008 R2 (Server Core supported with SP1 or later).Dictionary<object. Windows Server 2008 (Server Core not supported).Generic.Dictionary<TKey. Public Properties Name Description Comparer (Inherited from System.

Dictionary<object. OnDeserialization (Inherited from System.xml extension.Collections. For every control path in the map that does not yet have a UI element found for it. 113 .MapItem>) GetEnumerator (Inherited from System.Dictionary<object.MapItem>) GetObjectData (Inherited from System.Collections.Collections.Generic.Generic. Adds the specified uiElement and value to the TopicMap.Collections. Remove Overloaded.Dynamic. Saves the TopicMap contents to an XML file with the same name as the HelpSource with .Generic. Clear (Inherited from System.MapItem>) Refresh Refreshes topic map items with the ItemType property set to MapItemType.Generic.Dictionary<object.MapItem>) Contains Determines whether the TopicMap contains the specified key.Top Public Methods Name Description Add Overloaded.Collections.Generic.Dictionary<object. Loads the TopicMap contents from an XML file.Dictionary<object.Generic.MapItem>) Load Overloaded.MapItem>) ContainsValue (Inherited from System. it tries to find a UI element.Dictionary<object.Collections. Removes the value with the specified uiElement from the TopicMap Save Overloaded. ContainsKey (Inherited from System.

Collections.Collections.C1DynamicHelp Namespace Methods %%scrap%% " --> For a list of all members of this type.Generic.Collections.Generic.Dictionary<object.MapItem>) Contains Determines whether the TopicMap contains the specified key.Dictionary<object.MapItem>) Top Public Events Name Description TopicMapChanged Fires after changes were made in the topic map.TryGetValue (Inherited from System. Adds the specified uiElement and value to the TopicMap. ContainsKey (Inherited from System.Generic. TopicMapSaved Fires after the topic map is saved to an XML file. Top See Also Reference TopicMap Class C1. see TopicMap members. Clear (Inherited from System.Dictionary<object.Win.MapItem>) ContainsValue (Inherited from 114 . Public Methods Name Description Add Overloaded.

MapItem>) GetEnumerator (Inherited from System. Loads the TopicMap contents from an XML file.Generic. Removes the value with the specified uiElement from the TopicMap Save Overloaded.C1DynamicHelp Namespace Add Method Adds the specified uiElement and value to the TopicMap. Overload List Overload Description 115 . Saves the TopicMap contents to an XML file with the same name as the HelpSource with . Remove Overloaded. it tries to find a UI element.Dictionary<object.Win.Collections.Dictionary<object.MapItem>) Load Overloaded.Generic. OnDeserialization (Inherited from System.Dictionary<object.MapItem>) Top See Also Reference TopicMap Class C1.Dictionary<object.System.xml extension. TryGetValue (Inherited from System.Generic.Collections.MapItem>) Refresh Refreshes topic map items with the ItemType property set to MapItemType.Dictionary<object.Collections.Collections.Collections.Dynamic.Generic.MapItem>) GetObjectData (Inherited from System.Generic. For every control path in the map that does not yet have a UI element found for it.

MapItem) Adds the specified path and value to the TopicMap. 116 . Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Public Overloads Shadows Sub Add( _ ByVal uiElement As Object.MapItem) Adds the specified uiElement and value to the TopicMap. Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Add(Object.MapItem) Method The key of the element to add. The value of the element to add. Windows XP SP3. Adds the specified uiElement and value to the TopicMap. Windows Vista SP1 or later. _ ByVal info As MapItem _ ) C# public new void Add( object uiElement.Add(Object. Add(String. MapItem info ) Parameters uiElement The key of the element to add. info The value of the element to add.

Adds the specified path and value to the TopicMap. MapItem info ) Parameters path 117 .MapItem) Method The key of the element to add. Syntax Visual Basic (Declaration) Public Overloads Sub Add( _ ByVal path As String. Requirements Target Platforms: Windows 7.Exceptions Exception Description System. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later). The value of the element to add.ArgumentNullException uiElement or info is null System. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Overload List Add(String.ArgumentException An element with the same uiElement already exists in the TopicMap. Windows XP SP3. _ ByVal info As MapItem _ ) C# public void Add( string path.

info The value of the element to add. Syntax Visual Basic (Declaration) Public Function Contains( _ ByVal path As String _ ) As Boolean C# public bool Contains( string path ) Parameters path 118 . Windows XP SP3. Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Overload List Contains Method The key to locate in the TopicMap. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later).ArgumentException An element with the same path already exists in the TopicMap. Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported).ArgumentNullException path or info is null System. Exceptions Exception Description System.The key of the element to add. Determines whether the TopicMap contains the specified key.

Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). otherwise. Requirements Target Platforms: Windows 7.xml extension. Windows Vista SP1 or later. Windows XP SP3. Windows Server 2008 R2 (Server Core supported with SP1 or later). Load() Loads the TopicMap contents from an XML file with the same name as the HelpSource with . Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Load Method Loads the TopicMap contents from an XML file. Overload List Overload Description Load(String) Loads the TopicMap contents from an XML file. Windows Server 2008 R2 (Server Core supported with SP1 or later). false.The key to locate in the TopicMap. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members 119 . Return Value true if the TopicMap contains an element with the specified key. Exceptions Exception Description System. Windows XP SP3.ArgumentNullException path is null.

Loads the TopicMap contents from an XML file. Syntax Visual Basic (Declaration) Public Overloads Sub Load( _ ByVal fileName As String _ ) C# public void Load( string fileName ) Parameters fileName The location of the file containing a topic map.Dynamic. Requirements Target Platforms: Windows 7. Windows XP SP3.Load(String) Method The location of the file containing a topic map.xml extension. Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax 120 . Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Overload List Load() Method Loads the TopicMap contents from an XML file with the same name as the HelpSource with . Remarks All items loaded with this method will have ItemType property set to MapItemType. Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported).

it tries to find a UI element. Requirements 121 . Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Overload List Refresh Method Refreshes topic map items with the ItemType property set to MapItemType. Windows Server 2008 (Server Core not supported). For every control path in the map that does not yet have a UI element found for it. Windows Vista SP1 or later.Visual Basic (Declaration) Public Overloads Sub Load() C# public void Load() Remarks All items loaded with this method will have ItemType property set to MapItemType. that is. it is added to the dynamic help system. Requirements Target Platforms: Windows 7. Syntax Visual Basic (Declaration) Public Sub Refresh() C# public void Refresh() Remarks If a UI element is found. Windows Server 2008 R2 (Server Core supported with SP1 or later). mouse hover) for it are monitored and the associated topic is shown when triggered by those events.Dynamic.Dynamic. the events (focus enter/leave. Windows XP SP3.

Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3.Target Platforms: Windows 7. Windows Vista SP1 or later. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Remove(Object) Method The key of the element to remove. Windows Server 2008 (Server Core not supported). Windows Server 2008 (Server Core not supported). Removes the value with the specified uiElement from the TopicMap Syntax Visual Basic (Declaration) Public Overloads Shadows Sub Remove( _ ByVal uiElement As Object _ ) C# 122 . Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Remove Method Removes the value with the specified uiElement from the TopicMap Overload List Overload Description Remove(Object) Removes the value with the specified uiElement from the TopicMap Remove(String) Removes the value with the specified path from the TopicMap Requirements Target Platforms: Windows 7.

Windows Server 2008 R2 (Server Core supported with SP1 or later). Exceptions Exception Description System. Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Overload List Remove(String) Method The key of the element to remove. Removes the value with the specified path from the TopicMap Syntax Visual Basic (Declaration) Public Overloads Sub Remove( _ ByVal path As String _ ) C# public void Remove( string path ) Parameters 123 .public new void Remove( object uiElement ) Parameters uiElement The key of the element to remove. Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported). Windows XP SP3.ArgumentNullException uiElement is null. Requirements Target Platforms: Windows 7.

Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members 124 . Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Overload List Save Method Saves the TopicMap contents to an XML file with the same name as the HelpSource with . Windows Vista SP1 or later. Windows XP SP3.xml extension. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). Requirements Target Platforms: Windows 7.path The key of the element to remove. Exceptions Exception Description System.xml extension. Overload List Overload Description Save() Saves the TopicMap contents to an XML file with the same name as the HelpSource with . Windows Server 2008 (Server Core not supported).ArgumentNullException path is null. Windows Vista SP1 or later. Save(String) Saves the TopicMap contents to an XML file with a given name/location. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. Requirements Target Platforms: Windows 7.

xml extension. Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Overload List Save(String) Method The location of the file where you want to save the topic map. Syntax Visual Basic (Declaration) Public Overloads Sub Save( _ ByVal fileName As String _ ) C# public void Save( string fileName 125 . Windows Server 2008 R2 (Server Core supported with SP1 or later).Save() Method Saves the TopicMap contents to an XML file with the same name as the HelpSource with . Saves the TopicMap contents to an XML file with a given name/location. Windows XP SP3. Syntax Visual Basic (Declaration) Public Overloads Sub Save() C# public void Save() Remarks Only map items with ItemType set to MapItemType. Windows Vista SP1 or later.Dynamic are saved to the XML file.

Requirements Target Platforms: Windows 7.MapItem>) Conflicts Gets an array of conflicting map items.Collections. Remarks Only map items with ItemType set to MapItemType. Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Overload List Properties %%scrap%% " --> For a list of all members of this type. Public Properties Name Description Comparer (Inherited from System.Dynamic are saved to the XML file. Item Gets or sets the value associated with the specified key. Windows Vista SP1 or later. 126 . Count (Inherited from System.MapItem>) HasChanges Gets a value that determines whether the TopicMap has changed since it was initialized (read from an XML file). Windows Server 2008 (Server Core not supported).Dictionary<object.Dictionary<object.Collections.Generic.Generic. Windows Server 2008 R2 (Server Core supported with SP1 or later).) Parameters fileName The location of the file where you want to save the topic map. see TopicMap members. Windows XP SP3.

Usually.} Remarks A conflict exists between two map items.Dictionary<object.Xml. which is saved to an XML file. Windows Server 2008 R2 (Server Core supported with SP1 or later).Win. In such a case. Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported).Dictionary<object.Collections. no error is generated. Windows Server 2003 SP2 See Also 127 . Top See Also Reference TopicMap Class C1. Windows XP SP3. that can be done using this property.Keys (Inherited from System. usually either only static or only dynamic mappings are used).Collections. one static and the other dynamic. when they refer to the same UI element.Generic.MapItem>) XmlSource Gets or sets an System. there is no need to worry about these conflicts (mostly because static and dynamic mappings are rarely mixed.XmlDocument value representing a TopicMap created in authoring mode (so it consists of dynamic map items. Syntax Visual Basic (Declaration) Public ReadOnly Property Conflicts As Conflict() C# public Conflict[] Conflicts {get. Windows Vista SP1 or later.MapItem>) Values (Inherited from System.C1DynamicHelp Namespace Conflicts Property Gets an array of conflicting map items.Generic. static map items aren't included). the static map item is silently ignored. the precedence is with the dynamic map item. but in case the programmer wants to know which items are in conflict with each other.

unless the application changes the map programmatically. Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Public Shadows Default Property Item( _ 128 . Windows Vista SP1 or later. to check whether the TopicMap has changed and should therefore be saved before the application closes. Syntax Visual Basic (Declaration) Public ReadOnly Property HasChanges As Boolean C# public bool HasChanges {get. It will return false if authoring mode is not used.} Remarks This property is typically used in authoring mode. Windows XP SP3. Windows Server 2008 (Server Core not supported). Gets or sets the value associated with the specified key. Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Item Property The UI element of the value to get or set.Reference TopicMap Class TopicMap Members HasChanges Property Gets a value that determines whether the TopicMap has changed since it was initialized (read from an XML file). Requirements Target Platforms: Windows 7.

Generic. Windows XP SP3. and a set operation creates a new element with the specified key. a get operation throws a System. System. static map items aren't included).Collections.Collections.ArgumentNullException key is null. Property Value The value associated with the specified key. Exceptions Exception Description System. Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members XmlSource Property Gets or sets an System.KeyNotFoundException The property is retrieved and key does not exist in the collection.ByVal uiElement As Object _ ) As MapItem C# public new MapItem this[ object uiElement ]. Syntax 129 . which is saved to an XML file. Windows Server 2008 (Server Core not supported).KeyNotFoundException.} Parameters uiElement The UI element of the value to get or set.Xml. Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later). {get.XmlDocument value representing a TopicMap created in authoring mode (so it consists of dynamic map items. set. If the specified key is not found.Generic.

create an XmlDocument at run time and assign it to the XmlSource property. Windows Server 2008 R2 (Server Core supported with SP1 or later). Public Events Name Description TopicMapChanged Fires after changes were made in the topic map. Windows XP SP3.} Remarks You can set this property instead of loading topic map from an XML file. Top See Also Reference TopicMap Class C1. Windows Vista SP1 or later. For example. Requirements Target Platforms: Windows 7. you can choose to store the XML in application resources.Win. set. Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members Events %%scrap%% " --> For a list of all members of this type. TopicMapSaved Fires after the topic map is saved to an XML file. see TopicMap members.C1DynamicHelp Namespace 130 .Visual Basic (Declaration) Public Property XmlSource As XmlDocument C# public XmlDocument XmlSource {get.

Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also Reference TopicMap Class TopicMap Members TopicMapSaved Event Fires after the topic map is saved to an XML file. Syntax Visual Basic (Declaration) Public Event TopicMapChanged As EventHandler C# public event EventHandler TopicMapChanged Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3.TopicMapChanged Event Fires after changes were made in the topic map. Windows Server 2003 SP2 See Also Reference 131 . Syntax Visual Basic (Declaration) Public Event TopicMapSaved As EventHandler C# public event EventHandler TopicMapSaved Requirements Target Platforms: Windows 7.

you need to create a UIElementInfo object and set its Name and Parent properties.Win. Windows Server 2008 R2 (Server Core supported with SP1 or later). Inheritance Hierarchy System. when you override the UIElementResolver. Namely. Object Model 132 . Object Model Syntax Visual Basic (Declaration) Public Class UIElementInfo C# public class UIElementInfo Remarks This class should be used only if you want to assign topics to UI elements in custom controls.C1DynamicHelp. Windows Server 2008 (Server Core not supported).Object C1. Windows XP SP3. If you need to handle UI elements inside custom controls. Windows Server 2003 SP2 See Also Reference UIElementInfo Members C1.Win. you have to create your own UIElementResolver object and override its virtual methods. Windows Vista SP1 or later.TopicMap Class TopicMap Members UIElementInfo This class contains information about a UI element: its Name and Parent.GetUIElementInfo method.C1DynamicHelp Namespace Overview This class contains information about a UI element: its Name and Parent.UIElementInfo Requirements Target Platforms: Windows 7.

C1DynamicHelp Namespace Members Properties The following tables list the members exposed by UIElementInfo. Windows Server 2008 R2 (Server Core supported with SP1 or later).Win. when you override the UIElementResolver. If you need to handle UI elements inside custom controls. Windows Server 2003 SP2 See Also Reference UIElementInfo Members C1. you need to create a UIElementInfo object and set its Name and Parent properties. Windows Vista SP1 or later. Inheritance Hierarchy System. Namely. you have to create your own UIElementResolver object and override its virtual methods. Windows XP SP3.UIElementInfo Requirements Target Platforms: Windows 7. Top 133 .Win. Windows Server 2008 (Server Core not supported).Object C1.C1DynamicHelp.GetUIElementInfo method.Syntax Visual Basic (Declaration) Public Class UIElementInfo C# public class UIElementInfo Remarks This class should be used only if you want to assign topics to UI elements in custom controls. Public Constructors Name Description UIElementInfo Constructor Overloaded.

String. Top See Also Reference UIElementInfo Class C1. 134 . Parent Gets or sets the parent object of the UIElement. Windows Vista SP1 or later.Object) Initializes a new of instance of a UIElementInfo Requirements Target Platforms: Windows 7. Windows Server 2003 SP2 See Also Reference UIElementInfo Class UIElementInfo Members UIElementInfo Constructor(Object) UI element for which this UIElementInfo object contains data. The name should be unique inside the parent control. Windows XP SP3. Windows Server 2008 (Server Core not supported).C1DynamicHelp Namespace UIElementInfo Constructor Overload List Overload Description UIElementInfo Constructor(Object) Initializes a new of instance of a UIElementInfo UIElementInfo Constructor(Object. UIElement Gets the UI element for which this UIElementInfo object contains data.Public Properties Name Description Name Gets or sets the name of the UIElement.Win. Windows Server 2008 R2 (Server Core supported with SP1 or later).

Object) UI element for which this UIElementInfo object contains data. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported).Initializes a new of instance of a UIElementInfo Syntax Visual Basic (Declaration) Public Function New( _ ByVal uiElement As Object _ ) C# public UIElementInfo( object uiElement ) Parameters uiElement UI element for which this UIElementInfo object contains data. Exceptions Exception Description System. Windows Server 2003 SP2 See Also Reference UIElementInfo Class UIElementInfo Members Overload List UIElementInfo Constructor(Object. Requirements Target Platforms: Windows 7. Name property for the specified uiElement Parent property for the specified uiElement Initializes a new of instance of a UIElementInfo 135 .ArgumentNullException uiElement is null. Windows XP SP3.String.

_ ByVal parent As Object _ ) C# public UIElementInfo( object uiElement. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). string name. Windows Vista SP1 or later. _ ByVal name As String.Syntax Visual Basic (Declaration) Public Function New( _ ByVal uiElement As Object.ArgumentNullException uiElement is null. object parent ) Parameters uiElement UI element for which this UIElementInfo object contains data. Windows XP SP3. name Name property for the specified uiElement parent Parent property for the specified uiElement Exceptions Exception Description System. Windows Server 2003 SP2 See Also Reference 136 . Requirements Target Platforms: Windows 7.

} Requirements Target Platforms: Windows 7. Windows XP SP3. Parent Gets or sets the parent object of the UIElement. Windows Server 2003 SP2 137 . see UIElementInfo members.C1DynamicHelp Namespace Name Property Gets or sets the name of the UIElement.UIElementInfo Class UIElementInfo Members Overload List Properties %%scrap%% " --> For a list of all members of this type.Win. Top See Also Reference UIElementInfo Class C1. Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Public Property Name As String C# public string Name {get. Windows Server 2008 (Server Core not supported). The name should be unique inside the parent control. set. The name should be unique inside the parent control. Public Properties Name Description Name Gets or sets the name of the UIElement. Windows Vista SP1 or later. UIElement Gets the UI element for which this UIElementInfo object contains data.

Windows Server 2008 (Server Core not supported). Syntax Visual Basic (Declaration) Public ReadOnly Property UIElement As Object C# public object UIElement {get.} Requirements Target Platforms: Windows 7.See Also Reference UIElementInfo Class UIElementInfo Members Parent Property Gets or sets the parent object of the UIElement. Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Public Property Parent As Object C# public object Parent {get. Windows Server 2003 SP2 See Also Reference UIElementInfo Class UIElementInfo Members UIElement Property Gets the UI element for which this UIElementInfo object contains data. set. Windows Vista SP1 or later. Windows XP SP3.} Requirements 138 .

Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). You have no need to create objects of this type. Inheritance Hierarchy System.UIElementResolver Requirements Target Platforms: Windows 7. Windows XP SP3. Windows Vista SP1 or later. it is sufficient to define a class derived from UIElementResolver and override its virtual methods. etc.Win. Windows Vista SP1 or later. Windows XP SP3. Windows Server 2003 SP2 See Also Reference UIElementInfo Class UIElementInfo Members UIElementResolver This class provides methods to find UI elements inside a control by name. not with the controls themselves.Object C1.Target Platforms: Windows 7.C1DynamicHelp. Windows Server 2008 R2 (Server Core supported with SP1 or later). Object Model Syntax Visual Basic (Declaration) Public Class UIElementResolver C# public class UIElementResolver Remarks A class derived from this class is necessary only if you are using custom controls that cannot be handled by the C1DynamicHelp control automatically and then only if you need to associate help topics with parts (UI elements) of those controls. These overridden methods should provide necessary information about UI elements inside custom controls used in your application. Windows Server 2008 (Server Core not supported). coordinates. Windows Server 2003 SP2 139 . and other methods necessary for associating dynamic help to UI elements inside a control.

it is sufficient to define a class derived from UIElementResolver and override its virtual methods. These overridden methods should provide necessary information about UI elements inside custom controls used in your application.Win.See Also Reference UIElementResolver Members C1. Windows Vista SP1 or later.Object C1. Object Model Syntax Visual Basic (Declaration) Public Class UIElementResolver C# public class UIElementResolver Remarks A class derived from this class is necessary only if you are using custom controls that cannot be handled by the C1DynamicHelp control automatically and then only if you need to associate help topics with parts (UI elements) of those controls. Inheritance Hierarchy System. coordinates. Windows Server 2003 SP2 See Also Reference 140 . Windows XP SP3.UIElementResolver Requirements Target Platforms: Windows 7. and other methods necessary for associating dynamic help to UI elements inside a control. not with the controls themselves. You have no need to create objects of this type.Win. Windows Server 2008 R2 (Server Core supported with SP1 or later). etc. Windows Server 2008 (Server Core not supported).C1DynamicHelp Namespace Overview This class provides methods to find UI elements inside a control by name.C1DynamicHelp.

Syntax Visual Basic (Declaration) Public Sub HandleUIElementEvent( _ 141 .C1DynamicHelp Namespace HandleUIElementEvent Method A UI element for which an event occurred. Simulates an event for a UI element. Top See Also Reference UIElementResolver Class C1. One of the UIElementEvents values.Win. determining the type of the event (Enter or Leave).C1DynamicHelp Namespace Methods > Name Description HandleUIElementEvent Simulates an event for a UI element.Win. Top See Also Reference UIElementResolver Class C1. Public Methods Name Description HandleUIElementEvent Simulates an event for a UI element.UIElementResolver Members C1.Win.C1DynamicHelp Namespace Members Methods The following tables list the members exposed by UIElementResolver.

Requirements Target Platforms: Windows 7. Windows Server 2003 SP2 See Also Reference UIElementResolver Class UIElementResolver Members 142 . Typical usage is to override the ActivateUIElement method. and uiElementEvent is the type of the event (Enter or Leave).ByVal sender As Object. so C1DynamicHelp can show the topic associated with that UI element. Remarks You should call this method whenever one of the UIElementEvents (Enter/Leave) occurs for a UI element that must be handled by your code. By calling this method you notify C1DynamicHelp that an event has occurred. that is. uiElementEvent One of the UIElementEvents values. subscribing there to some events that would help you to detect the moments the focus enters/leaves the UI elements. UIElementEvents uiElementEvent ) Parameters sender A UI element for which an event occurred. _ ByVal uiElementEvent As UIElementEvents _ ) C# public void HandleUIElementEvent( object sender. the sender parameter is the UI element for which an event occurred. Windows Server 2008 (Server Core not supported). determining the type of the event (Enter or Leave). In the HandleUIElementEvent call. Windows Server 2008 R2 (Server Core supported with SP1 or later). the C1DynamicHelp control cannot monitor this UI element for Enter/Leave events automatically (because it does not have those events). Windows Vista SP1 or later. Windows XP SP3. and call HandleUIElementEvent method from those event handlers.

Windows XP SP3. PanelAndWindow Specifies that a topic should be displayed both in the C1DynamicHelp control and in an external help viewer window.DisplayTarget Requirements Target Platforms: Windows 7. ExternalWindow Specifies that a topic should be displayed in an external window.Enumerations DisplayTarget Enumeration that specifies where a topic will be displayed. Windows Vista SP1 or later. Syntax Visual Basic (Declaration) Public Enum DisplayTarget Inherits System. Windows Server 2003 SP2 143 .C1DynamicHelp.ShowTopicForActiveControl.Enum C1. in an external window or both. It allows to show a topic in the C1DynamicHelp control.Win. which is typically used when a user presses the F1 key to get help.Enum C# public enum DisplayTarget : System. Remarks This enumeration is used in C1DynamicHelp. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later).Object System.Enum Members Member Description ControlPanel Specifies that a topic should be displayed in the C1DynamicHelp control. Inheritance Hierarchy System.ValueType System.

ShowExternalHelp method.See Also Reference C1.Win. TableOfContents The help file opens on the table of contents.ValueType System. Remarks It is used by the C1DynamicHelp. Index The help file opens on the index. Inheritance Hierarchy System.Enum C1.HelpTab Requirements 144 .C1DynamicHelp Namespace HelpTab Enumeration specifying the part/element of the help file to display. Syntax Visual Basic (Declaration) Public Enum HelpTab Inherits System.Enum Members Member Description Find The help file opens on the search page. Topic The help file opens on a specified topic.Win.C1DynamicHelp.Enum C# public enum HelpTab : System.Object System.

Remarks You can use combinations of this enumeration to show topics both on Enter and MouseHover events.Target Platforms: Windows 7.Enum C# public enum HelpTopicTrigger : System.Object System. Windows XP SP3. Syntax Visual Basic (Declaration) Public Enum HelpTopicTrigger Inherits System.Enum C1. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Vista SP1 or later.Enum Members Member Description Enter Show topic when a UI element gets the focus. None Show topic programmatically.ValueType System.HelpTopicTrigger Requirements 145 .C1DynamicHelp Namespace HelpTopicTrigger Enumeration that specifies user actions that cause a HelpTopic to be displayed. Windows Server 2008 (Server Core not supported). Inheritance Hierarchy System. MouseEnter Show help topic when the mouse hovers over a UI element.Win. Windows Server 2003 SP2 See Also Reference C1.C1DynamicHelp.Win. not by events.

Win.ValueType System. Remarks Map items created at design time have the MapItemType.Enum C# public enum MapItemType : System.MapItemType Requirements 146 .Static type. Windows Vista SP1 or later. they are stored in the form's code and cannot be saved to an XML file.C1DynamicHelp Namespace MapItemType Enumeration that specifies topic map item type. you can choose any of these two types. Inheritance Hierarchy System.Object System. they are saved to the XML file when the map is persisted. Static Indicates map items created at design time. Windows Server 2003 SP2 See Also Reference C1. If you create map items programmatically. Windows Server 2008 (Server Core not supported). Map items created in authoring mode have the MapItemType.Win. persisted in form code.Enum Members Member Description Dynamic Indicates map items created in authoring mode.Target Platforms: Windows 7. Syntax Visual Basic (Declaration) Public Enum MapItemType Inherits System.Enum C1. Windows XP SP3.Dynamic type. Windows Server 2008 R2 (Server Core supported with SP1 or later).C1DynamicHelp. saved to an XML file.

Enum Members Member Description Enter UI element received focus.Enum C# public enum UIElementEvents : System. Leave UI element lost focus. Syntax Visual Basic (Declaration) Public Enum UIElementEvents Inherits System.C1DynamicHelp.Win.UIElementEvents Requirements 147 .Win. Windows XP SP3. You need this enumeration only if you use custom controls and want to associate topics with UI elements inside them. Windows Server 2003 SP2 See Also Reference C1. Remarks It is used only in the UIElementResolver.ValueType System. Windows Vista SP1 or later.HandleUIElementEvent method to specify the type of an event. Windows Server 2008 R2 (Server Core supported with SP1 or later).C1DynamicHelp Namespace UIElementEvents Enumeration that specifies which of the monitored events occurred for a UI element.Object System. Inheritance Hierarchy System. Windows Server 2008 (Server Core not supported).Enum C1.Target Platforms: Windows 7.

A TopicEventArgs that contains the event data. Windows Server 2008 (Server Core not supported). Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. e A TopicEventArgs that contains the event data.Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Represents a method that will handle the C1DynamicHelp.C1DynamicHelp Namespace Delegates HelpTopicEventHandler The source of the event. Windows XP SP3. Windows Vista SP1 or later. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 See Also Reference C1.CurrentTopicChanging event of a C1DynamicHelp. Syntax Visual Basic (Declaration) Public Delegate Sub HelpTopicEventHandler( _ ByVal sender As Object. Windows Server 2003 SP2 148 . _ ByVal e As TopicEventArgs _ ) C# public delegate void HelpTopicEventHandler( object sender.Win. Windows XP SP3. Windows Server 2008 R2 (Server Core supported with SP1 or later). TopicEventArgs e ) Parameters sender The source of the event.

C1DynamicHelp.See Also Reference HelpTopicEventHandler Members C1.Win. Interfaces Interface Description IHelpProvider The interface that needs to be implemented by a help provider class. Object Model Syntax 149 .4 Assembly Classes ChmProvider The class providing the IHelpProvider functionality for HTML Help (.C1DynamicHelp.chm files). See Also Reference C1. NetHelpProvider The class providing the IHelpProvider functionality for ComponentOne NetHelp.Providers Namespace Overview Classes Class Description ChmProvider The class providing the IHelpProvider functionality for HTML Help (.Win.C1DynamicHelp Namespace C1.chm files).Win.

Providers Namespace Overview The class providing the IHelpProvider functionality for HTML Help (.C1DynamicHelp.C1DynamicHelp.Win.chm files).Providers.Win. Windows Server 2008 R2 (Server Core supported with SP1 or later).Win. Windows Server 2003 SP2 See Also Reference ChmProvider Members C1. Windows Server 2008 (Server Core not supported).ChmProvider Requirements Target Platforms: Windows 7.C1DynamicHelp.Object C1.Object C1.Providers. Windows Vista SP1 or later.Visual Basic (Declaration) Public Class ChmProvider Implements IHelpProvider C# public class ChmProvider : IHelpProvider Inheritance Hierarchy System.ChmProvider 150 . Object Model Syntax Visual Basic (Declaration) Public Class ChmProvider Implements IHelpProvider C# public class ChmProvider : IHelpProvider Inheritance Hierarchy System. Windows XP SP3.

C1DynamicHelp. GetFullUrl Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control.Win. Windows Server 2008 R2 (Server Core supported with SP1 or later).Providers Namespace Members Properties Methods The following tables list the members exposed by ChmProvider. 151 . Windows XP SP3. Top Public Methods Name Description CorrectUrl Checks whether the URL is in correct format and corrects it if necessary. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also Reference ChmProvider Members C1. GetCtxtIdMap Returns a dictionary of help topics indexed by their context IDs (contains only topics that have context ids). Public Constructors Name Description ChmProvider Constructor Top Public Properties Name Description Source Gets or sets the help file.Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported).

Windows Server 2008 (Server Core not supported).GetTopics Returns a hierarchical list of topics in the help file. Windows Server 2003 SP2 See Also Reference ChmProvider Class ChmProvider Members Methods > Name Description CorrectUrl Checks whether the URL is in correct format and corrects it if necessary. Windows XP SP3. Show help navigation (in a separate window). Top See Also Reference ChmProvider Class C1.Win. GetUrlMap Returns a dictionary of help topics indexed by their URLs (contains all topics). Windows Vista SP1 or later. ShowExternalHelp Overloaded. Windows Server 2008 R2 (Server Core supported with SP1 or later).C1DynamicHelp. GetCtxtIdMap Returns a dictionary of help topics indexed by their context IDs (contains 152 .Providers Namespace ChmProvider Constructor Syntax Visual Basic (Declaration) Public Function New() C# public ChmProvider() Requirements Target Platforms: Windows 7.

Show help navigation (in a separate window).only topics that have context ids). otherwise the initial URL value Remarks 153 .Providers Namespace CorrectUrl Method URL to be checked and corrected Checks whether the URL is in correct format and corrects it if necessary. Syntax Visual Basic (Declaration) Public Function CorrectUrl( _ ByVal url As String _ ) As String C# public string CorrectUrl( string url ) Parameters url URL to be checked and corrected Return Value A corrected URL if some changes were made.Win.C1DynamicHelp. ShowExternalHelp Overloaded. GetTopics Returns a hierarchical list of topics in the help file. GetFullUrl Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control. Top See Also Reference ChmProvider Class C1. GetUrlMap Returns a dictionary of help topics indexed by their URLs (contains all topics).

chm file can lead to losing the path specified in the Source property. Requirements Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Vista SP1 or later. Windows XP SP3. Windows Server 2003 SP2 See Also Reference ChmProvider Class ChmProvider Members GetCtxtIdMap Method Returns a dictionary of help topics indexed by their context IDs (contains only topics that have context ids).Clicking some links in a *. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference ChmProvider Class ChmProvider Members GetFullUrl Method Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control. Syntax Visual Basic (Declaration) 154 . Windows XP SP3. Windows Server 2008 (Server Core not supported). Windows Vista SP1 or later. Syntax Visual Basic (Declaration) Public Function GetCtxtIdMap() As Dictionary(Of Integer.HelpTopic) C# public Dictionary<int.HelpTopic> GetCtxtIdMap() Requirements Target Platforms: Windows 7.

Syntax Visual Basic (Declaration) Public Function GetTopics() As HelpTopicList C# public HelpTopicList GetTopics() Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. Windows Server 2008 (Server Core not supported).Public Function GetFullUrl( _ ByVal url As String _ ) As String C# public string GetFullUrl( string url ) Parameters url Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also Reference ChmProvider Class ChmProvider Members GetTopics Method Returns a hierarchical list of topics in the help file. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. Windows Server 2003 SP2 See Also Reference 155 . Windows Vista SP1 or later.

Overload List Overload Description ShowExternalHelp(HelpTab) Show help navigation (in a separate window). Windows Server 2003 SP2 See Also Reference 156 . Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported). Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference ChmProvider Class ChmProvider Members ShowExternalHelp Method Show help navigation (in a separate window). Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. Windows XP SP3. Windows Server 2008 R2 (Server Core supported with SP1 or later).HelpTopic) C# public Dictionary<string. Windows Vista SP1 or later.Object) Show help navigation (in a separate window). Requirements Target Platforms: Windows 7.ChmProvider Class ChmProvider Members GetUrlMap Method Returns a dictionary of help topics indexed by their URLs (contains all topics).HelpTopic> GetUrlMap() Requirements Target Platforms: Windows 7. Syntax Visual Basic (Declaration) Public Function GetUrlMap() As Dictionary(Of String. ShowExternalHelp(HelpTab.

Syntax Visual Basic (Declaration) Public Overloads Sub ShowExternalHelp( _ ByVal tab As HelpTab _ ) C# public void ShowExternalHelp( HelpTab tab ) Parameters tab Initial help page to display.Find. HelpTab.Find.Index.TableOfContents. Windows Server 2003 SP2 See Also Reference ChmProvider Class ChmProvider Members Overload List ShowExternalHelp(HelpTab. or HelpTab. HelpTab. HelpTab. or HelpTab.ChmProvider Class ChmProvider Members ShowExternalHelp(HelpTab) Method Initial help page to display.Index. Windows Server 2008 (Server Core not supported). Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. typically HelpTab.Find. or HelpTab. Windows Server 2008 R2 (Server Core supported with SP1 or later).TableOfContents. Show help navigation (in a separate window).TableOfContents. typically HelpTab.Index. Topic identifier Show help navigation (in a separate window).Object) Method Initial help page to display. 157 . typically HelpTab. Windows XP SP3.

Windows XP SP3. _ ByVal parameter As Object _ ) C# public void ShowExternalHelp( HelpTab tab. object parameter ) Parameters tab Initial help page to display. Windows Server 2008 (Server Core not supported). or HelpTab. Public Properties 158 . Windows Server 2008 R2 (Server Core supported with SP1 or later).TableOfContents.Index. see ChmProvider members. Windows Vista SP1 or later. HelpTab. parameter Topic identifier Requirements Target Platforms: Windows 7.Syntax Visual Basic (Declaration) Public Overloads Sub ShowExternalHelp( _ ByVal tab As HelpTab.Find. typically HelpTab. Windows Server 2003 SP2 See Also Reference ChmProvider Class ChmProvider Members Overload List Properties %%scrap%% " --> For a list of all members of this type.

Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference ChmProvider Class ChmProvider Members NetHelpProvider The class providing the IHelpProvider functionality for ComponentOne NetHelp. Top See Also Reference ChmProvider Class C1. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3.Win. Syntax Visual Basic (Declaration) Public Property Source As String C# public string Source {get.} Requirements Target Platforms: Windows 7. set.C1DynamicHelp. Object Model Syntax 159 .Name Description Source Gets or sets the help file.Providers Namespace Source Property Gets or sets the help file. Windows Vista SP1 or later.

Object C1.NetHelpProvider Requirements Target Platforms: Windows 7. Windows Vista SP1 or later.Providers.Object C1. Windows Server 2003 SP2 See Also Reference NetHelpProvider Members C1.Providers. Object Model Syntax Visual Basic (Declaration) Public Class NetHelpProvider Implements IHelpProvider C# public class NetHelpProvider : IHelpProvider Inheritance Hierarchy System. Windows Server 2008 R2 (Server Core supported with SP1 or later).C1DynamicHelp.C1DynamicHelp.NetHelpProvider 160 .Providers Namespace Overview The class providing the IHelpProvider functionality for ComponentOne NetHelp. Windows Server 2008 (Server Core not supported).Visual Basic (Declaration) Public Class NetHelpProvider Implements IHelpProvider C# public class NetHelpProvider : IHelpProvider Inheritance Hierarchy System.Win.C1DynamicHelp. Windows XP SP3.Win.Win.

Providers Namespace Members Properties Methods The following tables list the members exposed by NetHelpProvider.Win. GetCtxtIdMap Returns a dictionary of help topics indexed by their context IDs (contains only topics that have context ids). Windows Server 2003 SP2 See Also Reference NetHelpProvider Members C1. GetFullUrl Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control. Windows Server 2008 (Server Core not supported). Public Constructors Name Description NetHelpProvider Constructor Top Public Properties Name Description Source Gets or sets the help file. Windows Server 2008 R2 (Server Core supported with SP1 or later). Top Public Methods Name Description CorrectUrl This method is not meaningful for the NetHelpProvider. Windows XP SP3. 161 . Windows Vista SP1 or later. It is used only to implement the IHelpProvider interface.C1DynamicHelp.Requirements Target Platforms: Windows 7.

Public Methods 162 . Windows Server 2008 R2 (Server Core supported with SP1 or later).Providers Namespace NetHelpProvider Constructor Syntax Visual Basic (Declaration) Public Function New() C# public NetHelpProvider() Requirements Target Platforms: Windows 7. Top See Also Reference NetHelpProvider Class C1. Windows XP SP3. Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members Methods %%scrap%% " --> For a list of all members of this type. see NetHelpProvider members.Win. Show help navigation (in a separate window). ShowExternalHelp Overloaded. Windows Server 2008 (Server Core not supported).C1DynamicHelp. GetUrlMap Returns a dictionary of help topics indexed by their URLs (contains all topics).GetTopics Returns a hierarchical list of topics in the help file. Windows Vista SP1 or later.

Show help navigation (in a separate window).Win. GetTopics Returns a hierarchical list of topics in the help file. GetFullUrl Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control. It is used only to implement the IHelpProvider interface. Top See Also Reference NetHelpProvider Class C1.C1DynamicHelp. Syntax Visual Basic (Declaration) Public Function CorrectUrl( _ ByVal url As String _ ) As String C# public string CorrectUrl( 163 .Providers Namespace CorrectUrl Method Url to be checked and corrected This method is not meaningful for the NetHelpProvider.Name Description CorrectUrl This method is not meaningful for the NetHelpProvider. GetCtxtIdMap Returns a dictionary of help topics indexed by their context IDs (contains only topics that have context ids). ShowExternalHelp Overloaded. GetUrlMap Returns a dictionary of help topics indexed by their URLs (contains all topics). It is used only to implement the IHelpProvider interface.

Windows Vista SP1 or later. Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members 164 . Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members GetCtxtIdMap Method Returns a dictionary of help topics indexed by their context IDs (contains only topics that have context ids). Windows XP SP3. Syntax Visual Basic (Declaration) Public Function GetCtxtIdMap() As Dictionary(Of Integer. Windows Vista SP1 or later.HelpTopic) C# public Dictionary<int.string url ) Parameters url Url to be checked and corrected Return Value Always the initial url Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Windows XP SP3.HelpTopic> GetCtxtIdMap() Requirements Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later).

Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members GetTopics Method Returns a hierarchical list of topics in the help file. Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported).GetFullUrl Method Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control. Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Public Function GetTopics() As HelpTopicList C# public HelpTopicList GetTopics() Requirements 165 . Syntax Visual Basic (Declaration) Public Function GetFullUrl( _ ByVal url As String _ ) As String C# public string GetFullUrl( string url ) Parameters url Requirements Target Platforms: Windows 7. Windows XP SP3.

Windows Server 2008 R2 (Server Core supported with SP1 or later). Requirements 166 . Windows Vista SP1 or later. Windows Vista SP1 or later.HelpTopic) C# public Dictionary<string. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members ShowExternalHelp Method Show help navigation (in a separate window).Target Platforms: Windows 7. ShowExternalHelp(HelpTab.HelpTopic> GetUrlMap() Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported). Overload List Overload Description ShowExternalHelp(HelpTab) Show help navigation (in a separate window). Windows XP SP3.Object) Show help navigation (in a separate window). Windows Server 2008 (Server Core not supported). Windows XP SP3. Syntax Visual Basic (Declaration) Public Function GetUrlMap() As Dictionary(Of String. Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members GetUrlMap Method Returns a dictionary of help topics indexed by their URLs (contains all topics).

Show help navigation (in a separate window). Syntax Visual Basic (Declaration) Public Overloads Sub ShowExternalHelp( _ ByVal tab As HelpTab _ ) C# public void ShowExternalHelp( HelpTab tab ) Parameters tab Initial help page to display. Windows Vista SP1 or later. Requirements Target Platforms: Windows 7.TableOfContents. or HelpTab. Windows Server 2008 R2 (Server Core supported with SP1 or later). typically HelpTab. Windows XP SP3. typically HelpTab.Find. Windows Server 2008 (Server Core not supported).Target Platforms: Windows 7. Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members ShowExternalHelp(HelpTab) Method Initial help page to display. or HelpTab.Index.TableOfContents. HelpTab.Find. Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members Overload List 167 . HelpTab. Windows XP SP3.Index. Windows Server 2008 (Server Core not supported). Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Vista SP1 or later.

Windows Server 2008 R2 (Server Core supported with SP1 or later). parameter Topic identifier Requirements Target Platforms: Windows 7. Syntax Visual Basic (Declaration) Public Overloads Sub ShowExternalHelp( _ ByVal tab As HelpTab. or HelpTab. Topic identifier Show help navigation (in a separate window). typically HelpTab.Index.ShowExternalHelp(HelpTab.Index. Windows Server 2008 (Server Core not supported). HelpTab.Find. Windows Vista SP1 or later.TableOfContents. typically HelpTab. Windows XP SP3.Find. _ ByVal parameter As Object _ ) C# public void ShowExternalHelp( HelpTab tab. Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members Overload List Properties > 168 .TableOfContents. object parameter ) Parameters tab Initial help page to display. HelpTab.Object) Method Initial help page to display. or HelpTab.

Top See Also Reference NetHelpProvider Class C1.Providers Namespace Source Property Gets or sets the help file.Name Source Description Gets or sets the help file. Windows Vista SP1 or later. Windows XP SP3. Windows Server 2008 (Server Core not supported). Syntax Visual Basic (Declaration) Public Property Source As String C# public string Source {get. Windows Server 2003 SP2 See Also Reference NetHelpProvider Class NetHelpProvider Members Interfaces IHelpProvider The interface that needs to be implemented by a help provider class.} Requirements Target Platforms: Windows 7. set. Windows Server 2008 R2 (Server Core supported with SP1 or later). Object Model Syntax 169 .Win.C1DynamicHelp.

Requirements Target Platforms: Windows 7. to get a topic URL that can be displayed by the C1DynamicHelp control.htm/html file. to get context IDs.0) you can do it by creating your own help provider class implementing this interface. to open help in an external window. Windows Server 2008 R2 (Server Core supported with SP1 or later).Providers Namespace Overview The interface that needs to be implemented by a help provider class. correspondingly.C1DynamicHelp.Visual Basic (Declaration) Public Interface IHelpProvider C# public interface IHelpProvider Remarks You need to know this interface only if you want to create your own custom help provider (an advanced feature). MS Help 2. A help provider can read data from a help source and provides methods to get help topics. Windows Server 2008 (Server Core not supported). Windows Server 2003 SP2 See Also Reference IHelpProvider Members C1. Windows Vista SP1 or later. Object Model Syntax Visual Basic (Declaration) Public Interface IHelpProvider C# public interface IHelpProvider 170 . etc.Win.chm or a . There are two built-in help providers in the C1DynamicHelp: ChmProvider and NetHelpProvider which are used automatically when the HelpSource property points to a . If you want to use another help source type (for example. Windows XP SP3.

C1DynamicHelp. to get a topic URL that can be displayed by the C1DynamicHelp control. Windows Vista SP1 or later. MS Help 2. A help provider can read data from a help source and provides methods to get help topics. 171 . Requirements Target Platforms: Windows 7. correspondingly. etc. Windows Server 2003 SP2 See Also Reference IHelpProvider Members C1. Public Properties Name Description Source Gets or sets the help file. GetCtxtIdMap Returns a dictionary of help topics indexed by their context IDs (contains only topics that have context ids). There are two built-in help providers in the C1DynamicHelp: ChmProvider and NetHelpProvider which are used automatically when the HelpSource property points to a .chm or a . Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3. If you want to use another help source type (for example.Win. Windows Server 2008 (Server Core not supported). Top Public Methods Name Description CorrectUrl Checks whether the URL is in correct format and corrects it if necessary. to open help in an external window.Remarks You need to know this interface only if you want to create your own custom help provider (an advanced feature).0) you can do it by creating your own help provider class implementing this interface. to get context IDs.Providers Namespace Members Properties Methods The following tables list the members exposed by IHelpProvider.htm/html file.

GetUrlMap Returns a dictionary of help topics indexed by their URLs (contains all 172 . GetCtxtIdMap Returns a dictionary of help topics indexed by their context IDs (contains only topics that have context ids). Top See Also Reference IHelpProvider Interface C1. Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel. GetUrlMap Returns a dictionary of help topics indexed by their URLs (contains all topics).Win. GetTopics Returns a hierarchical list of topics in the help file.Providers Namespace Methods %%scrap%% " --> For a list of all members of this type. ShowExternalHelp Overloaded. see IHelpProvider members. GetFullUrl Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control.C1DynamicHelp.GetFullUrl Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control. Public Methods Name Description CorrectUrl Checks whether the URL is in correct format and corrects it if necessary. GetTopics Returns a hierarchical list of topics in the help file.

C1DynamicHelp.Win. Windows XP SP3. Windows Server 2008 R2 (Server Core supported with SP1 or later). Top See Also Reference IHelpProvider Interface C1. otherwise the initial URL value Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. Windows Server 2003 SP2 See Also 173 . Windows Server 2008 (Server Core not supported). Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel.Providers Namespace CorrectUrl Method URL to be checked and corrected Checks whether the URL is in correct format and corrects it if necessary. Syntax Visual Basic (Declaration) Function CorrectUrl( _ ByVal url As String _ ) As String C# string CorrectUrl( string url ) Parameters url URL to be checked and corrected Return Value A corrected URL if some changes were made. ShowExternalHelp Overloaded.topics).

HelpTopic) C# Dictionary<int. Windows Server 2008 (Server Core not supported). Syntax Visual Basic (Declaration) Function GetCtxtIdMap() As Dictionary(Of Integer. Windows Vista SP1 or later.HelpTopic> GetCtxtIdMap() Requirements Target Platforms: Windows 7. Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) Function GetFullUrl( _ ByVal url As String _ ) As String C# string GetFullUrl( string url ) 174 .Reference IHelpProvider Interface IHelpProvider Members GetCtxtIdMap Method Returns a dictionary of help topics indexed by their context IDs (contains only topics that have context ids). Windows Server 2003 SP2 See Also Reference IHelpProvider Interface IHelpProvider Members GetFullUrl Method Returns a URL in a specific for the help provider format that can be displayed by the C1DynamicHelp control. Windows XP SP3.

Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 See Also Reference IHelpProvider Interface IHelpProvider Members GetUrlMap Method Returns a dictionary of help topics indexed by their URLs (contains all topics). Windows Server 2008 (Server Core not supported). Windows Server 2008 (Server Core not supported). Windows XP SP3. Windows Server 2003 SP2 See Also Reference IHelpProvider Interface IHelpProvider Members GetTopics Method Returns a hierarchical list of topics in the help file. Windows Vista SP1 or later. Syntax Visual Basic (Declaration) Function GetTopics() As HelpTopicList C# HelpTopicList GetTopics() Requirements Target Platforms: Windows 7.Parameters url Requirements Target Platforms: Windows 7. Windows Vista SP1 or later. Windows XP SP3. Windows Server 2008 R2 (Server Core supported with SP1 or later). Syntax Visual Basic (Declaration) 175 .

176 .HelpTab values. ShowExternalHelp(HelpTab.HelpTopic> GetUrlMap() Requirements Target Platforms: Windows 7.Object) Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel.HelpTopic) C# Dictionary<string. Windows Server 2003 SP2 See Also Reference IHelpProvider Interface IHelpProvider Members ShowExternalHelp(HelpTab) Method One of the C1. Windows Server 2008 R2 (Server Core supported with SP1 or later).Win. Requirements Target Platforms: Windows 7.Function GetUrlMap() As Dictionary(Of String. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows Server 2003 SP2 See Also Reference IHelpProvider Interface IHelpProvider Members ShowExternalHelp Method Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel. Windows Vista SP1 or later. Windows Vista SP1 or later. Windows Server 2008 (Server Core not supported). Windows XP SP3.C1DynamicHelp. Windows Server 2008 (Server Core not supported). Windows XP SP3. Overload List Overload Description ShowExternalHelp(HelpTab) Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel.

_ ByVal parameter As Object _ 177 . Syntax Visual Basic (Declaration) Overloads Sub ShowExternalHelp( _ ByVal tab As HelpTab.Win.HelpTab values. Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel. Windows XP SP3.HelpTab values.Win. Windows Vista SP1 or later. Requirements Target Platforms: Windows 7. Windows Server 2008 (Server Core not supported).C1DynamicHelp. Syntax Visual Basic (Declaration) Overloads Sub ShowExternalHelp( _ ByVal tab As HelpTab _ ) C# void ShowExternalHelp( HelpTab tab ) Parameters tab One of the C1. Windows Server 2003 SP2 See Also Reference IHelpProvider Interface IHelpProvider Members Overload List ShowExternalHelp(HelpTab. Windows Server 2008 R2 (Server Core supported with SP1 or later).Object) Method One of the C1.Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel.C1DynamicHelp.

Windows Vista SP1 or later.Win. Top See Also Reference IHelpProvider Interface C1.) C# void ShowExternalHelp( HelpTab tab.HelpTab values.Providers Namespace Source Property Gets or sets the help file. Windows Server 2003 SP2 See Also Reference IHelpProvider Interface IHelpProvider Members Overload List Properties > Name Source Description Gets or sets the help file.Win. Windows Server 2008 (Server Core not supported). Syntax 178 . object parameter ) Parameters tab One of the C1. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3.C1DynamicHelp. parameter Requirements Target Platforms: Windows 7.C1DynamicHelp.

Windows Server 2008 (Server Core not supported). Windows Vista SP1 or later.} Requirements Target Platforms: Windows 7. Windows Server 2003 SP2 See Also Reference IHelpProvider Interface IHelpProvider Members 179 . set.Visual Basic (Declaration) Property Source As String C# string Source {get. Windows Server 2008 R2 (Server Core supported with SP1 or later). Windows XP SP3.