BindingSource::ResetBindings Method (Boolean)

 

Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public:
void ResetBindings(
	bool metadataChanged
)

Parameters

metadataChanged
Type: System::Boolean

true if the data schema has changed; false if only values have changed.

The ResetBindings method informs all controls bound to the BindingSource to refresh their values. The method does this by raising the ListChanged event at least once; the metaDataChanged parameter indicates the nature of the underlying change.

Regardless of the value of metaDataChanged, a ListChanged event is raised with ListChangedEventArgs::ListChangedType set to ListChangedType::Reset. As a consequence, calling ResetBindings with a parameter of true will raise two ListChanged events.

ResetBindings is automatically called whenever another member makes major changes to the data-binding, such as setting the DataSource or DataMember properties. However, the programmer can also call this method explicitly.

The following code example uses a BindingSource component to bind an array list, which does not provide change notification. An item is removed from the list, and the bound controls are notified of the change by calling the ResetBindings method. This code example is part of a larger example provided in How to: Reflect Data Source Updates in a Windows Forms Control with the BindingSource.

private:
   void button1_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      String^ xml = "<US><states>"
         + "<state><name>Washington</name><capital>Olympia</capital> "
         + "<flower>Coast Rhododendron</flower></state>"
         + "<state><name>Oregon</name><capital>Salem</capital>"
         + "<flower>Oregon Grape</flower></state>"
         + "<state><name>California</name><capital>Sacramento</capital>"
         + "<flower>California Poppy</flower></state>"
         + "<state><name>Nevada</name><capital>Carson City</capital>"
         + "<flower>Sagebrush</flower></state>"
         + "</states></US>";

      // Convert the xml string to bytes and load into a memory stream.
      array<Byte>^ xmlBytes = Encoding::UTF8->GetBytes( xml );
      MemoryStream^ stream = gcnew MemoryStream( xmlBytes,false );

      // Create a DataSet and load the xml into it.
      dataSet2->ReadXml( stream );

      // Set the data source.
      bindingSource1->DataSource = dataSet2;
      bindingSource1->ResetBindings( true );
   }

.NET Framework
Available since 2.0
Return to top
Show: