C1DynamicHelp Class

Provides dynamic help for applications.

Inheritance

object

MarshalByRefObject

Component

Control

C1DynamicHelp

Implements

Namespace: C1.Win.C1DynamicHelp

Assembly: C1.Win.C1DynamicHelp.4.8.dll

Syntax

[ToolboxBitmap(typeof(C1DynamicHelp), "C1DynamicHelp.png")]
public class C1DynamicHelp : Control, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IExtenderProvider

<ToolboxBitmap(GetType(C1DynamicHelp), "C1DynamicHelp.png")>
Public Class C1DynamicHelp
    Inherits Control
    Implements IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IExtenderProvider

Remarks

The C1DynamicHelp control displays help topics from CHM, NetHelp and other help files.

The HelpSource property specifies the help file containing the documentation.

Topics in the help file can be associated with components in the application either by a programmer at design time, using the HelpTopic extender property, or without programmers, using the control's 'authoring mode' facilities.

Constructors

Name	Description
C1DynamicHelp()	Creates a new instance of the C1DynamicHelp control.

Properties

Name	Description
AuthoringMode	Gets or sets a value indicating whether the control is currently in 'authoring mode'.
BorderStyle	Gets or sets the type of border to display around the 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.
ContextMenuStrip	Gets or sets the ContextMenuStrip associated with this control.
CurrentTopic	Gets or sets the HelpTopic that is currently displayed by the C1DynamicHelp control.
DefaultTrigger	Gets or sets a default HelpTopicTrigger value for the C1DynamicHelp control.
Dock	Gets or sets which control borders are docked to its parent control and determines how the control is resized with its parent.
HelpSource	Gets or sets the location of the help source, such as the name of a .chm file (for HTML Help) or the name of the main .htm file (for NetHelp).
IsPinnedDown	Gets or sets a value indicating whether the current help topic is pinned down.
MainControl	Gets or sets a reference to another C1DynamicHelp control which will be used as a source of data for the current C1DynamicHelp control.
MouseHoverDelay	Gets or sets the interval, in milliseconds, between the time the mouse enters a control or component and the time the associated HelpTopic is displayed in the C1DynamicHelp control.
Provider	Gets or sets a reference to a help provider.
Resolver	Represents a class with virtual methods that are used to supply information about custom controls used in the application.
TopicMap	A dictionary that maps UI elements to MapItem objects.

Methods

Name	Description
Dispose(bool)	Releases the unmanaged resources used by the Control and its child controls and optionally releases the managed resources.
GetHelpTopic(Component)	Gets the MapItem object currently associated with a given UI element.
OnCurrentTopicChanged(EventArgs)	Raises the CurrentTopicChanged event.
OnCurrentTopicChanging(TopicEventArgs)	Raises the CurrentTopicChanging event.
OnHandleCreated(EventArgs)	Raises the HandleCreated event.
SetHelpTopic(Component, MapItem)	Associates a MapItem object with a UI element.
ShowDefaultTopic()	Shows the topic associated with the Form where the C1DynamicHelp control is placed.
ShowExternalHelp(HelpTab)	Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel.
ShowExternalHelp(HelpTab, object)	Displays the contents of the help file in an external help viewer window instead of in the C1DynamicHelp panel.
ShowTopic(HelpTopic)	Shows the given HelpTopic in the C1DynamicHelp control.
ShowTopic(int)	Shows the topic with the given context id in the C1DynamicHelp control.
ShowTopic(object)	Shows the topic associated in the TopicMap with a UI element in the C1DynamicHelp control.
ShowTopic(string)	Shows the topic with the given URL in the C1DynamicHelp control.
ShowTopicForActiveControl(DisplayTarget)	Shows in DisplayTarget the topic associated with the active control (control currently in focus).
WndProc(ref Message)	Processes Windows messages.

Events

Name	Description
CurrentTopicChanged	Fires after the value of the CurrentTopic has changed.
CurrentTopicChanging	Fires before the value of the CurrentTopic changes.