Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Bind to a value defined in the Settings

People also ask

What is a bind in code?

In computer programming, to bind is to make an association between two or more programming objects or value items for some scope of time and place.

Why do we use bind in C#?

Data binding enables you to synchronize the values of the properties of two different objects. To establish a binding, use the Binding class or one of the other classes that inherit BindingBase.


First, you need to add a custom XML namespace that will design the namespace where the settings are defined:

xmlns:properties="clr-namespace:TestSettings.Properties"

Then, in your XAML file, access the default settings instance using the following syntax:

{x:Static properties:Settings.Default}

So here is the final result code:

<ListBox x:Name="lb"
         ItemsSource="{Binding Source={x:Static properties:Settings.Default},
                               Path=Names}" />

Source: WPF - How to bind a control to a property defined in the Settings?


Note: As pointed out by @Daniel and @nabulke, don't forget to set Access Modifier of your settings file to Public and Scope to User


The solution above does work, but I find it quite verbose... you could use a custom markup extension instead, that could be used like this :

<ListBox x:Name="lb" ItemsSource="{my:SettingBinding Names}" />

Here is the code for this extension :

public class SettingBindingExtension : Binding
{
    public SettingBindingExtension()
    {
        Initialize();
    }

    public SettingBindingExtension(string path)
        :base(path)
    {
        Initialize();
    }

    private void Initialize()
    {
        this.Source = WpfApplication1.Properties.Settings.Default;
        this.Mode = BindingMode.TwoWay;
    }
}

More details here : http://www.thomaslevesque.com/2008/11/18/wpf-binding-to-application-settings-using-a-markup-extension/


@CSharper's answer did not work for my WPF application coded in VB.NET (not C#, unlike apparently 99.999% of other WPF applications), as I got a persistent compiler error complaining that Settings could not be found in the MyApp.Properties namespace, which would not go away even after rebuilding.

What worked instead for me, after much searching online, was to instead use the local XAML namespace created by default in my application's main window XAML file:

<Window
    <!-- Snip -->
    xmlns:local="clr-namespace:MyApp"
    <!-- Snip -->
><!-- Snip --></Window>

...and bind to my settings through it using something like the following (where MyBooleanSetting is a setting I defined in my project properties of type Boolean and scope User, with the default Friend access modifier):

<CheckBox IsChecked="{Binding Source={x:Static local:MySettings.Default}, Path=MyBooleanSetting, Mode=TwoWay}"
          Content="This is a bound CheckBox."/>

To ensure the settings are actually saved, be sure to call

MySettings.Default.Save()

...somewhere in your code-behind (such as in the Me.Closing event for your MainWindow.xaml.vb file).

(Credit to this Visual Studio forum post for the inspiration; see the reply by Muhammad Siddiqi.)