Class # WebSDKUIControl --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description WebSDKUIControl is a direct subclass of `WebUIControl`, but because `WebUIControl` inherits from `WebControl` it means that WebSDKUIControl doesn't actually have a direct relationship with WebSDKControl. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |--------------------------------------------------|----------------------------------------------------|-----------|--------| | `ContextualMenu` | `WebMenuItem` | | | | `ControlID` | `String` | ✓ | | | `Enabled` | `Boolean` | | | | `Height` | `Integer` | | | | `Indicator` | `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.All` | | | | `AcceptRawDataDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AcceptTextDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AllowPictureDrag` | allowedDragActionTypes As `WebDragItem.DragActionTypes` | | | | `AllowRawDataDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AllowTextDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `Close` | | | | | `CSSClasses` | | `WebCSSClasses` | | | `ExecuteJavaScript` | script As `String` | | | | `FrameworkLibraryURL` | libraryFileName As `String` | | | | `GoToURL` | url As `String`, inNewWindow As `Boolean` = `False` | | | | `LazyLoadDependencies` | | `Boolean` | | | `SetFocus` | | | | | `Style` | | `WebStyle` | | | | `Assigns` value As `WebStyle` | | | | `UpdateBrowser` | | | | | `UpdateControl` | sendImmediately As `Boolean` = `False` | | | ## Events

table-centered_column_4

| Name | Parameters | Returns | |------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| | `Closed` | | | | `ContextualMenuSelected` | hitItem As `WebMenuItem` | | | `DrawControlInLayoutEditor` | g As `Graphics` | | | `DropObject` | obj As `WebDragItem`, action As `WebDragItem.DragActionTypes`, x As `Integer`, y As `Integer` | | | `ExecuteEvent` | name As `String`, parameters As `JSONItem` | `Boolean` | | `HandleRequest` | request As `WebRequest`, response As `WebResponse` | `Boolean` | | `Hidden` | | | | `JavaScriptClassName` | | `String` | | `Opening` | | | | `Serialize` | js As `JSONItem` | | | `SessionCSSURLs` | session As `WebSession` | `String()` | | `SessionHead` | session As `WebSession` | `String` | | `SessionJavascriptURLs` | session As `WebSession` | `String()` | | `Shown` | | | ## Constants > These constants are designed to be used with the WebSDKUIControl to show icons at the Navigator and Library. > > For a *LibraryIcon* aim for 48x48, but note that these will scale depending on the Library settings. Currently we don't provide a way to specify all the acceptable sizes, i.e. 16x16, 32x32, 48x48. For a *NavigatorIcon* 16x16 is sufficient. > > | Name | Description | > |---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| > | NavigatorIcon | This constant is used to override the icon of your control in the Navigator. Using the WebSDKIconConverter, place the Base64 icon data into the value of this constant. | > | LibraryIcon | This constant is used to override the icon of your control in the Library. Using the WebSDKIconConverter, place the Base64 icon data into the value of this constant. | ## Enumerations

forsearch

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

forsearch

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

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

forsearch

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

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

forsearch

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

forsearch

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

forsearch

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

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

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

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

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

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

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

forsearch

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

forsearch

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

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

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

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

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

forsearch

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

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

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

forsearch

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

forsearch

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

forsearch

WebSDKUIControl.AllowPictureDrag **AllowPictureDrag**(allowedDragActionTypes As `WebDragItem.DragActionTypes`) > Allows the control to be dragged as a picture.

forsearch

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

forsearch

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

forsearch

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

forsearch

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

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

WebSDKUIControl.FrameworkLibraryURL **FrameworkLibraryURL**(libraryFileName As `String`) > Returns the URL for a library filename available in the Xojo Web Framework. It's meant to be used in the `SessionJavascriptURLs` and `SessionCSSURLs` events. For example, the following code will return the URLs for the Moment.js library: > > ``` xojo > Var result() As String > > result.Add(FrameworkLibraryURL("moment-with-locales.min.js")) > result.Add(FrameworkLibraryURL("moment-timezone-with-data.min.js")) > > Return result > ```

