HomeTrayBrowser API - Base window API
Last modified by Alex/AT on 2026/03/11 07:44
- API Information
- Window commands and information
- Window sizing and positioning
- Window and screen information
- Window state
- Custom drag region
- Browser commands
API Information
GetAPIVersion
| Parameters | Return value | On error | Notes | |||
|---|---|---|---|---|---|---|
| None | string: TrayBrowser API version in strict form of major.minor example: 3.0 | Undefined |
GetAPIModel
| Parameters | Return value | On error | Notes | |||
|---|---|---|---|---|---|---|
| None | string: TrayBrowser API operational model example: cef | Undefined |
GetAPIOS
| Parameters | Return value | On error | Notes | |||
|---|---|---|---|---|---|---|
| None | string: operating system TrayBrowser is running under example: windows | Undefined |
GetAPIBrowser
| Parameters | Return value | On error | Notes | |||
|---|---|---|---|---|---|---|
| None | string: embedded browser used by TrayBrowser example: chromium | Undefined |
GetVersion
| Parameters | Return value | On error | Notes | |||
|---|---|---|---|---|---|---|
| None | string: full TrayBrowser version for displaying where necessary example: 3.0, 3.1.2rc1, whatever | Undefined |
GetCopyright
| Parameters | Return value | On error | Notes | |||
|---|---|---|---|---|---|---|
| None | string: default TrayBrowser copyright HTML string for displaying where necessary example: by Alex/AT (<a href="javascript:;" onclick="traybrowser.OpenBrowser(''mailto:alex@alex-at.net'');">alex@alex-at.net</a>), 2025-2026 | Undefined |
Window commands and information
Show
Hide
Focus
Close
Exit
IsVisible
IsInFocus
GetParameters
SetCaption(text)
Window sizing and positioning
- GetBrowserSize
- SetBrowserSize(browserWidth, browserHeight)
- GetPixelSize
- SetPixelSize(pixelWidth, pixelHeight)
- GetPixelPosition
- SetPixelPosition(pixelLeft, pixelTop)
- GetScaledPosition
- SetScaledPosition(browserLeft, browserTop)
- GetDesktopPosition
- SetDesktopPosition(pixelLeft, pixelTop)
- GetSavedPosition(id)
- SetSavedPosition(id, position)
- WasPositionRestored