Application
Some parameters can only be set from 'Early configuration'. This means they are set from either configuration embedded into application executable, or .ini/.conf files close to the executable (in the same directory as executable or symlink to it). They are set before any application or user-specific directories configuration files are read and cannot be overriden from there.
Some parameters can be set from configuration only and are not changeable at runtime. Some parameters can be set from the application main window in runtime using SetApplicationParameters API call. No application parameters can be set from secondary windows.
| Parameter | Value | Specifics |
|---|
| AllowDebug | false | Early configuration and /etc/ .ini/.conf files on Linux/MacOS |
| AllowExec | false | Configuration only |
| AllowExecFilter | Not set | Configuration only, multiple setting allowed, additive |
| AllowExecRegexp | Not set | Configuration only, multiple setting allowed, additive |
| AllowSystemInfo | true | Configuration only |
| ApplicationID | TrayBrowser | Early configuration only |
| ApplicationUseNativeDataDirectory | false | Early configuration only |
| AutoHide | true | Configuration, main window (also depends on main window settings, see below) |
| AutoPrint | false | Configuration only |
| ClearKVStore | false | Configuration only |
| ClearDataDirectory | false | Configuration only |
| ConservativeCache | false | Configuration only |
| ConservativeResources | false | Configuration only |
| Copyright | Default TrayBrowser copyright string | Configuration only (cannot be empty) |
| EnableGPU | false | Configuration only |
| EnableHangMonitor | false | Configuration only |
| GracefulExitTime | 1000 | Configuration only (per-window setting can be changed separately) |
| Hint | Default TrayBrowser tray icon hint | Configuration, main window (can be empty, meaning no hint) |
| Icon | Not set | Configuration only (see Icon Loading section for details about how icon is chosen) |
| KeepCookies | true | Configuration only, not applicable if ClearDataDirectory is false |
| KeepStorage | false | Configuration only, not applicable if ClearDataDirectory is false |
| LoadErrorPage | internal | Configuration only |
| MenuDisable | false | Configuration, main window |
| MenuExitCaption | Exit | Configuration, main window |
| MenuHideExit | false | Configuration, main window |
| MenuHideRetry | false | Configuration, main window |
| MenuRetryCaption | Try loading again | Configuration, main window |
| NoOverride | Not set | Configuration only, multiple setting allowed, additive |
| RetryInterval | 15 | Configuration only |
| ScaleAlignmentMax | 128 | Configuration only |
| ScalingMode | normal | Configuration only |
| ShowTrayIcon | true | Configuration, main window |
| Title | Default TrayBrowser application title | Configuration only (main window caption can be changed separately) |
| TrayIconClickMode | normal | Configuration, main window (cannot be empty) |
| URL | Not set | Configuration only, mandatory to provide (welcome page is displayed otherwise) |
| UserAgent | %DEFAULT% (meaning default TrayBrowser + CEF user-agent line) | Configuration only (cannot be empty) |
Main window
| Parameter | Value | Specifics |
|---|
| AllowCopy | false | |
| AllowDownload | true | |
| AllowPaste | true | |
| AllowPrint | false | |
| AllowReload | true | |
| AllowSearch | true | |
| AlwaysOnTop | true | Different default for secondary windows (see below) |
| APIEnabled | true | Cannot be changed at runtime |
| Border | normal | Different default for secondary windows, affects other settings and defaults (see below), cannot be changed at runtime |
| BorderMargin | 1 | Different default for secondary windows (see below) |
| Caption | Application Title setting | Different default for secondary windows (see below) |
| ClampToMonitor | true | |
| CloseButton | false | Different default for secondary windows (see below), cannot be changed at runtime |
| CloseMode | hide | Different default for secondary windows (see below) |
| FullScreen | no | Affects other settings and defaults (see below), cannot be changed at runtime |
| GracefulExitTime | Application GracefulExitTime setting | |
| Height | 300 | |
| IgnoreCertificateErrors | false | Can have long lasting effects (see documentation) |
| KeepHidden | false | |
| MaximizeButton | false | Affects other defaults (see below), cannot be changed at runtime |
| MaximizeMode | none | |
| MinimizeButton | false | Affects other defaults (see below), cannot be changed at runtime |
| MinimizeMode | none | |
| Movable | false | Different default for secondary windows, affects other defaults (see below), cannot be changed at runtime |
| Parameters | Empty string | Cannot be changed at runtime |
| PositionID | Not set | Can only be set for secondary windows, cannot be set for main window (see below) |
| RememberPosition | full | Cannot be changed at runtime |
| RememberSize | false | Cannot be changed at runtime |
| RestoreOnShow | true | |
| Sizeable | false | Cannot be changed at runtime |
| ShowOnStart | false | Cannot be changed at runtime |
| ShowOnTaskbar | false | Different default for secondary windows, affects other settings and defaults (see below), cannot be changed at runtime |
| SnapTo | tray | Different default for secondary windows, affects other defaults (see below) |
| StartMonitor | default | Different meaning for secondary windows (see below), cannot be changed at runtime |
| URL | Application URL setting | Required to be provided (welcome page is shown otherwise) |
| Width | 450 | |
Secondary windows
These defaults apply when multi-window application opens additional TrayBrowser window. Parameters with light blue background are different from main window defaults. Take care secondary windows do not inherit any main window parameters set in configuration files.
'Cannot be changed at runtime' does not mean parameter cannot be set for secondary window, but it can only be set on window creation and cannot be changed by SetWindowParameters API call afterwards.
| Parameter | Value | Specifics |
|---|
| AllowCopy | false | |
| AllowDownload | true | |
| AllowPaste | true | |
| AllowPrint | false | |
| AllowReload | true | |
| AllowSearch | true | |
| AlwaysOnTop | false | |
| APIEnabled | true | Cannot be changed at runtime |
| Border | window | Affects other settings and defaults (see below), cannot be changed at runtime |
| BorderMargin | 0 | |
| Caption | Empty string | |
| ClampToMonitor | true | |
| CloseButton | true | Cannot be changed at runtime |
| CloseMode | exit | |
| FullScreen | no | Affects other settings and defaults (see below), cannot be changed at runtime |
| GracefulExitTime | Application GracefulExitTime setting | |
| Height | 300 | |
| IgnoreCertificateErrors | false | Can have long lasting effects (see documentation) |
| KeepHidden | false | |
| MaximizeButton | false | Affects other defaults (see below), cannot be changed at runtime |
| MaximizeMode | none | |
| MinimizeButton | false | Affects other defaults (see below), cannot be changed at runtime |
| MinimizeMode | none | |
| Movable | true | Affects other defaults (see below), cannot be changed at runtime |
| Parameters | Empty string | Cannot be changed at runtime |
| PositionID | Not set | Cannot be changed at runtime |
| RememberPosition | full | Cannot be changed at runtime |
| RememberSize | false | Cannot be changed at runtime |
| RestoreOnShow | true | |
| Sizeable | false | Cannot be changed at runtime |
| ShowOnStart | false | Cannot be changed at runtime |
| ShowOnTaskbar | true | Affects other settings and defaults (see below), cannot be changed at runtime |
| SnapTo | none | Affects other defaults (see below) |
| StartMonitor | default (meaning it starts on the same monitor as main window) | Cannot be changed at runtime |
| URL | Not set, mandatory to be provided on window creation | Always provided to secondary window creation API call |
| Width | 450 | |
Conditional changes to defaults
Some settings defaults depend on and may be changed by other parameters. The list of these dependencies is provided below. Please always take those into consideration.
Unless marked as fixed and unchangeable, these changes apply to defaults only and may be overridden by explicitly setting the parameter. If marked as fixed and unchangeable, this overrides any parameter set in configuration files or on window creation.
Main window - when Movable is false
| Parameter | Value | Specifics |
|---|
| AutoHide | false | Changes application level setting default |
When Movable is false
| Parameter | Value | Specifics |
|---|
| AlwaysOnTop | false | |
| Border | window | Affects other defaults (see below) |
| BorderMargin | 0 | |
| SnapTo | none | Affects other defaults (see below) |
When Movable is false or Border is not window
| Parameter | Value | Specifics |
|---|
| Sizeable | false | |
When Fullscreen is window, desktop, kiosk or all
| Parameter | Value | Specifics |
|---|
| Movable | false | Becomes fixed and unchangeable, applies all defaults from when Movable is false described above |
| MaximizeButton | false | Becomes fixed and unchangeable |
| MaximizeMode | none (fixed and unchangeable) | Becomes fixed and unchangeable |
| Sizeable | false | Becomes fixed and unchangeable |
| SnapTo | center (fixed and unchangeable) | Becomes fixed and unchangeable |
When Fullscreen is desktop, kiosk or all
| Parameter | Value | Specifics |
|---|
| Border | borderless | Becomes fixed and unchangeable |
| BorderMargin | 0 | Becomes fixed and unchangeable |
| CloseButton | false | Becomes fixed and unchangeable |
| MinimizeButton | false | Becomes fixed and unchangeable |
| ScaleAlignmentMax | 0 | Becomes fixed and unchangeable |
When Fullscreen is kiosk or all
| Parameter | Value | Specifics |
|---|
| AlwaysOnTop | true | Becomes fixed and unchangeable |
| AutoHide | false | Application level setting, becomes fixed and unchangeable if any window if in kiosk or all fullscreen mode |
| MinimizeMode | none | Becomes fixed and unchangeable |
| ShowOnTaskbar | no | Becomes fixed and unchangeable |
| Parameter | Value | Specifics |
|---|
| MaximizeMode | os | |
| Parameter | Value | Specifics |
|---|
| MinimizeMode | taskbar | |
| Parameter | Value | Specifics |
|---|
| CloseButton | true | Becomes fixed and unchangeable |
When MinimizeMode is taskbar and ShowOnTaskbar is false
| Parameter | Value | Specifics |
|---|
| MinimizeMode | event | 'taskbar' minimize mode is not applicable when ShowOnTaskbar is false and cannot be set (will revert to 'event') |
When SnapTo is not none
| Parameter | Value | Specifics |
|---|
| Movable | false | Movable becomes fixed and unchangeable but does not apply any other defaults from described above for when Movable is false automatically |
Home