Class # WebSeparator

forsearch

Separator --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description Used to add a separator to a web page. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |-----------------------------------------------|----------------------------------------------------|-----------|--------| | `ContextualMenu` | `WebMenuItem` | | | | `ControlID` | `String` | ✓ | | | `Enabled` | `Boolean` | | | | `Height` | `Integer` | | | | `Indicator` | `WebUIControl.Indicators` | | | | `Left` | `Integer` | | | | `LockBottom` | `Boolean` | | | | `LockHorizontal` | `Boolean` | | | | `LockLeft` | `Boolean` | | | | `LockRight` | `Boolean` | | | | `LockTop` | `Boolean` | | | | `LockVertical` | `Boolean` | | | | `Name` | `String` | | | | `Page` | `WebPage` | ✓ | | | `PanelIndex` | `Integer` | | | | `Parent` | `WebView` | ✓ | | | `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` | | | | `AcceptRawDataDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes` | | | | `AcceptTextDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes` | | | | `AllowPictureDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes` | | | | `AllowRawDataDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes` | | | | `AllowTextDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes` | | | | `Close` | | | | | `CSSClasses` | | `WebCSSClasses` | | | `ExecuteJavaScript` | script As `String` | | | | `GotoURL` | url As `String`, inNewWindow As `Boolean` = `False` | | | | `SetFocus` | | | | | `Style` | | `WebStyle` | | | | `Assigns` value 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` | | | | `Shown` | | | ## Enumerations

forsearch

WebSeparator.Indicators ### Indicators > Specifies the color scheme for the control. > > | Name | > |-----------| > | Default | > | Primary | > | Secondary | > | Success | > | Danger | > | Warning | > | Info | > | Light | > | Dark | > | Link | ## Property descriptions

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

forsearch

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

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

forsearch

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

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

forsearch

WebSeparator.Indicator **Indicator** As `WebUIControl.Indicators` > The color scheme for the control. > > This example sets the indicator of the button to Danger: > > ``` xojo > Button1.Indicator = WebUIControl.Indicators.Danger > ```

forsearch

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

forsearch

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

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

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

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

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

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

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

forsearch

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

forsearch

WebSeparator.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. > > ``` xojo > MessageBox(Me.SelectedPanelIndex.ToString) > ```

forsearch

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

forsearch

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

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

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

forsearch

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

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

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

forsearch

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

forsearch

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

forsearch

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

forsearch

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

forsearch

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

forsearch

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

forsearch

WebSeparator.CSSClasses **CSSClasses** As `WebCSSClasses` > Returns the instance of `WebCSSClasses` for this control allowing you to add CSS classes to and remove CSS classes from the control.

forsearch

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

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

WebSeparator.SetFocus **SetFocus** > If the control is enabled, this method sets the focus to the WebUIControl. > > 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

WebSeparator.Style **Style** As `WebStyle` > Returns the `WebStyle` for the control. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **Style**(`Assigns` value As `WebStyle`) > Assigns the *style* to 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

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

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

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

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

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

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

WebSeparator.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 > ``` ## Notes If the width is greater than the height, the separator is horizontal; otherwise it is vertical. In either case, the smaller value controls the thickness of the WebSeparator, not the thickness of the visible line in the center of the control. ## Compatibility | | | |-----------------------|-----| | **Project Types** | Web | | **Operating Systems** | All |

`WebUIControl` parent class