Class # WebView --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description The super class for all other classes that can contain objects. `WebPage`, `WebDialog`, `WebContainer`, `WebRectangle`, `WebPagePanel` and `WebTabPanel` are all WebViews. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |--------------------------------------------|----------------------------------------------------|-----------|--------| | `ContextualMenu` | `WebMenuItem` | | | | `ControlCount` | `Integer` | ✓ | | | `ControlID` | `String` | ✓ | | | `Enabled` | `Boolean` | | | | `Height` | `Integer` | | | | `Indicator` | `Indicators` | | | | `LayoutDirection` | `LayoutDirections` | | | | `LayoutType` | `LayoutTypes` | | | | `Left` | `Integer` | | | | `LockBottom` | `Boolean` | | | | `LockHorizontal` | `Boolean` | | | | `LockLeft` | `Boolean` | | | | `LockRight` | `Boolean` | | | | `LockTop` | `Boolean` | | | | `LockVertical` | `Boolean` | | | | `Name` | `String` | ✓ | | | `Page` | `WebPage` | ✓ | | | `Parent` | `WebControl` | ✓ | | | `TabIndex` | `Integer` | | | | `Tooltip` | `WebToolTip` | | | | `Top` | `Integer` | | | | `Visible` | `Boolean` | | | | `Width` | `Integer` | | | ## Methods

table-centered_column_4

| Name | Parameters | Returns | Shared | |------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|--------| | `AcceptPictureDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AcceptRawDataDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AcceptTextDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AddControl` | child As `WebControl` | | | | `AllowPictureDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AllowRawDataDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AllowTextDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `Close` | | | | | `ControlAt` | index As `Integer` | `WebControl` | | | `Controls` | | `Iterable` | | | `ExecuteJavaScript` | script As `String` | | | | `GotoURL` | url As `String`, inNewWindow As `Boolean` = `False` | | | | `LastControlIndex` | | `Integer` | | | `Objects` | | `Iterable` | | | `RemoveControl` | control As `WebUIControl` | | | | `SetFocus` | | | | | `Style` | | `WebStyle` | | | | `Assigns` style As `WebStyle` | | | | `UpdateBrowser` | | | | ## Events

table-centered_column_4

| Name | Parameters | Returns | |----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| | `Closed` | | | | `ContextualMenuSelected` | hitItem As `WebMenuItem` | | | `DropObject` | obj As `WebDragItem`, action As `WebDragItem.DragActionTypes`, x As `Integer`, y As `Integer` | | | `Hidden` | | | | `Opening` | | | | `Overflowed` | width As `Integer`, height As `Integer` | | | `Resized` | | | | `Shown` | | | ## Enumerations

forsearch

WebView.LayoutDirections ### LayoutDirections > The various directions in which WebContainerControls can wrap when added at runtime to a WebView whose LayoutType is set to Flex. > > | Enum | Description | > |-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| > | BottomToTop | The containers will be laid out starting in the bottom-left corner with each new one above the previous until no more will fit. Subsequent columns will be added to the right of the previous one. | > | LeftToRight | The containers will be laid out starting in the top-left corner with each new one to the right of the previous until no more will fit. Subsequent rows will be added to below the previous one. | > | RightToLeft | The containers will be laid out starting in the top-right corner with each new one to the left of the previous until no more will fit. Subsequent rows will be added to below the previous one. | > | TopToBottom | The containers will be laid out starting in the top-left corner with each new one below the previous until no more will fit. Subsequent columns will be added to the right of the previous one. |

forsearch

WebView.LayoutTypes ### LayoutTypes > The types of layouts for a WebView (Fixed or Flow). > > | Enum | Description | > |-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| > | Fixed | The position is based upon the `Left` and `Top` properties of the `WebContainer`. | > | Flex | The position is based upon both the order in which the `WebContainer` was added and the layout's `LayoutDirection`. | ## Property descriptions

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

WebView.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. > > ``` 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

WebView.ControlCount **ControlCount** As `Integer` > The number of controls on the `WebContainer`, `WebDialog` or `WebPage`. > > This property is read-only.

forsearch

WebView.ControlID **ControlID** As `String` > Identifies the control on a per session basis. > > This property is read-only.

forsearch

WebView.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: > > ``` xojo > If AllowSaveCheckBox.Value Then > SaveButton.Enabled = True > Else > AllowSaveButton.Enabled = False > End If > ```

forsearch

WebView.Height **Height** As `Integer` > The height (in pixels) of the control.

forsearch

WebView.Indicator **Indicator** As `Indicators` > The color scheme for the control.

forsearch

WebView.LayoutDirection **LayoutDirection** As `LayoutDirections` > The direction in which `WebContainer controls` will flow when added at runtime to a layout whose `LayoutType` is set to Flex.

forsearch

WebView.LayoutType **LayoutType** As `LayoutTypes` > The type of layout dictates whether controls are positioned at fixed locations or can move to accommodate changes to the bounds of the WebView, in the latter case, only for `WebContainer controls` that are added at runtime to a layout whose type is set to Flex.

forsearch

WebView.Left **Left** As `Integer` > The position of the left side of the **WebUIControl** in pixels, relative to the web page.

forsearch

WebView.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.

forsearch

WebView.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.

