1 - Workspace Settings

This page describes how to add new workspace settings and groups.

Add new Workspace Settings Group

• Add a new key for the group to WorkspaceSettings.cs (Vereinsmeisterschaften.Core > Settings):
  e.g. public const string GROUP_NEWGROUP = "NewGroup";
• Init the group in initializeSettings() in WorkspaceSettings.cs:
  e.g. WorkspaceSettingsGroup groupNewGroup = GetGroup(GROUP_NEWGROUP, true);
• Add a new resource to the Resources.resx (Vereinsmeisterschaften > Properties):
  • Settings<GroupName>String (e.g. SettingsNewGroupString): Group Name that is shown in the UI
• Add the group to the GroupKeyLabelsDict in WorkspaceSettingViewConfigs.cs (Vereinsmeisterschaften > ViewModels):
  e.g. { WorkspaceSettings.GROUP_NEWGROUP, Resources.SettingsNewGroupString }

Add new Workspace Settings

• Add a new key for the setting to WorkspaceSettings.cs (Vereinsmeisterschaften.Core > Settings):
  e.g. public const string SETTING_GENERAL_NEWSETTING = "NewSetting";
• Init the setting in initializeSettings() in WorkspaceSettings.cs:
  e.g. groupNewGroup.MakeSureSettingExists<ushort>(SETTING_GENERAL_NEWSETTING, defaultValue, minValue, maxValue);
• Add a resource to the Resources.resx (Vereinsmeisterschaften > Properties):
  • <SettingName>String (e.g. NewSettingString): Setting Name that is shown in the UI
• Add a resource to the Tooltips.resx (Vereinsmeisterschaften > Properties):
  • Tooltip<SettingName> (e.g. TooltipNewSetting): Tooltip for the setting that is shown in the UI
• If necessary, add an icon to the Icons.xaml (Vereinsmeisterschaften > Styles):
  • Add the icon to the ResourceDictionary with a unique key (e.g. DrawingImage_NewSetting)
  • If you want to use a Segoe MDL2 Assets icon, you can use the Unicode value directly in Icon (e.g. "\uE787")
• Add the setting to the SettingKeyConfigDict in WorkspaceSettingViewConfigs.cs (Vereinsmeisterschaften > ViewModels):
  e.g.
  {
(WorkspaceSettings.GROUP_NEWGROUP, WorkspaceSettings.SETTING_GENERAL_NEWSETTING),
new WorkspaceSettingViewConfig() { Label=Resources.NewSettingString, Tooltip = Tooltips.TooltipNewSetting, Icon = "\uE787", Editor = WorkspaceSettingEditorTypes.Numeric, SupportResetToDefault = false }
},
  or
  {
(WorkspaceSettings.GROUP_NEWGROUP, WorkspaceSettings.SETTING_GENERAL_NEWSETTING),
new WorkspaceSettingViewConfig() { Label=Resources.NewSettingString, Tooltip = Tooltips.TooltipNewSetting, IconDrawingImage = (DrawingImage)iconResourceDict["DrawingImage_NewSetting"], Editor = WorkspaceSettingEditorTypes.Numeric, SupportResetToDefault = false }
},

Order of Workspace Settings

The order of the workspace settings in the .json file is determined by the order of the settings in WorkspaceSettings.cs (Vereinsmeisterschaften.Core > Settings).

The order of the workspace settings in the UI is determined by the order of the settings in the SettingKeyConfigDict and GroupKeyLabelsDict in WorkspaceSettingViewConfigs.cs (Vereinsmeisterschaften > ViewModels).