6

Today I update a Windows Store app according to UI design change. One of the changes is replacing a CheckBox with a ToggleSwitch.

So the code is updated from

<CheckBox IsChecked="{Binding BooleanProperty}" ...

to

<ToggleSwitch IsOn="{Binding BooleanProperty"} ... //does not update data source

Then I notice that toggling ToggleSwitch does not update the underlying BooleanProperty, I have to add Mode=TwoWay to make it work.

<Toggleswitch IsOn="{Binding BooleanProperty, Mode=TwoWay"} ... //update data source

From what I learnt in WPF, I don't have to set Mode=TwoWay explicitly on CheckBox's IsChecked property, because it is TwoWay by default.

In general, user-editable control properties, such as those of text boxes and check boxes, default to two-way bindings, whereas most other properties default to one-way bindings.

And I have been thinking ToggleSwitch is just another CheckBox with better touch support, and it is only available on Windows Store and Windows Phone apps.

Why ToggleSwitch.IsOn is not default to TwoWay binding? Are there other differences between a CheckBox and a ToggleSwitch?

kennyzx
  • 12,845
  • 6
  • 39
  • 83

2 Answers2

3

The issue is that Microsoft changed a bunch of stuff when they created the "Windows 8" version of WPF. Lots of stuff changed, including the default mode for bindings:

The default is OneWay: the source updates the target, but changes to the target value do not update the source.

(MSDN)

Whereas in WPF:

One of the BindingMode values. The default is Default, which returns the default binding mode value of the target dependency property. However, the default value varies for each dependency property. In general, user-editable control properties, such as those of text boxes and check boxes, default to two-way bindings, whereas most other properties default to one-way bindings.

A programmatic way to determine whether a dependency property binds one-way or two-way by default is to get the property metadata of the property using GetMetadata and then check the Boolean value of the BindsTwoWayByDefault property.

(MSDN)

BradleyDotNET
  • 60,462
  • 10
  • 96
  • 117
  • ++, but I'm not sure about this part - `Its possible that some controls/properties override this behavior` - the MSDN wording suggests that the default value is always "OneWay". – McGarnagle Dec 15 '14 at 19:10
  • 1
    @McGarnagle Agreed I put that there because .NET can always be weird and do one offs. It doesn't really need to be there though – BradleyDotNET Dec 15 '14 at 19:11
0

According to my experience, the ToggleSwitch and the CheckBox are both used to switch between two states. Of course, the ToggleSwitch is used in Windows Store and Windows Phone apps. Maybe, the ToggleSwich is more like a simple ToggleButton than a CheckBox... Another difference is that the CheckBox can be cleared but the ToggleSwitch is always in toggled or untoggled.

Anyway, I suggest to set the mode of the binding explicitly in every cases.

MDoobie
  • 272
  • 2
  • 10
  • yes, I do feel `Mode=TwoWay` is _better_ added to the code since I am not sure if the old rule in the the WPF link applies to the new `Modern UI` stuff. – kennyzx Dec 15 '14 at 15:04