BindingGroup Class


Contains a collection of bindings and ValidationRule objects that are used to validate an object.

Namespace:   System.Windows.Data
Assembly:  PresentationFramework (in PresentationFramework.dll)

type BindingGroup = 
        inherit DependencyObject


Initializes a new instance of the BindingGroup class.


Gets a collection of BindingExpression objects that contains information for each Binding in the BindingGroup.


Gets whether each source in the binding can discard pending changes and restore the original values.


Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)


Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)


Gets a value that indicates whether the BindingGroup has a failed validation rule.


Gets or sets a value that indicates whether the BindingGroup contains a proposed value that has not been written to the source.


Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)


Gets the sources that are used by the Binding objects in the BindingGroup.


Gets or sets the name that identifies the BindingGroup, which can be used to include and exclude Binding objects in the BindingGroup.


Gets or sets whether the Validation.Error event occurs when the state of a ValidationRule changes.


Gets the object that this BindingGroup is assigned to.


Gets or sets a value that indicates whether the BindingGroup reuses target values that have not been committed to the source.


Gets or sets a value that indicates whether to include the NotifyDataErrorValidationRule.


Gets a collection of ValidationError objects that caused the BindingGroup to be invalid.


Gets a collection of ValidationRule objects that validate the source objects in the BindingGroup.


Begins an edit transaction on the sources in the BindingGroup.


Ends the edit transaction and discards the pending changes.


Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)


Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)


Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)


Coerces the value of the specified . This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.)GTMT


Runs all the ValidationRule objects and updates the binding sources if all validation rules succeed.


Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Gets a for this DependencyObject.(Inherited from DependencyObject.)GTMT


Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)


Gets the Type of the current instance.(Inherited from Object.)


Returns the current effective value of a on this instance of a DependencyObject. (Inherited from DependencyObject.)GTMT

System_CAPS_pubmethodGetValue(Object, String)

Returns the proposed value for the specified property and item.


Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Invoked whenever the effective value of any on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from DependencyObject.)GTMT


Returns the local value of a , if it exists. (Inherited from DependencyObject.)GTMT

System_CAPS_pubmethodSetCurrentValue(DependencyProperty, Object)

Sets the value of a without changing its value source. (Inherited from DependencyObject.)GTMT

System_CAPS_pubmethodSetValue(DependencyProperty, Object)

Sets the local value of a , specified by its dependency property identifier. (Inherited from DependencyObject.)GTMT

System_CAPS_pubmethodSetValue(DependencyPropertyKey, Object)

Sets the local value of a read-only , specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)GTMT


Returns a value that indicates whether serialization processes should serialize the value for the provided .(Inherited from DependencyObject.)GTMT


Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodTryGetValue(Object, String, Object)

Attempts to get the proposed value for the specified property and item.


Runs the converter on the binding and the ValidationRule objects that have the ValidationStep property set to RawProposedValue, ConvertedProposedValue, or UpdatedValue and saves the values of the targets to the source objects if all the validation rules succeed.


Runs the converter on the binding and the ValidationRule objects that have the ValidationStep property set to RawProposedValue or ConvertedProposedValue.


Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

A BindingGroup creates a relationship between multiple bindings, which can be validated and updated together. For example, suppose that an application prompts the user to enter an address. The application then populates an object of type Address, which has the properties, Street, City, ZipCode, and Country, with the values that the user provided. The application has a panel that contains four TextBox controls, each of which is data bound to one of the object’s properties. You can use a ValidationRule in a BindingGroup to validate the Address object. If the bindings participate in the same BindingGroup, you can ensure that the zip-code is valid for the country of the address.

You set the BindingGroup property on FrameworkElement or FrameworkContentElement. Child elements inherit the BindingGroup from their parent elements, just as with any other inheritable property. A binding on a descendent element is added to a BindingGroup if one of the following situations occurs:

In the example of the address, suppose that the DataContext of the Panel is set to the object of type Address. The binding for each TextBox is added to the BindingGroup of the panel.

You add ValidationRule objects to a BindingGroup. The BindingGroup is passed as the first parameter of the Validate method when the ValidationRule runs. You can use the TryGetValue or GetValue(Object, String) method on that BindingGroup to get the proposed values of the object, and the Items property to get the sources of the bindings.

A BindingGroup updates the sources of the binding at the same time instead of each binding being updated separately. When you call one of the methods to validate the data (ValidateWithoutUpdate, UpdateSources, or CommitEdit), the binding for each TextBox in the example is validated and potentially updated. When a binding is part of a BindingGroup, the source of the binding is not updated until you call UpdateSources or CommitEdit on the BindingGroup, unless you explicitly set the UpdateSourceTrigger property.

Legacy Code Example

The following examples create an application that prompts the user to enter the description and price of an item and the date that the offer expires. The application displays the current information for the item below the form. The user can submit or cancel the changes.

The application does the following to achieve this behavior.

  • Creates a BindingGroup and adds it the root StackPanel when it creates the user interface (UI) of the application. 

  • Calls BeginEdit, CommitEdit, and CancelEdit in the application's logic to enable rolling back changes.

  • Calls TryGetValue in a Validate method to get the user's input and then check that an item over 100 dollars is available for at least seven days.

The following example creates the user interface (UI) of the application. The root StackPanel has a BindingGroup that contains a ValidationRule that validates the item, as described previously. The binding objects on the Price property and the OfferExpires property become part of the BindingGroup and each binding has a ValidationRule to make sure that price and date, respectively, are valid values. The validation rules for the individual properties run before the ValidationRule on the BindingGroup.

Code snippet is not found. Confirm that the code snippet name 'BindingGroupSnippets' is correct.

The following example shows the event handlers for the application. When the user clicks the Submit button, the application calls CommitEdit to run each ValidationRule that is associated with the BindingGroup. If each ValidationRule succeeds, CommitEdit saves the values to the object and ends the edit transaction. If CommitEdit is successful, the application begins another edit transaction. When a ValidationRule fails, the Validation.Error event occurs because the application set NotifyOnValidationError to true on the BindingGroup (in the previous example). ItemError handles the Validation.Error event and displays information about the validation error to the user. The example also handles the Loaded event for the StackPanel and the Click event for the Cancel button.

Code snippet is not found. Confirm that the code snippet name 'BindingGroupSnippets' is correct.

The following example shows the custom ValidationRule ValidateDateAndPrice, which was added to the BindingGroup in the first example. The ValidationRule uses the BindingGroup in its Validate method to get the values the user entered into the form, and checks that if an item is over 100 dollars, it will be available for at least seven days.

Code snippet is not found. Confirm that the code snippet name 'BindingGroupSnippets' is correct.

.NET Framework
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft