`)
> Allows the control to be dragged as text.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Close
**Close**
> Removes the control from the page.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.ControlAt
**ControlAt**(index As `Integer`) As `WebControl`
> Returns the `WebControl` at the *index* passed.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Controls
**Controls** As `Iterable`
> Allows you to iterate through the controls on the layout.
>
>
>
>
>
> Note
>
>
>
> This does not include non-control object instances. For that, use the `Objects
` method.
>
>
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.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](https://www.ecma-international.org/ecma-262/6.0/).
>
> This code in the Pressed event of a Button displays an alert using JavaScript:
>
> ``` xojo
> Me.ExecuteJavaScript("alert('Hello!');")
> ```
>
> This code will select the text in a WebTextField (or WebTextArea):
>
> ``` xojo
> WebTextField1.ExecuteJavascript("document.getElementById('" + _
> WebTextField1.ControlID + "_inner').select();")
> ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.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:
>
> ``` xojo
> Me.GotoURL("http://www.wikipedia.org", True)
> ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Hide
**Hide**
> Hides the dialog box. The dialog box is still in memory and accessible via code.
>
> You can use this on a button click event to hide the dialog. If you hide a dialog with the Hide method, you can display it again by calling Show.
>
> Hide the dialog:
>
> ``` xojo
> Self.Hide
> ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.LastControlIndex
**LastControlIndex** As `Integer`
> The index of the last `WebControl` on the `WebView`.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Objects
**Objects** As `Iterable`
> Allows you to iterate through all the non-control object instances on the dialog.
>
>
>
>
>
> Note
>
>
>
> This does not include controls. For that, use the `Controls
` method.
>
>
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.RemoveControl
**RemoveControl**(control As `WebUIControl`)
> Removes the *control* from the WebView.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.SetFocus
**SetFocus**
> Sets the focus to the `Control`.
>
> This code checks for a required value when a button is pressed:
>
> ``` xojo
> If UserNameField.Text.IsEmpty Then
> MessageBox("Please enter your UserName.")
> UserNameField.SetFocus
> Return
> End If
> ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Show
**Show**
> Shows the dialog if it was not yet open or is just hidden.
>
> Show a dialog:
>
> ``` xojo
> MyDialog.Show
> ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Style
**Style** As `WebStyle`
**Style**(`Assigns` value As `WebStyle`)
> The `WebStyle` for the control.
>
> In the `Pressed` event of a `WebButton`, set the text to bold:
>
> ``` xojo
> Var style As New WebStyle
> style.Bold = True
> Me.Style = style
> ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.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.
>
> ``` xojo
> ProgressBar1.MaximumValue = SalesData.RowCount
> For Each row As DatabaseRow in SalesData
> AnalyzeSales(row)
> ProgressBar1.Value = ProgressBar1.Value + 1
> ProgressBar1.UpdateBrowser
> Next
> ```
## Event descriptions
forsearch
WebDialog.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`:
>
> ``` xojo
> 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:
>
> ``` xojo
> Select Case hitItem.Text
> Case "One"
> MessageBox("One")
> Case "Two"
> MessageBox("Two")
> Case "Three"
> MessageBox("Three")
> End Select
> ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Dismissed
**Dismissed**
> Called when the dialog is dismissed by calling its Hide or Close methods.
>
> Consider a dialog, MyDialog, which has a single button with this code in its Pressed event handler:
>
> ``` xojo
> Self.Close
> ```
>
> With this dialog dragged onto a web page, you can display it using this code (probably on the Pressed event handler of a button):
>
> ``` xojo
> MyDialog1.Show
> ```
>
> When the dialog is closed, the Dismissed event handler is called. This code displays a simple message to indicate it was closed:
>
> ``` xojo
> MessageBox("Dialog is closed.")
> ```
>
> In this event handler, you can also access properties of the dialog to check values that were entered or buttons that were pressed. For example, If there was a TextField on the dialog, you could get its value in the Dismissed event handler like this:
>
> ``` xojo
> Var text As String
> text = Me.TextField1.Text
> MessageBox("Text=" + text)
> ```
>
> Similarly, if your dialog has multiple buttons and you want to know which one was clicked, you will have to save that information into a property you can check. For example, you can add a *ButtonClicked As WebButton* property to the dialog. In an OK button (named *OKButton*), you then use this code to indicate that the OK button was pressed:
>
> ``` xojo
> ButtonClicked = Me
> Self.Close
> ```
>
> In a Cancel button (named *CancelButton*), you would use the same code:
>
> ``` xojo
> ButtonClicked = Me
> Self.Close
> ```
>
> Now when the dialog is closed, you can check the ButtonClicked property in the Dismissed event handler to see which button was used to close the dialog:
>
> ``` xojo
> Select Case Me.ButtonClicked
> Case Me.OKButton
> MessageBox("OK selected.")
> Case Me.CancelButton
> MessageBox("Cancel selected.")
> End Select
> ```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.DropObject
**DropObject**(obj As `WebDragItem`, action As `WebDragItem.DragActionTypes`, x As `Integer`, y As `Integer`)
> Called when a dragged item is over a control that can accept it. The dragged item is contained in *obj* and the type of drag is identified by *action*.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Hidden
**Hidden**
> The dialog is about to become no longer visible. This is usually because the Hide method has been called. However, it also could be because the page it is on is being closed, is being replaced as the foreground page by another page or because the dialog's Visible property has been set to `False`.
>
>
>
>
>
> Note
>
>
>
> This event is equivalent to the `DesktopWindow.Deactivated
` event in a desktop app.
>
>
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.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.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Overflowed
**Overflowed**(width As `Integer`, height As `Integer`)
> The area (in pixels) by which `WebContainers` have overflowed the bounds of a WebView whose `LayoutType` is set to `Flex`.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.Resized
**Resized**
> The `WebView` has been resized either because the user resized the browser window or the `WebView` was resized at runtime via code.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
WebDialog.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.
>
>
Note
Dynamically created Dialogs that are closed by calling Close cannot be shown again until you create a new instance.
## Sample code
Consider a dialog, MyDialog, which has a single button with this code in its Pressed event handler:
``` xojo
Self.Close
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
With this dialog dragged onto a web page, you can display it using this code (probably on the Pressed event handler of a button):
``` xojo
MyDialog1.Show
```
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
When the dialog is closed, the Dismissed event handler is called. This code displays a simple message to indicate it was closed:
``` xojo
MessageBox("Dialog is closed.")
```
## Compatibility
| | |
|-----------------------|-----|
| **Project Types** | Web |
| **Operating Systems** | All |
`WebView` parent class; `MessageBox`, `WebPage`, `WebHTMLViewer`, `DesktopWindow` classes.