|
1 |
| -# Hot Label Component # |
| 1 | +# [Hot Label Component](../index.md) Programmer's Guide |
2 | 2 |
|
3 |
| -The _PJHotLabel_ unit contains a single component, _[TPJHotLabel](TPJHotLabel.md)_, that implements a label control that can access a URL when clicked. |
| 3 | +**Applies to:** ~>2.0 |
4 | 4 |
|
5 |
| -Several types are defined in the unit in total. They are: |
| 5 | +## Introduction |
6 | 6 |
|
7 |
| -| Type | Description | |
8 |
| -| -------- | --------- | |
9 |
| -| _[TPJHotLabel](TPJHotLabel.md)_ | The Hot Label Component itself. | |
10 |
| -| _[EPJURLError](EPJURLError.md)_ | A custom exception that is raised by _[TPJHotLabel](TPJHotLabel.md)_ when URL related errors are encountered. | |
11 |
| -| _TPJHLHintStyle_ | An enumeration of hint styles used by the _[HintStyle](TPJHotLabelHintStyle.md)_ property. See the property's documentation for details. | |
12 |
| -| _TPJHLCustomHintEvent_ | The type of event triggered by the _[OnCustomHint](TPJHotLabelOnCustomHint.md)_ event. See the event's documentation for details. | |
13 |
| - |
14 |
| -**Note:** This documentation relates to release 2.0 and later. Any features introduced after v2.0 are flagged with the relevant version number as a superscript. |
| 7 | +This section of the _Hot Label Component_ documentation describes the API exposed by the unit to programmers. |
15 | 8 |
|
16 |
| -## Examples ## |
| 9 | +The _Hot Label Component_ is supplied in a single unit, _PJHotLabel_. |
17 | 10 |
|
18 |
| -The following examples provide some ideas of how to use the component: |
| 11 | +## Contents |
19 | 12 |
|
20 |
| - 1. [Using highlighting](HotLabelExample1.md) |
21 |
| - 1. [Using the OnCustomHint event](HotLabelExample2.md) |
22 |
| - 1. [Tracking visits to URLs](HotLabelExample3.md)<sup>[v2.2]</sup> |
| 13 | +_PJHotLabel_ contains the following classes and other types. They are: |
23 | 14 |
|
24 |
| -A further example is provided by the demo program that is included in the download. |
| 15 | +| Type | Description | |
| 16 | +| -------- | --------- | |
| 17 | +| _[TPJHotLabel](./API/TPJHotLabel.md)_ | The Hot Label Component itself. | |
| 18 | +| _[EPJURLError](./API/EPJURLError.md)_ | A custom exception that is raised by _[TPJHotLabel](./API/TPJHotLabel.md)_ when URL related errors are encountered. | |
| 19 | +| _TPJHLHintStyle_ | An enumeration of hint styles used by the _[HintStyle](./API/TPJHotLabel-HintStyle.md)_ property. See the property's documentation for details. | |
| 20 | +| _TPJHLCustomHintEvent_ | The type of event triggered by the _[OnCustomHint](./API/TPJHotLabel-OnCustomHint.md)_ event. See the event's documentation for details. | |
25 | 21 |
|
26 | 22 | ## Links
|
27 | 23 |
|
28 |
| -* Back to [Documentation Home Page](../index.md) |
29 |
| -* [Hot Label Component Web Page](https://delphidabbler.com/software/hotlabel) -- Install notes, change log, license etc. |
30 |
| -* [Downloads](https://sourceforge.net/projects/ddablib/files/hotlabel/) -- Download current version here. |
31 |
| -* [Source Code](https://github.com/ddablib/hotlabel) -- Current development tree. |
| 24 | +* [Overview](./Overview.md) |
| 25 | +* [Examples](./Examples.md) |
0 commit comments