forsearch

WebView.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.

forsearch

WebView.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.

forsearch

WebView.LockTop **LockTop** As `Boolean` > Determines whether the top edge of the control should stay at a set distance from the top edge of the parent control, if there is one, or the owning web page.

forsearch

WebView.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.

forsearch

WebView.Name **Name** As `String` > The name of the control. > > This property is read-only.

forsearch

WebView.Page **Page** As `WebPage` > Identifies the web page that contains the control. > > This property is read-only.

forsearch

WebView.Parent **Parent** As `WebControl` > 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.

forsearch

WebView.TabIndex **TabIndex** As `Integer` > The **WebUIControl'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. > > ``` xojo > Me.TabIndex = 2 > ```

forsearch

WebView.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: > > ``` xojo > Me.Tooltip = "Save changes" > ```

forsearch

WebView.Top **Top** As `Integer` > The top of the control in local coordinates relative to the web page.

forsearch

WebView.Visible **Visible** As `Boolean` > If `True`, the control is drawn. If `False`, it's not. > > Hide a control based on a checkbox setting: > > ``` xojo > If ShowEmailCheckbox.Value Then > EmailField.Visible = True > Else > EmailField.Visible = False > End If > ```

forsearch

WebView.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: > > ``` xojo > Me.Width = Me.Width + 50 > ``` ## Method descriptions

forsearch

WebView.AcceptPictureDrop **AcceptPictureDrop**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to accept a picture drop of a `WebDragItem`.

forsearch

WebView.AcceptRawDataDrop **AcceptRawDataDrop**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to accept a raw data drop of a `WebDragItem`.

forsearch

WebView.AcceptTextDrop **AcceptTextDrop**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to accept a picture drop of a `WebDragItem`.

forsearch

WebView.AddControl **AddControl**(child As `WebControl`) > Adds the passed `Control` to the WebView. > > This code adds a `WebTextField` to the page: > > ``` xojo > Var tf As New WebTextField > tf.Left = 100 > tf.Top = 50 > tf.Enabled = True > Self.AddControl(tf) > ```

forsearch

WebView.AllowPictureDrag **AllowPictureDrag**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to be dragged as a picture.

forsearch

WebView.AllowRawDataDrag **AllowRawDataDrag**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to be dragged as raw data.

forsearch

WebView.AllowTextDrag **AllowTextDrag**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to be dragged as text.

forsearch

WebView.Close **Close** > Removes the control from the page.

forsearch

WebView.ControlAt **ControlAt**(index As `Integer`) As `WebControl` > Returns the `WebControl` at the *index* passed.

forsearch

WebView.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. > >

> > This example counts the number of controls on the current page by iterating through them. > > ``` xojo > Var count As Integer > For Each cntrl As WebUIControl In Self.Controls > count = count + 1 > Next > MessageBox("This page has " + count.ToString + " controls.") > ``` > > This example clears all checkboxes on the page: > > ``` xojo > For Each cntrl As WebUIControl In Self.Controls > If cntrl IsA WebCheckBox Then WebCheckBox(cntrl).Value = False > Next > ```

forsearch

WebView.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

WebView.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

WebView.LastControlIndex **LastControlIndex** As `Integer` > The index of the last `WebControl` on the WebView.

forsearch

WebView.Objects **Objects** As `Iterable` > Allows you to iterate through all the non-control object instances on the `WebPage`, `WebContainer` or `WebDialog`. > >

> >

> > Note > >

> > This does not include controls. For that, use the `Controls` method. > >

forsearch

WebView.RemoveControl **RemoveControl**(control As `WebUIControl`) > Removes the *control* from the WebView.

forsearch

WebView.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

WebView.Style **Style** As `WebStyle` > Returns the `WebStyle` for the webview. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **Style**(`Assigns` style As `WebStyle`) > Assigns the *style* to the webview. > > In this example, in any event of the webview, set the text to bold: > > ``` xojo > Var style As New WebStyle > style.Bold = True > Me.Style = style > ```

forsearch

WebView.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

WebView.Closed **Closed** > The control has been removed from the browser either because the page has closed or the control's Close method was called.

forsearch

WebView.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

WebView.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

WebView.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`. > >

> >

> > Note > >

> > This event is equivalent to the `DesktopWindow.Deactivated` event in a desktop app. > >

forsearch

WebView.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

WebView.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

WebView.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

WebView.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: > > ``` xojo > Me.RemoveAllRows > Me.AddRow("Row 1", "Bob", "Roberts") > Me.AddRow("Row 2", "Barb", "Reynolds") > ``` > > This example sets the text of a label: > > ``` xojo > If Session.LoggedIn Then > Me.Text = "Welcome!" > Else > Me.Text = "Welcome, " + Session.UserName > End If > ``` ## Sample code This code adds a `WebTextField` to the page: ``` xojo Var tf As New WebTextField tf.Left = 100 tf.Top = 50 tf.Enabled = True Self.AddControl(tf) ``` ## Compatibility | | | |-----------------------|-----| | **Project Types** | Web | | **Operating Systems** | All |

`WebUIControl` parent class; `WebPage`, `WebDialog`, `WebContainer`, `WebRectangle`, `WebPagePanel` and `WebTabPanel` classes.