XL Toolbox user settings. Should be used as singleton. More...

Inheritance diagram for XLToolbox.UserSettings.UserSettings:

Collaboration diagram for XLToolbox.UserSettings.UserSettings:

Public Member Functions
override string	GetSettingsFilePath ()
	Gets the complete path and file name for the user settings file. More...

	UserSettings ()
	Creates a new instance. This should never be called directly, use the singleton factory instead. The constructor must be public to enable deserialization. More...

Public Member Functions inherited from Bovender.UserSettings.UserSettingsBase
	UserSettingsBase ()

void	Save ()
	Saves the user settings to a file. More...

	UserSettingsBase ()

void	Save ()
	Saves the user settings to a file. More...

Static Public Member Functions
new static void	LoadDefaults ()
	Creates a new settings object without loading the saved settings from file and without saving the current settings from file. More...

Static Public Member Functions inherited from Bovender.UserSettings.UserSettingsBase
static void	LoadDefaults ()
	Creates a new settings object without loading the saved settings from file and without saving the current settings from file. More...

static void	LoadDefaults ()
	Creates a new settings object without loading the saved settings from file and without saving the current settings from file. More...

Protected Member Functions
override void	WriteYamlHeader (StreamWriter streamWriter)
	Writes a header to the YAML file before all other data. To write comments, prefix lines with "#". More...

Properties
static string	UserSettingsFile `[get]`

new static UserSettings	Default `[get]`

string	LanguageCode `[get, set]`

DateTime	LastUpdateCheck `[get, set]`

string	LastVersionSeen `[get, set]`

bool	EnableUpdateChecks `[get, set]`

int	UpdateCheckInterval `[get, set]`

bool	EnableLogging `[get, set]`

bool	DebugLogging `[get, set]`

bool	EnableBackups `[get, set]`

string	BackupDir `[get, set]`

int	LastAnova `[get, set]`

int	LastErrorBars `[get, set]`

Csv.CsvSettings	CsvSettings `[get, set]`

string	CsvPath `[get, set]`

ObservableCollection< Preset >	ExportPresets `[get, set]`
	Wraps the singleton PresetsRepository's Presets property. More...

Preset	ExportPreset `[get, set]`

BatchExportSettings	BatchExportSettings `[get, set]`

Unit	ExportUnit `[get, set]`

string	ExportPath `[get, set]`

bool	WorksheetManagerAlwaysOnTop `[get, set]`

bool	SheetManagerVisible `[get, set]`
	Gets or sets whether the worksheet manager task pane is visible. More...

int	TaskPaneWidth `[get, set]`

bool	KeyboardShortcutsEnabled `[get, set]`

ObservableCollection< Keyboard.Shortcut >	KeyboardShortcuts `[get, set]`

bool	SuppressBackupFailureMessage `[get, set]`

int	PreferredPropertyIndex `[get, set]`

bool	SuppressDllWarning `[get, set]`

bool	Running `[get, set]`

Properties inherited from Bovender.UserSettings.UserSettingsBase
static UserSettingsBase	Default `[get, set]`
	Gets the singleton instance of the user settings. Applications that use this framework may want to replace the default singleton with an instance of their own (UserSettingsBase.Default = myInstance), in order to avoid having two separate settings files, one for the Bovender framework and one for the application itself. More...

string	User `[get, set]`

string	Email `[get, set]`

bool	CcUserOnExceptionReport `[get, set]`

string	DownloadFolder `[get, set]`

bool	WasFromFile `[get, protected set]`
	Is true if the options store was initially loaded from a YAML file. More...

Exception	Exception `[get, protected set]`
	Gets the last IOException, if any occurred. More...

Additional Inherited Members
Static Protected Member Functions inherited from Bovender.UserSettings.UserSettingsBase
static T	FromFileOrDefault< T > (string yamlFile)
	Loads options from a file, or creates a default instance if the I/O operation failed. This is a protected method. Implementations of UserSettingsBase must provide simple-access methods defined in IUserSettings to make life easier for the outside world. More...

static T	FromFileOrDefault< T > (string yamlFile)
	Loads options from a file, or creates a default instance if the I/O operation failed. This is a protected method. Implementations of UserSettingsBase must provide simple-access methods defined in IUserSettings to make life easier for the outside world. More...

Detailed Description

XL Toolbox user settings. Should be used as singleton.

Settings will not automatically be saved to file during disposal; explicitly use the Save() method inherited from Bovender.UserSettings.UserSettingsBase.

Constructor & Destructor Documentation

◆ UserSettings()

XLToolbox.UserSettings.UserSettings.UserSettings ( )

inline

Creates a new instance. This should never be called directly, use the singleton factory instead. The constructor must be public to enable deserialization.

Member Function Documentation

◆ GetSettingsFilePath()

override string XLToolbox.UserSettings.UserSettings.GetSettingsFilePath ( )

inlinevirtual

Gets the complete path and file name for the user settings file.

Applications using this framework should override this.

Reimplemented from Bovender.UserSettings.UserSettingsBase.

◆ LoadDefaults()

new static void XLToolbox.UserSettings.UserSettings.LoadDefaults ( )

inlinestatic

Creates a new settings object without loading the saved settings from file and without saving the current settings from file.

