saveSettingDictionary Method @beta
Deprecated in 5.1.9 - will not be removed until after 2027-05-04. Use EditTxn.saveSettingDictionary instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
Save a SettingDictionary in this iModel that will be loaded into settings every time this iModel is opened in future sessions.
saveSettingDictionary(name: string, dict: SettingsContainer): void
@note All saved SettingDictionarys are loaded into settings every time an iModel is opened.
@see addDictionary to register a dictionary for the current session only without persisting it.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name for the SettingDictionary. If a dictionary by that name already exists in the iModel, its value is replaced. |
| dict | SettingsContainer | The SettingDictionary object to stringify and save. |
Returns - void
Defined in
- backend/src/IModelDb.ts Line 2265
Last Updated: 05 May, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.