Class # WebSegmentedButton --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description A control that is a horizontal button made up of multiple segments. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |-----------------------------------------------------------------|-------------------------------------------------------|-----------|--------| | `ContextualMenu` | `WebMenuItem` | | | | `ControlID` | `String` | ✓ | | | `Enabled` | `Boolean` | | | | `Height` | `Integer` | | | | `Indicator` | `Indicators` | | | | `LastSegmentIndex` | `Integer` | | | | `Left` | `Integer` | | | | `LockBottom` | `Boolean` | | | | `LockHorizontal` | `Boolean` | | | | `LockLeft` | `Boolean` | | | | `LockRight` | `Boolean` | | | | `LockTop` | `Boolean` | | | | `LockVertical` | `Boolean` | | | | `Name` | `String` | ✓ | | | `Outlined` | `Boolean` | | | | `Page` | `WebPage` | ✓ | | | `PanelIndex` | `Integer` | | | | `Parent` | `WebView` | ✓ | | | `SegmentCount` | `Integer` | ✓ | | | `SelectedSegment` | `WebSegment` | | | | `SelectedSegmentIndex` | `Integer` | | | | `SelectionStyle` | `SelectionStyles` | | | | `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` | | | | `AddSegment` | item As `WebSegment` | | | | `AddSegmentAt` | index As `Integer`, item As `WebSegment` | | | | `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` | | | | | `CSSClasses` | | `WebCSSClasses` | | | `ExecuteJavaScript` | script As `String` | | | | `GotoURL` | url As `String`, inNewWindow As `Boolean` = `False` | | | | `RemoveAllSegments` | | | | | `RemoveSegmentAt` | index As `Integer` | | | | `SegmentAt` | index As `Integer` | `WebSegment` | | | `SelectedCount` | | `Integer` | | | `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` | | | | `Pressed` | segmentIndex As `Integer` | | | `Shown` | | | ## Enumerations

forsearch

WebSegmentedButton.SelectionStyles ### SelectionStyles > Defines the number of segments that can be selected (none, single or multiple). > > | Enum | Description | > |----------|---------------------------------------------| > | Multiple | Any number of segments can be selected. | > | None | No segments can be selected. | > | Single | Only one segment at a time can be selected. | ## Property descriptions

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

forsearch

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

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

forsearch

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

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

forsearch

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

forsearch

WebSegmentedButton.LastSegmentIndex **LastSegmentIndex** As `Integer` > The index of the last segment in the button.

forsearch

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

forsearch

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

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

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

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

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

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

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

forsearch

WebSegmentedButton.Outlined **Outlined** As `Boolean` > If `True` the control will appear in outlined style.

forsearch

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

forsearch

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

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

WebSegmentedButton.SegmentCount **SegmentCount** As `Integer` > The number of segments in the control. > > This property is read-only.

forsearch

WebSegmentedButton.SelectedSegment **SelectedSegment** As `WebSegment` > The WebSegment representing the segment that is selected.

forsearch

WebSegmentedButton.SelectedSegmentIndex **SelectedSegmentIndex** As `Integer` > The index of the selected segment.

forsearch

WebSegmentedButton.SelectionStyle **SelectionStyle** As `SelectionStyles` > Defines the number of segments that can be selected: none, single or multiple. > > The default is single.

forsearch

WebSegmentedButton.TabIndex **TabIndex** As `Integer` > The **WebSegmentedButton'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

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

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

forsearch

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

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

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

forsearch

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

forsearch

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

forsearch

WebSegmentedButton.AddSegment **AddSegment**(item As `WebSegment`) > Adds *Segment* as a new segment at the end of the control. > > The following example in the `Opening` event of the control adds a segment to it: > > ``` xojo > Var seg As New WebSegment("Banana") > Me.AddSegment(seg) > ```

forsearch

WebSegmentedButton.AddSegmentAt **AddSegmentAt**(index As `Integer`, item As `WebSegment`) > Creates a new segment at *index* (moving the existing segments over). > > The following example adds a segment at the 4th position. > > ``` xojo > Var s As New WebSegment("Harry") > SegmentedButton1.AddSegmentAt(3, s) > ```

forsearch

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

forsearch

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

forsearch

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

forsearch

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

forsearch

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

forsearch

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

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

WebSegmentedButton.RemoveAllSegments **RemoveAllSegments** > Removes all segments in the control. > > The following example (in any event of a WebSegmentedButton removes all the existing segments: > > ``` xojo > Me.RemoveAllSegments > ```

forsearch

WebSegmentedButton.RemoveSegmentAt **RemoveSegmentAt**(index As `Integer`) > Removes the specified segment. The first segment is numbered zero. > > When in any event of a segmented control, the following example removes the third segment (index position 2) from the segmented control: > > ``` xojo > Me.RemoveSegmentAt(2) > ```

forsearch

WebSegmentedButton.SegmentAt **SegmentAt**(index As `Integer`) As `WebSegment` > The `WebSegment` representing the *segment* at the index passed.

forsearch

WebSegmentedButton.SelectedCount **SelectedCount** As `Integer` > The number of segments selected.

forsearch

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

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

forsearch

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

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

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

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

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

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

WebSegmentedButton.Pressed **Pressed**(segmentIndex As `Integer`) > One of the segments of the control has been pressed.

forsearch

WebSegmentedButton.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 in the `Pressed` event handler checks to see which segment was selected: ``` xojo Select Case SegmentIndex Case 0 ' First segment MessageBox("First Segment") Case 1 ' Second segment MessageBox("Second segment") End Select ``` ## Compatibility | | | |-----------------------|-----| | **Project Types** | Web | | **Operating Systems** | All |

`WebUIControl` parent class; `WebSegment` class, `DesktopSegmentedButton` control