Почему атрибут Browsable делает свойство не привязываемым? - PullRequest
Новая
       31

Почему атрибут Browsable делает свойство не привязываемым?

5 голосов
/ 12 января 2010

Я пытаюсь использовать System.Windows.Forms.PropertyGrid.

Чтобы свойство не было видно в этой сетке, следует использовать BrowsableAttribute, установленное на false. Но добавление этого атрибута делает свойство не привязываемым.

Пример: Создайте новый проект Windows Forms и поместите TextBox и PropertyGrid на Form1. Используя приведенный ниже код, ширина TextBox не привязывается к Data.Width: 

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();

        Data data = new Data();
        data.Text = "qwe";
        data.Width = 500;

        BindingSource bindingSource = new BindingSource();
        bindingSource.Add(data);

        textBox1.DataBindings.Add("Text", bindingSource, "Text", true,
            DataSourceUpdateMode.OnPropertyChanged);
        textBox1.DataBindings.Add("Width", bindingSource, "Width", true,
            DataSourceUpdateMode.OnPropertyChanged);

        propertyGrid1.SelectedObject = data;
    }
}

Код для класса данных: 

public class Data : IBindableComponent
{
    public event EventHandler TextChanged;
    private string _Text;
    [Browsable(true)]
    public string Text
    {
        get
        {
            return _Text;
        }
        set
        {
            _Text = value;
            if (TextChanged != null)
                TextChanged(this, EventArgs.Empty);
        }
    }

    public event EventHandler WidthChanged;
    private int _Width;
    [Browsable(false)]
    public int Width
    {
        get
        {
            return _Width;
        }
        set
        {
            _Width = value;
            if (WidthChanged != null)
                WidthChanged(this, EventArgs.Empty);
        }
    }

    #region IBindableComponent Members

    private BindingContext _BindingContext;
    public BindingContext BindingContext
    {
        get
        {
            if (_BindingContext == null)
                _BindingContext = new BindingContext();

            return _BindingContext;
        }
        set
        {
            _BindingContext = value;
        }
    }

    private ControlBindingsCollection _DataBindings;
    public ControlBindingsCollection DataBindings
    {
        get 
        {
            if (_DataBindings == null)
                _DataBindings = new ControlBindingsCollection(this);

            return _DataBindings;    
        }
    }

    #endregion

    #region IComponent Members

    public event EventHandler Disposed;

    public System.ComponentModel.ISite Site
    {
        get
        {
            return null;
        }
        set
        {

        }
    }

    #endregion

    #region IDisposable Members

    public void Dispose()
    {
        throw new NotImplementedException();
    }

    #endregion
}

Если вы переключите атрибут Browsable на true для каждого свойства в Data, оно будет работать. Теперь похоже, что BindingSource выполняет поиск источника данных по атрибуту Browsable.

Ответы [ 2 ]

6 голосов
/ 12 января 2010

Обновленный ответ на основе примера обновления:

Я немного покопался в Reflector и обнаружил, что «проблема» на самом деле в ListBindingHelper, который используется CurrencyManager, который, в свою очередь, используется BindingSource (они все в System.Windows.Forms namespace).

Чтобы обнаружить привязываемые свойства, CurrencyManager вызывает ListBindingSource.GetListItemProperties. Под капотом это вызывает GetListItemPropertiesByInstance (когда вы передаете один объект). Этот метод имеет следующую строку кода в конце: 

return TypeDescriptor.GetProperties(target, BrowsableAttributeList);

А реализация BrowsableAttributeList это: 

private static Attribute[] BrowsableAttributeList
{
    get
    {
        if (browsableAttribute == null)
        {
            browsableAttribute = new Attribute[] { new BrowsableAttribute(true) };
        }
        return browsableAttribute;
    }
}

Вы можете видеть, что на самом деле это фильтрация свойств по BrowsableAttribute(true). Возможно, вместо этого следует использовать BindableAttribute, но я предполагаю, что дизайнеры поняли, что все уже зависели от BrowsableAttribute, и решили использовать его вместо этого.

Так что, к сожалению, вы не сможете обойти эту проблему, если используете BrowsableAttribute. Ваши единственные варианты - либо делать то, что предлагает Марк, и использовать пользовательский TypeConverter, либо фильтровать саму сетку свойств, используя одно из решений в этом вопросе: Программно скрыть поле в PropertyGrid .

3 голосов
/ 13 января 2010

BrowsableAttribute используется многими компонентами модели как механизм, позволяющий избежать его включения. Возможно, лучший вариант - не добавлять [Browsable(false)].

Существует несколько других способов фильтрации PropertyGrid, в том числе (с возрастающей сложностью) TypeConverter, ICustomTypeDescriptor, TypeDescriptionProvider, но, возможно, самый простой способ - указать PropertyGrid атрибуты, которые описывают вещи, которые вы do want (.BrowsableAttributes) и отметьте другие свойства.

Обратите внимание, что другой вариант заключается в создании настраиваемой вкладки, но в моем опыте это просто хит.

Вот пример использования TypeConverter, который используется PropertyGrid, но не большинством других привязок; он работает, имея собственный преобразователь типов, который исключает определенное свойство по имени, но вы также можете использовать что-то вроде Attribute.IsDefined для маскировки: 

using System.Windows.Forms;
using System;
using System.Linq;
using System.ComponentModel;
static class Program
{
    [STAThread]
    static void Main()
    {
        Application.EnableVisualStyles();
        Data data = new Data { Name = "the name", Value = "the value" };
        using (Form form = new Form
        {
            Controls =
            {
                new PropertyGrid {
                    Dock = DockStyle.Fill,
                    SelectedObject = data
                },
                new TextBox {
                    Dock = DockStyle.Bottom,
                    DataBindings = { {"Text", data, "Value"}, }
                },
                new TextBox {
                    Dock = DockStyle.Bottom,
                    DataBindings = { {"Text", data, "Name"}, }
                }
            }
        })
        {
            Application.Run(form);
        }        
    }
}
[TypeConverter(typeof(DataConverter))]
class Data
{
    class DataConverter : ExpandableObjectConverter
    {
        public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContext context, object value, Attribute[] attributes)
        {
            var props = base.GetProperties(context, value, attributes);
            return new PropertyDescriptorCollection(
                (from PropertyDescriptor prop in props
                 where prop.Name != "Value"
                 select prop).ToArray(), true);
        }
    }
    public string Value { get; set; }
    public string Name { get; set; }
}
...