◆ WriteYamlHeader()

override void XLToolbox.UserSettings.UserSettings.WriteYamlHeader ( StreamWriter streamWriter )

inlineprotectedvirtual

Writes a header to the YAML file before all other data. To write comments, prefix lines with "#".

Reimplemented from Bovender.UserSettings.UserSettingsBase.

Property Documentation

◆ BackupDir

string XLToolbox.UserSettings.UserSettings.BackupDir

getset

◆ BatchExportSettings

BatchExportSettings XLToolbox.UserSettings.UserSettings.BatchExportSettings

getset

◆ CsvPath

string XLToolbox.UserSettings.UserSettings.CsvPath

getset

◆ CsvSettings

Csv.CsvSettings XLToolbox.UserSettings.UserSettings.CsvSettings

getset

◆ DebugLogging

bool XLToolbox.UserSettings.UserSettings.DebugLogging

getset

◆ Default

new static UserSettings XLToolbox.UserSettings.UserSettings.Default

staticget

◆ EnableBackups

bool XLToolbox.UserSettings.UserSettings.EnableBackups

getset

◆ EnableLogging

bool XLToolbox.UserSettings.UserSettings.EnableLogging

getset

◆ EnableUpdateChecks

bool XLToolbox.UserSettings.UserSettings.EnableUpdateChecks

getset

◆ ExportPath

string XLToolbox.UserSettings.UserSettings.ExportPath

getset

◆ ExportPreset

Preset XLToolbox.UserSettings.UserSettings.ExportPreset

getset

◆ ExportPresets

ObservableCollection<Preset> XLToolbox.UserSettings.UserSettings.ExportPresets

getset

Wraps the singleton PresetsRepository's Presets property.

◆ ExportUnit

Unit XLToolbox.UserSettings.UserSettings.ExportUnit

getset

◆ KeyboardShortcuts

ObservableCollection<Keyboard.Shortcut> XLToolbox.UserSettings.UserSettings.KeyboardShortcuts

getset

◆ KeyboardShortcutsEnabled

bool XLToolbox.UserSettings.UserSettings.KeyboardShortcutsEnabled

getset

◆ LanguageCode

string XLToolbox.UserSettings.UserSettings.LanguageCode

getset

◆ LastAnova

int XLToolbox.UserSettings.UserSettings.LastAnova

getset

◆ LastErrorBars

int XLToolbox.UserSettings.UserSettings.LastErrorBars

getset

◆ LastUpdateCheck

DateTime XLToolbox.UserSettings.UserSettings.LastUpdateCheck

getset

◆ LastVersionSeen

string XLToolbox.UserSettings.UserSettings.LastVersionSeen

getset

◆ PreferredPropertyIndex

int XLToolbox.UserSettings.UserSettings.PreferredPropertyIndex

getset

◆ Running

bool XLToolbox.UserSettings.UserSettings.Running

getset

◆ SheetManagerVisible

bool XLToolbox.UserSettings.UserSettings.SheetManagerVisible

getset

Gets or sets whether the worksheet manager task pane is visible.

While it would be nice to have these accessors directly relay the value to the singleton Instance of the XLToolbox.SheetManager.SheetManagerPane, it did not work out because the task panes (being COM objects?) are not available at various stages during startup and shutdown. Therefore, the visibility is restored in ThisAddin_Startup, and the SheetManagerPane itself signals its visibility state to the UserSettings object.

◆ SuppressBackupFailureMessage

bool XLToolbox.UserSettings.UserSettings.SuppressBackupFailureMessage

getset

◆ SuppressDllWarning

bool XLToolbox.UserSettings.UserSettings.SuppressDllWarning

getset

◆ TaskPaneWidth

int XLToolbox.UserSettings.UserSettings.TaskPaneWidth

getset

◆ UpdateCheckInterval

int XLToolbox.UserSettings.UserSettings.UpdateCheckInterval

getset

◆ UserSettingsFile

string XLToolbox.UserSettings.UserSettings.UserSettingsFile

staticget

◆ WorksheetManagerAlwaysOnTop

bool XLToolbox.UserSettings.UserSettings.WorksheetManagerAlwaysOnTop

getset

The documentation for this class was generated from the following file:

XLToolbox/UserSettings/UserSettings.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UserSettings()

Member Function Documentation

◆ GetSettingsFilePath()

◆ LoadDefaults()

◆ WriteYamlHeader()

Property Documentation

◆ BackupDir

◆ BatchExportSettings

◆ CsvPath

◆ CsvSettings

◆ DebugLogging

◆ Default

◆ EnableBackups

◆ EnableLogging

◆ EnableUpdateChecks

◆ ExportPath

◆ ExportPreset

◆ ExportPresets

◆ ExportUnit

◆ KeyboardShortcuts

◆ KeyboardShortcutsEnabled

◆ LanguageCode

◆ LastAnova

◆ LastErrorBars

◆ LastUpdateCheck

◆ LastVersionSeen

◆ PreferredPropertyIndex

◆ Running

◆ SheetManagerVisible

◆ SuppressBackupFailureMessage

◆ SuppressDllWarning

◆ TaskPaneWidth

◆ UpdateCheckInterval

◆ UserSettingsFile

◆ WorksheetManagerAlwaysOnTop