HyperLink Class |  |
Create a HyperLink control.
Inheritance HierarchyNamespace: VO
Assembly: VOGUIClasses (in VOGUIClasses.dll) Version: 2.21
SyntaxThe HyperLink type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Background |
The brush used for painting the background of the control. For example, in a single line edit control, the background is the color behind the text in the edit control.
(Inherited from Control.) |
| Caption |
The string representing the caption of the text control.
(Inherited from TextControl.) |
| ContextMenu |
A menu object representing the local pop-up menu for a control.
(Inherited from Control.) |
| ControlFont |
The font used to draw the text in the control.
(Inherited from TextControl.) |
| ControlID |
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.) |
| CurrentText |
A string representing the text currently displayed in a text control. For edit controls, including the edit box associated with simple and drop-down combo boxes, it contains the text currently appearing in the edit box. For fixed icon and group box controls, TextControl:CurrentText contains NULL_STRING.
(Inherited from TextControl.) |
| FieldSpec |
The field specification connected to the control.
(Inherited from Control.) |
| HyperLabel |
The hyperlabel connected to the control.
(Inherited from Control.) |
| Length |
A numeric value representing the number of characters in the control.
(Inherited from TextControl.) |
| Margin | (Inherited from FixedText.) |
| Modified |
A logical value that is set to TRUE when a standard edit control or editable combo box is in the process of being modified.
(Inherited from Control.) |
| Name |
A string representing the name of the control.
(Inherited from Control.) |
| NameSym |
A symbol representing the name of the control.
(Inherited from Control.) |
| Origin |
A point representing the location of a control on its owner window, in canvas coordinates.
(Inherited from Control.) |
| Owner |
The owner window of a control.
(Inherited from Control.) |
| OwnerAlignment |
Constant representing how the window will be aligned within its owner window.
(Inherited from Control.) |
| ReadOnly |
Is the control readonly ?
(Inherited from Control.) |
| Server |
The server object that currently connected to this control. If no server is connected, the value is NIL.
(Inherited from Control.) |
| Size |
A dimension representing the size of a control.
(Inherited from Control.) |
| Status |
A hyperlabel indicating the status of the control after a validation attempt or other action.
(Inherited from Control.) |
| TextColor |
The color used to draw the text in the control. (Refer to the Color:Init() method for details on specifying a color object.)
(Inherited from TextControl.) |
| TextValue |
A string representing the value held in the control.
(Inherited from TextControl.) |
| ToolTipText |
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.) |
| UseHLForToolTip |
Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text.
(Inherited from Control.) |
 | Value |
The value held in the control, in whatever data type the control holds.
(Inherited from Control.) |
| ValueChanged |
A logical value representing whether the control's Value has been changed from its prior setting.
(Inherited from Control.) |
Methods| Name | Description | |
|---|---|---|
 | Activate |