forsearch

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

WebSDKUIControl.LazyLoadDependencies **LazyLoadDependencies** As `Boolean` > This is a method that can be overridden by subclasses. By default it returns `False`. Returning `True` will lazy load CSS and JS dependencies for that control. If it's `False` or the method hasn't been overridden, it won't do any lazy loading, everything will be downloaded when the framework creates the Session for that user.

forsearch

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

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

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

forsearch

WebSDKUIControl.UpdateControl **UpdateControl**(sendImmediately As `Boolean` = `False`) > Similar to the UpdateBrowser method, this method also sets the internal flag which indicates to the framework that your control needs a refresh on the browser. When *sendImmediately* is `False`, any changes made are deferred until the event loop completes. When *sendImmediately* is `True`, the changes will be sent at that very moment. > >

> >

> > Note > >

> > Calling this method with *sendImmediately* set to `True` will override the "deferred" option of any changes before it was called. > >

## Event descriptions

forsearch

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

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

WebSDKUIControl.DrawControlInLayoutEditor **DrawControlInLayoutEditor**(g As `Graphics`) > This event allows you to draw a preview of your control in the Layout Editor, similar to how the control will look like in at runtime. As this code will run as a script in the IDE, if it doesn't compile for any reason, you will see what happened in the Messages pane. > > This event fires whenever your control needs to be drawn in the Layout Editor. > > There is no need to re-open the project or restart the IDE, in order to see changes you make to the code in this event. > > For more information of how this works, see `Drawing Your Control`.

forsearch

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

WebSDKUIControl.ExecuteEvent **ExecuteEvent**(name As `String`, parameters As `JSONItem`) As `Boolean` > This event fires when an event is sent from the browser to the app using the `triggerServerEvent` JavaScript method. Return `True` if your control has handled the event.

forsearch

WebSDKUIControl.HandleRequest **HandleRequest**(request As `WebRequest`, response As `WebResponse`) As `Boolean` > This event fires in the same way as `App.HandleURL` does except that it is for requests that are only for the current control. > > To trigger this event you will need to create a specially formed URL: > > ``` xojo > Var url As String = "https://www.yourdomain.com/sdk/" + Self.ControlID > ``` > > See the documentation for `WebApplication.HandleURL` for usage.

forsearch

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

WebSDKUIControl.JavaScriptClassName **JavaScriptClassName** As `String` > This event fires when the control is first created to send the JavaScript constructor for your control to the browser.

forsearch

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

WebSDKUIControl.Serialize **Serialize**(js As `JSONItem`) > This event fires when the framework sends the first configuration to your control in the browser, whenever a property on WebControl is changed and whenever you call the Xojo UpdateBrowser method.

forsearch

WebSDKUIControl.SessionCSSURLs **SessionCSSURLs**(session As `WebSession`) As `String()` > This event fires each time a new session starts. You should return an array of URLs which point to any css stylesheets you need for your control to function. The Xojo framework will attempt to prevent duplicate URLs from being sent to the same session. > >

> >

> > Note > >

> > Hint: One reason we supply the session object is so you can figure out whether or not items have already been delivered to a particular session. > >

forsearch

WebSDKUIControl.SessionHead **SessionHead**(session As `WebSession`) As `String` > This event fires each time a new session starts. You should return a `String` containing the items you wish to add to the `` tag.

forsearch

WebSDKUIControl.SessionJavascriptURLs **SessionJavascriptURLs**(session As `WebSession`) As `String()` > This event fires each time a new session starts. You should return an array of URLs which point to any javascript you need for your control to function, whether it be a subclass of XojoControl or an external library. The Xojo framework will attempt to prevent duplicate URLs from being sent to the same session. > >

> >

> > Note > >

> > One reason we supply the session object is so you can figure out whether or not items have already been delivered to a particular session. > >

forsearch

