File: System\Windows\Forms\DataBinding\BindableComponent.cs
Web Access
Project: src\src\System.Windows.Forms\src\System.Windows.Forms.csproj (System.Windows.Forms)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.ComponentModel;
 
namespace System.Windows.Forms;
 
/// <summary>
///  Base class for components which provide properties which can be
///  data bound with the WinForms Designer.
/// </summary>
public abstract class BindableComponent : Component, IBindableComponent
{
    internal static readonly object s_bindingContextChangedEvent = new();
 
    private ControlBindingsCollection? _dataBindings;
    private BindingContext? _bindingContext;
 
    /// <summary>
    ///  Gets or sets the <see cref="BindingContext"/> for this bindable <see cref="Component"/>.
    /// </summary>
    [Browsable(false)]
    [EditorBrowsable(EditorBrowsableState.Advanced)]
    [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
    [SRCategory(nameof(SR.CatData))]
    [SRDescription(nameof(SR.BindingComponentBindingContextDescr))]
    public BindingContext? BindingContext
    {
        get => _bindingContext ??= [];
 
        set
        {
            if (!Equals(_bindingContext, value))
            {
                _bindingContext = value;
                OnBindingContextChanged(EventArgs.Empty);
            }
        }
    }
 
    /// <summary>
    ///  Occurs when the binding context has changed.
    /// </summary>
    [SRCategory(nameof(SR.CatData))]
    [SRDescription(nameof(SR.BindableComponentBindingContextChangedDescr))]
    [EditorBrowsable(EditorBrowsableState.Advanced)]
    public event EventHandler BindingContextChanged
    {
        add => Events.AddHandler(s_bindingContextChangedEvent, value);
        remove => Events.RemoveHandler(s_bindingContextChangedEvent, value);
    }
 
    /// <summary>
    ///  Raises the <see cref="BindingContextChanged"/> event.
    /// </summary>
    [EditorBrowsable(EditorBrowsableState.Advanced)]
    protected virtual void OnBindingContextChanged(EventArgs e)
    {
        if (_bindingContext is not null)
        {
            for (int i = 0; i < DataBindings.Count; i++)
            {
                BindingContext.UpdateBinding(BindingContext, DataBindings[i]);
            }
        }
 
        RaiseEvent(s_bindingContextChangedEvent, e);
    }
 
    /// <summary>
    ///  Gets the <see cref="ControlBindingsCollection"/> for this bindable <see cref="Component"/>.
    /// </summary>
    [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
    [RefreshProperties(RefreshProperties.All)]
    [ParenthesizePropertyName(true)]
    [SRCategory(nameof(SR.CatData))]
    public ControlBindingsCollection DataBindings
        => _dataBindings ??= new ControlBindingsCollection(this);
 
    private protected void RaiseEvent(object key, EventArgs e)
        => ((EventHandler?)Events[key])?.Invoke(this, e);
}