In addition to formatted text display, the cshypertext control, as its name implies, also supports hypertext functionality. Any word or phrase can be defined as either a jump or hotspot. Jumps and hotspots are borrowed from the terminology used by the Windows help system. Typically, jump text implies movement to another screen of information while a hotspot brings up a temorary window of text without changing the context of the control.
Jumps and popups are created in the text using the same sort of escape codes used to format text. There are three additional codes: J, P and K.
\\J, \\j Jump. Formats the text as a jumpPopup_Jump, and fires a _Jump event when the user clicks on it.
\\K, \\k Key. Text between \\K and \\k will not be displayed. This attribute can be used to hide internal jump or popup topic information (see examples below). It must appear immediately after \\J or \\P. This text is passed as the Key parameter to the JumpTopic_Jump and PopupTopic_Popup events.
\\P, \\p Popup. Formats the text as a popupPopup_Popup, and fires a _Popup event when the user clicks on it.
A \\J\\K1234\\kjump\\j sample. A \C00FF00\Ujump\c\u sample.
In the last example, a "key" (the string "1234") is included in the jump text. The key text is passed as the Key parameter of the _Jump event, and contains information that the user doesn't see. This can be useful if you want to index your jump topics by some means other than the visible text.
Jumps and hotspots are displayed in cshypertext in the same way they are displayed in help files facilitating a recognizable interface for your users. Using the HotSpotColors property, you can choose to use the color scheme of the help engine, the Multimedia Viewer or to set your own custom colors for jumps and popups.
In the Windows help engine a pointing hand is displayed whenever the cursor is over a jump or hotspot. This is the default behavior of cshypertext. However, it is also possible to set a custom cursor for jumps and popups using the JumpCursor and PopupCursor properties.
When the user clicks on either a jump or popup, the Jump or Popup event is fired. The text, or caption, is passed as well as the embedded key string if one was defined for this particular hotspot.
