HyperLabel Constructor | |
Construct a hyperlabel.
Namespace:
VO
Assembly:
VOSystemClasses (in VOSystemClasses.dll) Version: 2.19
Syntax CONSTRUCTOR(
uName,
uCaption,
uDescription,
uHelpContext
) CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public HyperLabel(
Usual uName = default,
Usual uCaption = default,
Usual uDescription = default,
Usual uHelpContext = default
)
Request Example
View SourceParameters
- uName (Optional)
- Type: Usual
The symbolic name that the program uses to refer to the object to which the hyperlabel attaches. For example, if the hyperlabel attaches to a menu command, the symbolic name is the method (of the window that owns the menu) that the system invokes when the user executes that menu command. If the hyperlabel attaches to a field, the symbol is the field's name. In other words, the symbolic name is only useful to the program. The other items, by contrast, are meaningful to the user. - uCaption (Optional)
- Type: Usual
The name of the object to which the hyperlabel attaches, as recognized by the user. If the object is a control, the caption is the name shown beside, or on, the control. If you supply the resource ID of a string, HyperLabel:Init() extracts the string. if not specified, the default is the same as symName, if provided; otherwise, NULL_STRING.
- uDescription (Optional)
- Type: Usual
The purpose of the host object. For a control, the purpose tells the user what the control is for. By default, when a control gets focus, the system displays the control's hyperlabel's description upon the status bar. Similarly, when the user drags the mouse across the menu, each time a new command is highlighted, its hyperlabel's description appears in the status bar. If you supply the resource ID of a string, HyperLabel:Init() extracts the string. If not specified, the default is NULL_STRING. - uHelpContext (Optional)
- Type: Usual
The string that uniquely identifies the place to jump in the hypertext help system. In the case of Windows, this is just the context name. The system uses the object's hyperlabel's help context to decide where to jump when the user asks for in-context help about the host object. If you supply the resource ID of a string, HyperLabel:Init() extracts the string. If not specified, the default is NULL_STRING.
See Also