Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

BindingBase.BindingGroupName Property

Gets or sets the name of the BindingGroup to which this binding belongs.

Namespace:  System.Windows.Data
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
public string BindingGroupName { get; set; }
<object BindingGroupName="string" .../>

Property Value

Type: System.String
The name of the BindingGroup to which this binding belongs.

If BindingGroupName is not set, the binding belongs to a BindingGroup only if the binding's source and the DataContext of the parent element that has the BindingGroup are the same object.

If BindingGroupName is set to a value, the binding belongs to a BindingGroup if the following conditions are true:

If BindingGroupName is set to null, the binding is never a part of a BindingGroup.

You can include bindings that have a source that is different from the DataContext of the parent element that has the BindingGroup by setting Name of the BindingGroup and the BindingGroupName property of a binding to the same value. You can exclude bindings that have the same source as DataContext of the parent element that has the BindingGroup by setting Name of the BindingGroup and the BindingGroupName property of a binding to different values.

The following examples are part of an application that checks whether the user has set the properties of two objects to equal values. The first example creates two TextBox controls, each of which is data bound to a different source: The binding of the first TextBox is part of the BindingGroup because the TextBox inherits the DataContext and BindingGroup from its parent StackPanel

The binding on the second TextBox is part of the BindingGroup because the Name of the BindingGroup and the BindingGroupName of the Binding are both set to bindingGroup.

<StackPanel Name="sp1"
            Margin="5"
            DataContext="{Binding Source={StaticResource object1}}"
            Validation.ValidationAdornerSite="{Binding ElementName=label1}"
            Orientation="Horizontal"
            HorizontalAlignment="Center">

  <StackPanel.BindingGroup>
    <BindingGroup Name="bindingGroup">
      <BindingGroup.ValidationRules>
        <src:BindingGroupValidationRule ValidatesOnTargetUpdated="True" />
      </BindingGroup.ValidationRules>
    </BindingGroup>
  </StackPanel.BindingGroup>

  <TextBlock Text="First string" />

  <TextBox Width="150"
           Text="{Binding Path=PropertyA}" />

  <TextBlock Text="Second string" />

  <TextBox Width="150"
           Text="{Binding Source={StaticResource object2}, 
    Path=PropertyB, BindingGroupName=bindingGroup, 
    TargetNullValue=please enter a string}" />

</StackPanel>


...


<Label Name="label1"
       Content="{Binding ElementName=sp1, Path=(Validation.Errors)[0].ErrorContent}"
       Margin="5"
       Foreground="Red"
       HorizontalAlignment="Center" />

The following example shows the ValidationRule that the previous example uses. In the Validate method, the example gets each source object from the BindingGroup and checks whether the properties of the objects are equal.

public class Type1
{
    public string PropertyA { get; set; }

    public Type1()
    {
        PropertyA = "Default Value";
    }
}

public class Type2
{
    public string PropertyB { get; set; }

    public Type2()
    {
    }
}

public class BindingGroupValidationRule : ValidationRule
{
    public override ValidationResult Validate(object value, System.Globalization.CultureInfo cultureInfo)
    {
        BindingGroup bg = value as BindingGroup;

        Type1 object1 = null;
        Type2 object2 = null;

        foreach (object item in bg.Items)
        {
            if (item is Type1)
            {
                object1 = item as Type1;
            }

            if (item is Type2)
            {
                object2 = item as Type2;
            }
        }

        if (object1 == null || object2 == null)
        {
            return new ValidationResult(false, "BindingGroup did not find source object.");
        }

        string string1 = bg.GetValue(object1, "PropertyA") as string;
        string string2 = bg.GetValue(object2, "PropertyB") as string;

        if (string1 != string2)
        {
            return new ValidationResult(false, "The two strings must be identical.");
        }

        return ValidationResult.ValidResult;

    }

}

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5 SP1, 3.0 SP2

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.