HyperLabel Class (Typed) |  |
Create a hyperlabel, which stores information about another object.
Inheritance HierarchyObject
HyperLabel
HyperLabel
Namespace: XSharp.VO.SDK
Assembly: XSharp.VOSystemClasses (in XSharp.VOSystemClasses.dll) Version: 2.21
SyntaxThe HyperLabel type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HyperLabel |
Construct a hyperlabel.
|
Properties| Name | Description | |
|---|---|---|
 | Caption |
A string representing the short name or caption by which the user refers to the host object (to which the hyperlabel is attached). For a menu command, this would be the text appearing in the menu itself.
|
| Description |
A string representing the purpose of the host object (to which the hyperlabel is attached). Typically, the system uses this as a prompt to the user or as a faster substitute for hypertext help.
|
| HelpContext |
A string representing the key or ID for the place in the hypertext system where the system looks for help concerning the host object (to which the hyperlabel is attached).
|
| Name |
A string representing the name of the host object to which the hyperlabel is attached.
|
| NameSym |
A symbol representing the name of the host object to which the hyperlabel is attached.
|
Functions| Name | Description | |
|---|---|---|
| AsString |
Return the caption of the hyperlabel.
|
| Error(Error) |
Provide a method for handling error conditions raised during hyperlabel processing.
|
| Error(Error, Symbol) |
Provide a method for handling error conditions raised during hyperlabel processing.
|
Remarks
The HyperLabel class stores prompts and instructions for context-sensitive help information about another object — the host object. The purpose of the class is to collect this kind of information in a standard way so that the various help systems (status, exception, and error management functions) within the system can process the hyperlabel without knowing anything about the host object, just as a mailing system routes packages without knowing their content.
Hyperlabels also record the symbolic name of the host. For example, the system uses this name to match fields with controls when linking a data window to a data source and, in the case of menu commands, to decide which method of the menu's owner to dispatch when the user commands that menu command to execute.
Individual database columns have hyperlabels, as do data types, data windows, controls, and menu commands. Objects delegate hyperlabels to one another. In fact a large part of good programming with X# consists in providing full and helpful hyperlabels. Much of the automatic behavior of the system depends for its progress on the quality of information in the hyperlabels.
It is called a hyperlabel because the system's hypertext help system navigates by hyperlabels.
 Tip |
|---|
| You first create a hyperlabel and then affix it to its host object by assigning to the host's hyperlabel pseudo-variable. |
See Also