Provide a method that is invoked when the control has focus and a window is activated. (Inherited from Control.) |
| AsString |
Return the contents of the control (or its identifying label).
(Inherited from Control.) |
| Create |
Creates the underlying Win32 control
(Inherited from TextControl.) |
| Deactivate |
Provide a method that is invoked when the control has focus and a window is deactivated. (Inherited from Control.) |
| DEFAULT | Call the default windows procedure for a control and set the EventReturnValue. (Inherited from Control.) |
| Destroy |
Provide a method to de-instantiate any TextControl.Destroy object.
(Inherited from TextControl.) |
| Disable |
Disable a control (until a subsequent call to Control:Enable()).
(Inherited from Control.) |
| DisableTheme |
Disable the WinXP theme for a control.
(Inherited from Control.) |
| Dispatch |
Provide the prototype dispatcher for events within the system when the control has focus; routing various events to their appropriate event handlers. (Overrides Dispatch(Usual).) |
| Enable |
Enable a control that was previously disabled.
(Inherited from Control.) |
| Expose |
Provide a method that is invoked when the control has focus and whenever part of the window needs repainting. (Inherited from Control.) |
| FocusChange |
Provide a method that is invoked when the control has focus and the input focus changes from the current control to another (or vice versa). (Inherited from Control.) |
| Font |
Change the current font of the text control.
(Inherited from TextControl.) |
| GetExStyle |
Retrieve the Ex styles for the control.
(Inherited from Control.) |
| GetStyle |
Retrieve the styles for the control.
(Inherited from Control.) |
| Handle |
Return the handle for a control.
(Inherited from Control.) |
| HasBorder | Check if a border has been set for the control (Inherited from Control.) |
| HasStyle | Check if a style value has been set for the control (Inherited from Control.) |
| Hide |
Hide a control so it is not visible (until a subsequent call to Control:Show()).
(Inherited from Control.) |
| HorizontalScroll |
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled. (Inherited from Control.) |
| Ime |
Return and optionally set whether Input Method Editor is enabled for this text control.
(Inherited from TextControl.) |
| IsEnabled |
Report if this control is currently enabled.
(Inherited from Control.) |
| IsExStyle | Check if a exstyle value has been set for the control (Inherited from Control.) |
| IsReadOnly |
Report if this control is currently readonly.
(Inherited from Control.) |
| IsStyle | Check if a style value has been set for the control (Inherited from Control.) |
| IsVisible |
Report if this control is visible (completely or partially) or hidden.
(Inherited from Control.) |
| KeyDown |
Provide a method that is invoked when the control has focus and a key on the keyboard is pressed. (Inherited from Control.) |
| KeyUp |
Provide a method that is invoked when the control has focus and a key on the keyboard is released. (Inherited from Control.) |
| LinkDF |
Connect a control to a data field in a data server.
(Inherited from Control.) |
| MenuInit |
Provide a method that is invoked when a pop-up menu owned by the control is about to pop up.
(Inherited from Control.) |
| MenuSelect |
Provide a method that is invoked when an item on a menu owned by the control is highlighted.
(Inherited from Control.) |
| MouseButtonDoubleClick |
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is double-clicked. (Inherited from Control.) |
| MouseButtonDown |
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is clicked. (Inherited from Control.) |
| MouseButtonUp |
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is released.
(Inherited from Control.) |
| MouseDrag |
Provide a method that is invoked when the control has focus and a mouse with one or more buttons clicked is moved in the window.
(Inherited from Control.) |
| MouseMove |
Provide a method that is invoked when the control has focus and the mouse is moved in the control.
(Inherited from Control.) |
| Move |
Provide a method that is invoked when the control has focus and the control is moved (either by the user or by the application).
(Inherited from Control.) |
| OpenLink |
Is the method that is invoked whenever the mouse is clicked over the HyperLink control.
|
| OverRide | This is a compatibility method that is no longer used or needed. (Inherited from Control.) |
| PerformValidations |
Perform all the validations defined to this control's field specification (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test.
(Inherited from Control.) |
| RegisterTimer |
Register a timer method to be invoked for the control.
(Inherited from Control.) |
| RemoveEditBalloonTip |
Removes the current BallonTip from the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| RePaint |
Send an ExposeEvent to repaint the control
(Inherited from Control.) |
| Resize |
Provide a method that is invoked when the control has focus and the control changes size.
(Inherited from Control.) |
| RestoreUpdate |
Resume all drawing updates for a control (after Control:SuspendUpdate() is called).
(Inherited from Control.) |
| SetCueBanner |
Add a cue banner to the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| SetDrawStyle |
Set the alignment style for the text in a FixedText object.
(Inherited from FixedText.) |
| SetExStyle |
Set the exstyle for the control.
(Inherited from Control.) |
| SetFocus |
Pass input focus to a control, thereby directing all mouse and keyboard input to the control.
(Inherited from Control.) |
| SetParent |
Change the parent handle for the control.
(Inherited from Control.) |
| SetStandardStyle |
Set the alignment style for the text in a FixedText object.
(Inherited from FixedText.) |
| SetStyle |
Set the style for the control.
(Inherited from Control.) |
| Show |
Display a control so it is visible.
(Inherited from Control.) |
| ShowEditBalloonTip |
Add a BallonTip to the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| SuspendUpdate |
Temporarily suspend all drawing updates for a control; drawing resumes with a call to Control:RestoreUpdate().
(Inherited from Control.) |
| Timer |
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Control.) |
| ValidateControl | This method validates if the control has been created and when not then it triggers the control creation (Inherited from Control.) |
| VerticalScroll |
Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled.
(Inherited from Control.) |
Fields| Name | Description | |
|---|---|---|
 | EventReturnValue | (Inherited from Control.) |
| lDrawThemeBackground | (Inherited from FixedText.) |
| lUseDrawText | (Inherited from FixedText.) |
| oCargo | Cargo slot. (Inherited from VObject.) |
Remarks
The intention of this class is that the text would appear as a HyperLink to a www address or as an @ email address and therefore the cursor will appear as the normal hand.
When the control is clicked on, it will attempt to "open" the text of the control using the OpenLink callback method. If the text is a www address it will open the default browser and attempt to navigate to the address. If the text contains an @ it will be taken as an email address and open the default email client.
 Tip |
|---|
| The difference between the HyperLink and the SysLink classes is in the way that the text is used. In a HyperLink control, ALL of the text is passed as the hyperlink where as in the SysLink control you can mix display text and hyperlink text. Also, in the HyperLink control, ALL of the displayed text is passed through to the ShellExecute method and you must make sure that there is nothing in it which could cause this to fail. |
ExamplesX#
1oFont1 := Font{,8,"Microsoft Sans Serif"} 2oFont1:Underline := TRUE 3oHL1 := HyperLink{ SELF, -1, Point{190, 25 }, ; 4Dimension{0, 0 }, "http://www.grafxsoft.com" } 5oHL1:font := oFont1 6oHL1:size := Dimension{150,20} 7oHL1:textcolor := Color{ COLORBLUE } 8oHL1:font:underline := TRUE 9oHL1:Show( )
See Also