WebSDKUIControl.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 > ``` ## Drawing Your Control As for Xojo 2020r1 WebSDKUIControl has the ability to draw itself in the Layout Editor using the same techniques that you use to draw a control in the Paint event of a Canvas control with one important difference: this event has access to the Properties and Constants of your class as well as the ability to query the current Bootstrap theme. To draw a preview of your control in the Layout Editor, you must implement the DrawControlInLayoutEditor event. You may wish to implement it even if you're not using it to prevent this event from being available to the end users of your control. Most of the Xojo framework itself is not available in this event. If the code you have placed in the event can't compile or runs into a runtime issue, an amber warning icon will be drawn on your control and the errors will be displayed to the Messages pane.

Important

Methods cannot be called in this event.

Here's an example of how you would draw a red oval within the bounds of the control: ``` xojo g.DrawingColor = Color.Red g.DrawOval(0, 0, g.Width, g.Height) ``` In addition to the standard drawing controls, there are also some methods for accessing the properties and constants in your control as well as getting values from the user's current Bootstrap theme file. ### Property Methods **BooleanProperty**(Name as String) as Boolean > Gets the current value of a Boolean property of your control. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **ColorProperty**(name As `String`) As `Color` > Gets the current value of a Color property of your control. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **DoubleProperty**(name As `String`) As `Double` > Gets the current value of a Double property of your control. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **IntegerProperty**(name As `String`) As `Integer` > Gets the current value of an Integer property of your control. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **PictureProperty**(name As `String`) As `Picture` > Gets the current value of a Picture property of your control. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **StringProperty**(name As `String`) As `String` > Gets the current value of a String property of your control. ### Constant Methods --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **ConstantValue**(name As `String`) As `String` > Gets the value of a constant in your control as a String. > > You can use the ConstantValue of a string stored in a constant, such as "kDescription".: > > ``` xojo > Var s As String = ConstantValue("kDescription") > g.DrawText(s, 25, 25) > ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **PictureConstant**(name As `String`) As `Picture` > Gets the value of a constant in your control as a Picture. > > You can use PictureConstant with the Base64 value (without the type header) of a picture stored in a constant, such as "kIcon": > > ``` xojo > Var icon As Picture = PictureConstant("kIcon") > g.DrawPicture(icon, 0, 0) > ``` ### Color Methods **ColorGroup.NamedColor**(name As `String`) As `Color` > When running on a platform that supports named colors (only macOS at the time of this writing), this method returns the named OS. > >

> >

> > Note > >

> > Color names are case sensitive, so the macOS secondary label color should be "secondaryLabelColor". > >

--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **TextColor** As `Color` > Returns the current text color of the platform that the IDE is running on. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **FillColor** As `Color` > Returns the current fill color of the platform that the IDE is running on. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **IsDarkMode** As `Boolean` > Returns `True` if the system is running in dark mode (only macOS at the time of this writing). ### Font Methods **FontCount** As `Integer` > Returns the number of fonts available on the system. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **FontAt**(index As `Integer`) As `String` > Returns the name of the font at the specified *index*. ### CSS Methods **CSSColorValue**(selector as `String`, propertyName As `String`, fallbackColor As `Color`) As `Color` > Returns a Xojo color converted from whatever format was used in the CSS color definition. Automatically converts \#RRGGBB, rgb(1, 0, 0) and rgba(1, 0, 0, 0.5) style colors. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **CSSPixelValue**(selector As `String`, propertyName As `String`, fallbackValue As `Double`) As `Double` > Returns a pixel value for a particular *selector* and property, making automatic adjustments for things that may be in units other than px. Useful for things that may be represented in millimeters, points or rems (rems is multiplied by the value of Body font-size). --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **CSSStringValue**(selector As `String`, propertyName As `String`) As `String` > Returns the raw value of a particular *selector* and property. ### Other Methods **DebugLog**(msg As `String`) > Sends *msg* to the Messages pane. **Print**(msg As `String`) > Sends *msg* to the Messages pane. ## Compatibility | | | |-----------------------|-----| | **Project Types** | Web | | **Operating Systems** | All |

`WebUIControl` parent class