Clear a dependencyProperty value from the xaml

Question

I have a control which has a default value for a property. When the control first gets its dataContext set, it assigns this property automatically.

In the xaml now, I want it to be possible to UNset this property. I've tried setting it to x:Null of just the empty string, but then I get an error because there's no converter for the property. How do I simply unassign this property from the xaml in the rare cases where I want the feature disabled?

code where it is originally set:

void OmniBox_DataContextChanged(object sender, DependencyPropertyChangedEventArgs e)
{
    if( e.NewValue is BindingObjectBaseExtended )
    {
        BindingObjectBaseExtended value = (BindingObjectBaseExtended)e.NewValue;
        this.SetBinding(OmniBox.ContextValidationMessagesProperty, new Binding() { Source = value, Path = new PropertyPath("ValidationMessages") });
    }
}

xaml where I want to unset the property.

<Style TargetType="ui:OmniBox">
    <Setter Property="ContextValidationMessages" Value="" />
</Style>

Note that if I do not set up the binding automatically when the data context changes, then by default there are no validation messages and I have to do the following in the xaml to set them up:

<Style TargetType="ui:OmniBox">
    <Setter Property="ContextValidationMessages" Value="ValidationMessages" />
</Style>

What I'm trying to do is make the above binding the default for my custom OmniBox control, and allow the user to unset it or change it to something else.

score 4 · Answer 1 · answered Sep 09 '14 at 14:09

4

DependencyProperty.UnsetValue cannot be used in XAML.

http://msdn.microsoft.com/en-us/library/system.windows.dependencyproperty.unsetvalue(v=vs.90).ASPX

answered Sep 09 '14 at 14:09

Sam L.

207
2
3

score 2 · Accepted Answer · answered Nov 01 '11 at 17:33

Personally, I would create a separate dependency property, such as bool AutoBindValidation and make it default to true. If it is false, don't do anything when the DataContext changes. This is a little more self-documenting. Depending on what exactly you're trying to do, you might not want to publicly expose ContextValidationMessages at all.

If you really want to do it the way you posted, I'm not sure why setting it to {x:Null} would cause an error (unless the property type is not nullable). But this approach would have problems because DataContextChanged is going to occur after the XAML is parsed. So the user can set it to {x:Null}, but then the DataContext will change and your code will set up the default binding and trample the user's value. You could set up the binding in the control's contstructor, but then if the DataContext does not have a ValidationMessages property, your control will be spitting out binding errors.

+1 The correct solution in the case may be to create a new `AutoBindValidation` dependency property defaulting to true, and just provide an error message if they try to set ContextValidationMessages without first setting this to false. For my application though, I do want it to be possible to override the default auto-binding with different ValidationMesages collections. — Alain, Nov 01 '11 at 17:45

score 2 · Answer 3 · answered Nov 01 '11 at 17:36

2

This may be impossible, my best bet was this:

<Setter Property="ContextValidationMessages"
        Value="{x:Static DependencyProperty.UnsetValue}" />

But that throws "Cannot unset setter value". So you better inverse your logic or keep the property unset another way.

answered Nov 01 '11 at 17:36

H.B.

166,899
29
327
400

1

+1 I wasn't aware of `{x:Static DependencyProperty.UnsetValue}`, even if it doesn't help this case, it might help similar ones. – Alain Nov 01 '11 at 17:40
But it's not an answer. This should be written as a comment. – Lucenty Nov 09 '17 at 10:30
@Lucenty: The answer here is: `you better inverse your logic or keep the property unset another way`. Sometimes what is asked is not possible or another approach is required. – H.B. Nov 09 '17 at 12:54
So annoying this doesn't work! This is the css programmer approach! – Simon_Weaver May 02 '21 at 22:01

score 1 · Answer 4 · edited May 23 '17 at 10:30

I don't think there is any supported way to do this in the xaml itself. In your code you are setting a local value on the ContextValidationMessagesProperty. The Style setters you included would have a lower dependency property precedence and even if they were evaluated they would set a value based on the specified Value - not clear it. Maybe instead of setting the binding in code you could have a Setter in your default style for OmniBox that sets that property - e.g.

<Setter Property="ContextValidationMessages" Value="{Binding ValidationMessages}" />

If you have to conditionally set the Binding then you could create a custom IValueConverter that checks for the specified type (passed as the parameter). e.g.

public class IsAssignableFromConverter : IValueConverter
{
    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
    {
        Type typeParameter = parameter as Type;

        if (typeParameter == null)
            return DependencyProperty.UnsetValue;

        return value != null && typeParameter.IsAssignableFrom(value.GetType());
    }

    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
    {
        return DependencyProperty.UnsetValue;
    }
}

Then you might use it like this:

    <local:IsAssignableFromConverter x:Key="isAssignableConverter" />
    <Style TargetType="ui:OmniBox">
        <Style.Triggers>
            <DataTrigger Binding="{Binding Converter={StaticResource isAssignableConverter}, ConverterParameter={x:Type ui:BindingObjectBaseExtended}}" Value="True">
                <Setter Property="ContextValidationMessages" Value="{Binding ValidationMessages}" />
            </DataTrigger>
        </Style.Triggers>
    </Style>

In the case where you don't want this property to be applied you might set the Style for that instance of the OmniBox to a new style and make sure to set the OverridesDefaultStyle property to true.

I suppose another option is to create another dependency property that will call ClearValue on the ContextValidationMessages property but this seems like it could be a maintenance issue.

Problem is that I really need to check the type of the dataContext before I can attempt to set the ContextValidationMessages. I only want it automatically set for bound objects which inherit from the BindingObjectBaseExtended class, otherwise the onus is definitely on the user to set it. I can't do that type checking in the xaml. — Alain, Nov 01 '11 at 17:47
I updated the answer to use a custom IValueConverter that you could use in a Style Trigger to conditionally apply the setter if the DataContext is a particular type (or derived). — AndrewS, Nov 01 '11 at 18:26

score 0 · Answer 5 · answered May 02 '21 at 22:23

For certain cases you can 'reset' to the default value of the parent control by using a RelativeSource. For instance I'm using a DataGrid and this worked for me to reset back to the 'default'.

This is a textblock inside a datagrid cell.

<TextBlock Text="{Binding ServiceName}">

    <TextBlock.Style>
        <Style>

            <Style.Triggers>

                <!-- Change text color to purple for FedEx -->
                <Trigger Property="TextBlock.Text" Value="FedEx">
                    <Setter Property="TextBlock.Foreground" Value="Purple"/>
                </Trigger>

                <!-- Reset if the cell is selected, since purple on blue is illegible -->
                <DataTrigger Binding="{Binding IsSelected, RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type DataGridCell}}}" Value="True">
                    <Setter Property="TextBlock.Foreground" Value="{Binding Foreground, RelativeSource={RelativeSource FindAncestor, AncestorType={x:Type DataGridCell}}}"/>
                </DataTrigger>

            </Style.Triggers>
        </Style>
    </TextBlock.Style>

</TextBlock>

This seems clever enough to inherit the correct color even when the window is inactive.

Clear a dependencyProperty value from the xaml

5 Answers5