Class
WebLink
Description
Create a clickable label that navigates to the specified URL when clicked.
Properties
Name |
Type |
Read-Only |
Shared |
---|---|---|---|
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
Methods
Name |
Parameters |
Returns |
Shared |
---|---|---|---|
Script As String |
|||
Events
Name |
Parameters |
Returns |
---|---|---|
hitItem As WebMenuItem |
||
Enumerations
WebLink.Appearances
Appearances
Provides two types of links: link and button.
Enum |
Description |
---|---|
Link |
The link appears as text. |
Button |
The link appears as a button. |
WebLink.Targets
Targets
The various ways in which the app will behave when the link is pressed.
Enum |
Description |
---|---|
Current |
The new page replaces the existing page inside the iframe. |
NewWindow |
The new page appears in a new window. |
Window |
The new page replaces the existing page. |
Parent |
The new page replaces the existing page with the parent iframe (assuming the iframe is nested within another iframe). |
Property descriptions
WebLink.Appearance
Appearance As Appearances
The appearance of the WebLink as a link or as a button.
WebLink.Bold
Bold As Boolean
If True, applies the bold style to the caption of the label.
The following code in the Opening event of the control sets the caption to bold.
Me.Bold = True
WebLink.ContextualMenu
ContextualMenu As WebMenuItem
If you assign a WebMenuItem to the control, it will be displayed when the user right-clicks the control.
On a WebPage, you can disable/remove the default contextual menu by an empty WebMenuItem class object to this property.
This code populates a contextual menu in the Shown event of the control.
Var menu As New WebMenuItem
menu.AddMenuItem("One")
menu.AddMenuItem("Two")
menu.AddMenuItem("Three")
Me.ContextualMenu = menu
The menu selection is then handled by the ContextualMenuSelected event when the user right-clicks on the control. For example, it can be of the form:
Select Case hitItem.Text
Case "One"
MessageBox("One")
Case "Two"
MessageBox("Two")
Case "Three"
MessageBox("Three")
End Select
WebLink.ControlID
ControlID As String
Identifies the control on a per session basis.
This property is read-only.
WebLink.Enabled
Enabled As Boolean
When True the WebControl is drawn enabled and responds to user action. When False, the control appears as disabled and does not respond to user actions.
In the case of WebTimer, when set to False this disables and stops the WebTimer. When set to True, it starts the WebTimer.
Disable a button when a check box value changes:
If AllowSaveCheckBox.Value Then
SaveButton.Enabled = True
Else
AllowSaveButton.Enabled = False
End If
WebLink.FontName
FontName As String
Name of the font used to display the value.
The fonts available are those on the user's device (computer, phone, tablet, etc.) or installed in their browser. If there is an exact match, that font will be used. If not, then a font from the same family will be used. For example, if you set the FontName to Helvetica Neue but that font was not available, a font from the Helvetica family would be used instead.
This code sets the FontName property.
Me.FontName = "Helvetica"
WebLink.FontSize
FontSize As Double
Point size of the font used to display value of the label.
If you enter zero as the FontSize, your app will use the font size that works best for the platform on which it is running.
This code sets the font size to 16 points.
Me.FontSize = 16
WebLink.Height
Height As Integer
The height (in pixels) of the control.
WebLink.Indicator
Indicator As Indicators
The color scheme for the control.
WebLink.Italic
Italic As Boolean
If True, applies the italic style to the caption of the label.
The following code in the Opening event of the control sets the caption to italic.
Me.Italic = True
WebLink.Left
Left As Integer
The position of the left side of the WebUIControl in pixels, relative to the web page.
WebLink.LockBottom
LockBottom As Boolean
Determines whether the bottom edge of the control should stay at a set distance from the bottom edge of the parent control, if there is one, or the owning web page.
WebLink.LockHorizontal
LockHorizontal As Boolean
LockHorizontal overrides LockLeft and LockRight. It allows you to proportionally lock a control's position to the center of its parent control (or web page).
For example, if you place a control in the center of the page and sets both LockHorizontal and LockVertical, the control will stay in the center of the page.
WebLink.LockLeft
LockLeft As Boolean
Determines whether the left edge of the control should stay at a set distance from the left edge of the parent control, if there is one, or the owning web page.
WebLink.LockRight
LockRight As Boolean
Determines whether the right edge of the control should stay at a set distance from the right edge of the parent control, if there is one, or the owning web page.
WebLink.LockVertical
LockVertical As Boolean
LockVertical overrides LockTop and LockBottom. It allows you to proportionally lock a control's position to keep it centered within the parent control or web page.
For example, if you place a control in the center of the page, and sets both LockHorizontal and LockVertical, the control will stay in the center of the page.
WebLink.Multiline
Multiline As Boolean
If True, the control accepts multiple lines of text and wraps the text to the right side of the control. If False, excess text extends off the right edge of the control.
If you want to display text that wraps to multiple lines, set the Multiline property to True:
Label1.Multiline = True
Label1.Text = "How much wood would a woodchuck chuck if a woodchuck could chuck wood?"
WebLink.Name
Name As String
The name of the control.
This property is read-only.
WebLink.PanelIndex
PanelIndex As Integer
If the control has been placed on a WebTabPanel or WebPagePanel control, this is the panel (page/tab) that the control is on. If the control is not on a panel, it returns -1.
The first panel is numbered zero. If the control has been placed on a panel of a WebTabPanel or WebPagePanel control, it returns the panel number. If the control is not on a WebPagePanel or WebTabPanel, it returns -1. If you change the PanelIndex to a nonexistent panel, the control will disappear until you give it a PanelIndex value that corresponds to a panel that exists.
If you are looking to change the currently selected panel (page/tab), use SelectedPanelIndex.
This code displays the panel index of the control that is on the page.
MessageBox(Me.SelectedPanelIndex.ToString)
WebLink.Page
Page As WebPage
Identifies the web page that contains the control.
This property is read-only.
WebLink.Parent
Parent As WebView
Used to get the control's parent control or page. If the parent control is a WebContainer, then it returns the WebContainer. If it is on a WebPage, it returns the WebPage.
This property is read-only.
WebLink.Style
Style As WebStyle
The WebStyle for the control.
In the Pressed event of a WebButton, set the text to bold:
Var style As New WebStyle
style.Bold = True
Me.Style = style
WebLink.TabIndex
TabIndex As Integer
The WebLink's control's position in the Tab Order. The control with a TabIndex of 0 is the first WebUIControl to get the focus when the page opens in the browser.
This example sets the control's TabIndex.
Me.TabIndex = 2
WebLink.Target
Target As Targets
Determines what the application will do when the link is clicked.
Specify the value of the Target property using the Properties pane.
WebLink.Text
Text As String
The text of the label.
WebLink.TextAlignment
TextAlignment As TextAlignments
The alignment of the Text as displayed in the control.
The following code in the Opening event of the control sets the text alignment to Center.
Me.TextAlignment = TextAlignments.Center
WebLink.TextColor
TextColor As ColorGroup
Gets or sets the color of the Text property. The default color is Blue.
The following example sets the TextColor.
Me.TextColor = Color.Red
WebLink.Tooltip
Tooltip As WebToolTip
Text of a message displayed as a tooltip.
The tip is displayed when the user places the mouse on the control and leaves it there.
This code in the Shown event of a Button sets the tooltip:
Me.Tooltip = "Save changes"
WebLink.Top
Top As Integer
The top of the control in local coordinates relative to the web page.
WebLink.Underline
Underline As Boolean
If True, applies the underline style to the Text displayed.
This code underlines the Text property.
Me.Underline = True
WebLink.URL
URL As String
The URL of the page to display when the link is clicked. If the URL does not include a protocol (like http:), the value will be appended to the URL.
To navigate to other pages in your app, use the WebPage.Show method.
If you want to display the page at the URL within your web app, use the WebHTMLViewer control.
Display wikipedia when the link is clicked:
Link1.URL = "http://www.wikipedia.org"
WebLink.Visible
Visible As Boolean
If True, the control is drawn. If False, it's not.
Hide a control based on a checkbox setting:
If ShowEmailCheckbox.Value Then
EmailField.Visible = True
Else
EmailField.Visible = False
End If
WebLink.Width
Width As Integer
The width (in pixels) of the web control.
This code in the Shown event handler increases the size of the control:
Me.Width = Me.Width + 50
Method descriptions
WebLink.Close
Close
Removes the control from the page.
WebLink.CSSClasses
CSSClasses
Returns the instance of WebCSSClasses for this control allowing you to add CSS classes to and remove CSS classes from the control.
WebLink.ExecuteJavaScript
ExecuteJavaScript(Script As String)
Executes the JavaScript passed. The JavaScript passed can call a JavaScript function in a WebPageSource control.
The Xojo web framework uses EcmaScript 6 which is more strict than previous versions of JavaScript. For more details, see the EcmaScript 6 documentation.
This code in the Pressed event of a Button displays an alert using JavaScript:
Me.ExecuteJavaScript("alert('Hello!');")
This code will select the text in a WebTextField (or WebTextArea):
WebTextField1.ExecuteJavascript("document.getElementById('" + _
WebTextField1.ControlID + "_inner').select();")
WebLink.GotoURL
GotoURL(Url As String, inNewWindow As Boolean = False)
Opens the passed URL in place of the current web page or downloads a file. If InNewWindow is True, the browser is asked to open the URL in a new window.
If the browser has popup windows disabled and InNewWindow is True, the method silently fails and the page is not shown.
If InNewWindow is False, the running web app is replaced with the specified URL. If you want to display an external web site within your web app, use the WebHTMLViewer control.
Display a web site in a new popup window:
Me.GotoURL("http://www.wikipedia.org", True)
WebLink.SetFocus
SetFocus
Sets the focus to the Control.
This code checks for a required value when a button is pressed:
If UserNameField.Text.IsEmpty Then
MessageBox("Please enter your UserName.")
UserNameField.SetFocus
Return
End If
WebLink.UpdateBrowser
UpdateBrowser
Forces the current values of the control to be sent to the browser.
This method is useful when you are computing values in a loop and wish to update the browser immediately rather than wait until the current method ends.
This code iterates through a RowSet of database rows, updates a ProgressBar and then forces the updated ProgressBar to be sent to the browser via UpdateBrowser.
ProgressBar1.MaximumValue = SalesData.RowCount
For Each row As DatabaseRow in SalesData
AnalyzeSales(row)
ProgressBar1.Value = ProgressBar1.Value + 1
ProgressBar1.UpdateBrowser
Next
Event descriptions
WebLink.Closed
Closed
The control has been removed from the browser either because the page has closed or the control's Close method was called.
WebLink.ContextualMenuSelected
ContextualMenuSelected(hitItem As WebMenuItem)
Called when a contextual menu item is selected. This selected item is contained in hitItem.
This code populates a contextual menu in the Opening event of a WebToolbar:
Var menu As New WebMenuItem
menu.AddMenuItem("One")
menu.AddMenuItem("Two")
menu.AddMenuItem("Three")
Me.ContextualMenu = menu
The menu selection is then handled by the ContextualMenuSelected event when the user right-clicks on the control. For example, it can be of the form:
Select Case hitItem.Text
Case "One"
MessageBox("One")
Case "Two"
MessageBox("Two")
Case "Three"
MessageBox("Three")
End Select
WebLink.Hidden
Hidden
The control is about to become no longer visible. This could be because the page is being closed, is being replaced as the foreground page by another page or because the control or a parent control's Visible property has been set to False.
The event is similar to the Window.Deactivate event in a desktop app.
WebLink.Opening
Opening
The control has been created and the page is opening but has not been sent to the browser yet.
The Opening event handler can be used to initialize non-visual properties and settings for controls.
In most cases, you should use the Shown event to initialize controls.
WebLink.Shown
Shown
The control has appeared on the currently displayed page. This could be because its parent page just finished loading, its parent page has come to the foreground or the control is now visible having been previously invisible because it or its parent control's Visible property has been set to True.
Use the Shown event for initializing your controls or doing anything that would interact with other controls or user interface elements on the web page instead of the Opening event.
Note
This event is the web equivalent to the DesktopWindow.Activated event.
This code in the Shown event of a WebListBox adds 2 rows with 3 columns:
Me.RemoveAllRows
Me.AddRow("Row 1", "Bob", "Roberts")
Me.AddRow("Row 2", "Barb", "Reynolds")
This example sets the text of a label:
If Session.LoggedIn Then
Me.Text = "Welcome!"
Else
Me.Text = "Welcome, " + Session.UserName
End If
Notes
Pressing the WebLink navigates to the specified URL, exiting the web application. If you want to display the page at the URL within your web app, you should use a WebHTMLViewer instead.
You can use the Target property to have the URL open in another browser window or tab.
To navigate to other pages within your app, use the WebPage.Show method. See URL.
Sample code
Specify the URL for a WebLink to navigate to Wikipedia:
Link1.URL = "http://www.wikipedia.org"
Compatibility
Web projects on all supported operating systems.
See also
WebLabel parent class; WebControl, WebLabel, WebHTMLViewer classes.