mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-15 21:29:23 +00:00
1f82507730
Deprecate the following obsolete functions and properties: * `keyman.helpURL` * `keyman.util.rgba` * `keyman.util.toFloat` * `keyman.util.toNumber` * `keyman.util.toNzString` Use correct language for code blocks in Keyman Engine for Web documentation. Test-bot: skip
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
---
|
|
title: setStore (KSETS)
|
|
---
|
|
|
|
## Summary
|
|
|
|
`setStore` sets the value of a [system `store`](/developer/language/guide/stores#toc-system-stores) to a string.
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
keyman.interface.setStore(systemId, strValue, Pelem);
|
|
```
|
|
|
|
or
|
|
|
|
```js
|
|
KeymanWeb.KSETS(systemId, strValue, Pelem); // Shorthand
|
|
```
|
|
|
|
### Parameters
|
|
|
|
`systemId`
|
|
: Type: `number`
|
|
: The ID of the system store to set. Only system ID `33` (`layer`) is currently supported.
|
|
|
|
`strValue`
|
|
: Type: `string`
|
|
: The string value to set as the system store's content.
|
|
|
|
`Pelem`
|
|
: Type: `Element`
|
|
: The page element currently active. (This parameter exists for use by possible future extensions.)
|
|
|
|
### Return Value
|
|
|
|
`boolean`
|
|
: `true` if the operation succeeds, otherwise `false`.
|
|
|
|
## Description
|
|
|
|
This function is used to set the value of writeable system stores. Many system stores are readonly, containing metadata about an individual keyboard, so `keyman.interface.ifStore()` will fail upon attempts to modify their values.
|
|
|
|
This function cannot modify standard keyboard [`stores`](/developer/language/guide/stores) and is limited to system `stores` only, as standard keyboard stores are optimized into Javascript string literals set directly in code with automatically-generated names.
|
|
|
|
## See also
|
|
|
|
- [`keyman.interface.ifStore()`](ifStore)
|