Documentation.md

SettingsEditor

• 1 Introduction
• 2 API
  • 2.1 SettingsEditor (UserControl)
  • 2.2 SettingsEditorItem (interface)

1 Introduction

The SettingsEditor provides a centralized settings control that automatically renders all available settings controls (SettingsEditorItems) via reflections. That way the controls can easily be expanded without the need of a manual change to any settings menu.

2 API

2.1 SettingsEditor (UserControl)

Renders all UserControls that implement the SettingsEditorItem interface.

The SettingsEditorItems can be grouped by using the SettingsEditorItem.GetTabName.

The SettingsEditor offers methods for the common loading, validation and saving of settings.

Accessible Interface:

public SettingsEditor()

public void InstantiateAllElements()
public void LoadData(int? identification)
public bool ValidateData()
public void SaveData()

2.2 SettingsEditorItem (interface)

An item that will be rendered within the SettingsEditor.

Implement this interface within any UserControl to let the UserControl be rendered within any generated instance of the SettingsEditor.

Accessible Interface:

void LoadData(int? accountIdentifier)
bool ValidateData()
void SaveData()

string GetTabName()
string GetControlName()
bool IsVisible()