Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
indent20px

...

Specifies the default HWZ behavior. This value is off by default. To enable it, set it to on.

[string] storage_path

Creates a "Local Storage" subfolder in the specified directory. This folder is used by local storage applications such as the JavaScript storage class. 

Anchor
storage_path
storage_path

[string or double] storage_quota

Sets the total size (in bytes) allotted to all local storage applications (including IndexedDB). A BrightScript integer is only guaranteed to be able to represent a count of bytes up to 2GB so avoid using integers when calculating the size: Use float or double instead since they can represent values over 2GB (string can also be used but is not recommended). If the storage path is specified without a storage quota, Chromium defaults to reserving 1GB plus 10% of the total size of the storage device.

[roMessagePort] port

Configures the message port to which the roHtmlWidget instance will send events. When using initialization parameters, the port parameter should be used instead of the SetPort() method to ensure the script can catch load-startedload-finished, and load-error events.

...

Discards any resources that Chromium has cached in memory.

Warning

Changing the storage path after a URL is loaded can cause the storage database to be irretrievably lost and/or damaged. Users should avoid using SetLocalStorageDir, SetWebDatabaseDir and SetAppCacheDir API's when writing BrightScript applications.

Since the BOS 6.0 release, BrightSign uses a single storage path for WebDatabase, LocalStorage and AppCache. This should be set by the storage_path parameter in roHtmlWidget static initialization parameters.

With the BOS 8.2.35.4 release, if SetLocalStorageDir, SetWebDatabaseDir, or SetAppCacheDir are called, roHtmlWidget will use the path as the first one that is set. This directory will only set once and will be used for the subsequent use of roHtmlWidget as well.


SetLocalStorageDir(file_path As String) As Boolean

Configures the HTML storage path. This method takes effect when a new roHtmlWidget instance is created; it doesn't apply to the roHtmlWidget instance on which it is called.

Note
titleNote

As of OS8, the SetLocalStorageDir()SetWebDatabaseDir(), and SetAppCacheDir() methods all configure the same HTML database. See the HTML Best Practices page for more details.

SetWebDatabaseDir(file_path As String) As Boolean

Configures the HTML storage path. See the SetLocalStorageDir() entry above for details.

This method takes effect when a new roHtmlWidget instance is created; it doesn't apply to the roHtmlWidget instance on which it is called.

SetAppCacheDir(file_path As String) As Boolean 
Anchor
setappcachedir()
setappcachedir()

Configures the HTML storage path. See the SetLocalStorageDir() entry above for details.

This method takes effect when a new roHtmlWidget instance is created; it doesn't apply to the roHtmlWidget instance on which it is called.

SetLocalStorageQuota(maximum As Dynamic) As Boolean

...

Reject any dialog request. This parameter was added in BOS 8.5.16.

ifMessagePort

SetPort(port As roMessagePort)

...