RAD Studio |  |

Making Component Help Context-sensitive

Each component, property, method, and event topic must have an A footnote. The A footnote is used to display the topic when the user selects a component and presses F1, or when a property or event is selected in the Object Inspector and the user presses F1. The A footnotes must follow certain naming conventions:

If the Help topic is for a component, the A footnote consists of two entries separated by a semicolon using this syntax:

Copy Code

    ComponentClass_Object;ComponentClass

where ComponentClass is the name of the component class.

If the Help topic is for a property or event, the A footnote consists of three entries separated by semicolons using this syntax:

Copy Code

    ComponentClass_Element;Element_Type;Element

where ComponentClass is the name of the component class, Element is the name of the property, method, or event, and Type is the either Property, Method, or Event

For example, for a property named BackgroundColor of a component named TMyGrid, the A footnote is

Copy Code

    TMyGrid_BackgroundColor;BackgroundColor_Property;BackgroundColor

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!