SettingsTools Class
Global setting variables/functions and repairLegacyFunctions and checkpurgeNames tools
Inheritance Hierarchy
- System.Object
- DBaddin.SettingsTools
Namespace: DBaddinAssembly: DBaddin in (DBaddin.dll)
Syntax
public sealed class SettingsTools
The SettingsTools type exposes the following members.
Methods
| Name | Summary | |
|---|---|---|
 | checkpurgeNames() | maintenance procedure to check/purge names used for db-functions from workbook, or unhide DB names |
| env(Boolean) | environment for settings (+1 of selected Environment which is the index of the dropdown, if baseZero is set then simply the index) |
| fetchSetting(String, String) | encapsulates setting fetching (currently ConfigurationManager from DBAddin.xll.config), use only for strings. For Integer and Boolean use fetchSettingInt and fetchSettingBool |
| fetchSettingBool(String, String) | exception proof fetching of boolean settings |
| fetchSettingInt(String, String) | exception proof fetching of integer settings |
| fixOrphanedDBFunctions(Workbook) | fix orphaned DB Functions by replacing function names with themselves, triggering recalculation |
| initSettings() | initializes global configuration variables |
| repairLegacyFunctions(Workbook, Boolean) | "repairs" legacy functions from old VB6-COM Addin by removing "DBAddin.Functions." before function name |
| resetCachesForWorkbook(String) | resets the caches for given workbook |
| setUserSetting(String, String) | change or add a key/value pair in the user settings |
Fields
| Name | Description | |
|---|---|---|
 | CmdTimeout | global command timeout (can't be set in DB functions) |
| CnnTimeout | global connection timeout (can't be set in DB functions) |
| ConstConnString | Default ConnectionString, if no connection string is given by user.... |
| DefaultDBDateFormatting | default formatting style used in DBDate |
| deleteRowKey | |
| environdefs | environment definitions |
| insertRowKey | |
| jumpButtonKey | |
| refreshDataKey | |
| selectedEnvironment | currently selected environment for DB Functions, zero based (env -1) !! |
 | UserSettingsPath | The path where the User specific settings (overrides of standard/global settings) can be found (hardcoded to path of xll) |