PropertyGrid FAQ

Содержимое

От "копипастера"

Это репост оригинальной статьи размещённой здесь под авторством Алексея Кирюшкина. С момента опубликования стать прошло уже почти 15 лет и с того времени произошли некоторые изменения. Эта перепечатка материала попытка освежить код оригинальной статьи и сделать копию для ~~себя любимого~~ сообщества. Также я попробую добавить некоторые дополнительные детали, методы и приёмы использования.

Вступление

PropertyGrid – удобный компонент для визуального редактирования свойств объектов, либо по документации предоставляет интерфейс пользователя, который используется как обозреватель для свойств объекта. Объект для редактирования можно задать в дизайнере WinForms, либо непосредственно в коде:

public class Person {
    public Birthday { get; set; }
}
// в форме
Person person = new Person();
propertyGrid1.SelectedObject = person;

Хотя PropertyGrid умеет редактировать многие стандартные типы изначально (см. ниже), чаще всего на практике требуется адаптировать элемент под собственные нужды. Также стоит упомянуть, что для своей работы PropertyGrid активно использует аннотации данных (аттрибуты) имена типов которых далее в тексте упоминаются без суффикса "Attribute" для экономии места и лучшего восприятия.

Как изменить отображаемое имя свойства и его описание?

В приведённом выше примере можно заметить, что по-умолчанию в PropertyGrid для отображаемого имени свойства используется его имя, а также пусто описание свойства. Так происходит потому что мы не декорировали свойство необходимыми атрибутами. Для изменения отображаемого имени свойства предназначен атрибут DisplayName, а его описания Description:

public class Person
{
    [DisplayName("Дата рождения")]
    [Description("Дата рождения по григорианскому календарю")]
    public DateTime Birthdate { get; set; }
}

Отображение свойства декорированного атрибутами DisplayName и Description

Как сгруппировать свойства по категориям?

Можно заметить, что свойства объекта помещаются в категорию Misc, если не указано другое. Указать же PropertyGrid категорию свойства можно атрибутом Category:

[Category("Ф.И.О.")]
[DisplayName("Имя")]
[Description("Используйте это поле только для указания одного имени. " +
  "При наличии нескольких имён, напр. патронимов, матронимов или родового имени " +
  "укажите их в поле \"Отчество\".")]
public string FirstName { get; set; }

[Category("Ф.И.О.")]
[DisplayName("Фамилия")]
[Description("Для указания девичьей фамилии используйте круглые скобки " +
  "и префикс \"дев.\", напр.: Иванова (дев. Сидирова)")]
  public string LastName { get; set; }

[Category("Ф.И.О.")]
[DisplayName("Отчество")]
[Description("Помимо отчества также можно указать здесь родовое имя, патроним или матроним.")]
public string MiddleName { get; set; }

[DisplayName("Дата рождения")]
[Description("Дата рождения по григорианскому календарю")]
public DateTime Birthdate { get; set; }

Группировка свойств по атрибуту Category

Как сделать свойство недоступным для редактирования?

Можно в автосвойстве оставить только метод get, либо декорировать его атрибутом ReadOnly:

[Category("Идентификаторы")]
[DisplayName("ID")]
[Description("Идентификатор записи в базе данных")]
public int Id { get; }

[Category("Идентификаторы")]
[DisplayName("Отображаемый код")]
[Description("Используется для отображения идентификатора в документах")]
[ReadOnly(true)]
public string DisplayCode { get; set; }

Как заменить стандартные значения true/false в отображении свойств типа bool?

Для замены стандартных значений true/false при редактировании булевых свойств необходимо создать свой конвертер, унаследовав его от класса TypeConverter и пометить свойство одноименным атрибутом TypeConverter.

Простая реализация конвертера BooleanConverter'а

using System;
using System.ComponentModel;
using System.Globalization;

namespace TestApp.TypeConverters
{
    public class IsActiveTypeConverter : BooleanConverter
    {
        public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destType)
            => (bool)value ? "активен" : "деактивирован";

        public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
            => (string)value == "активен";
    }
}

После реализации своего конвертера помечаем необходимое свойство атрибутом:

[Category("Управление")]
[DisplayName("Активен")]
[Description("Определяет активна ли учётная запись или нет.")]
[TypeConverter(typeof(IsActiveTypeConverter)]
public bool IsActive { get; set; }

Стандартные значения при редактировании bool свойства

Дополнение от "копипастера"

Вышеприведённый пример хоть и является работоспособным, но всё таки обладает одним недостатком, а именно дублированием кода при необходимости иметь для разных булевых свойств, разные текстовые соответствия, напр. "Включено/Выключено", "Активен/Не активен", "Да/Нет" и т.д.. Поэтому я предлагаю добавить атрибут, который будет содержать текстовые значения для необходимого свойства, а конвертер будет их использовать. Для начала создаём атрибут (проверки опущены для экономии места):

using System;

namespace TestApp.Attributes
{
    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false)]
    public class BoolValuesAttribute : Attribute
    {
        public string TrueValue { get; }
        public string FalseValue { get; }

        public BoolValuesAttribute(string trueValue, string falseValue)
        {
            TrueValue = trueValue;
            FalseValue = falseValue;
        }
    }
}

Далее создаём конвертер:

using System;
using System.ComponentModel;
using System.Globalization;
using TestApp.Attributes;

namespace TestApp.TypeConverters
{
    public class BoolTypeConverter : BooleanConverter
    {
        private static BoolValuesAttribute getBoolValuesAttribute(ITypeDescriptorContext context)
            => context
                ?.Instance
                ?.GetType()
                ?.GetProperty(context.PropertyDescriptor.Name)
                ?.GetCustomAttributes(typeof(BoolValuesAttribute), false)
                ?[0] as BoolValuesAttribute;

        public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destType)
        {
            var attribute = getBoolValuesAttribute(context);
            return attribute is not null
                ? (bool)value ? attribute.TrueValue : attribute.FalseValue
                : base.ConvertTo(context, culture, value, destType);
        }

        public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
        {
            var attribute = getBoolValuesAttribute(context);
            return attribute is not null
                ? (string)value == attribute.TrueValue
                : base.ConvertFrom(context, culture, value);
        }
    }
}

Теперь мы можем использовать один и тот-же конвертер с разными текстовыми значениями

[Category("Управление")]
[DisplayName("Активен")]
[Description("Определяет активна ли учётная запись или нет.")]
[BoolValues("активен", "не активен")]
[TypeConverter(typeof(BoolTypeConverter))]
public bool IsActive { get; set; } = true;

[Category("Управление")]
[DisplayName("Проверен")]
[Description("Указывает прошёл ли пользователь верификацию или нет.")]
[BoolValues("прошёл", "пока нет")]
[TypeConverter(typeof(BoolTypeConverter))]
public bool IsVerified { get; set; }

Различные значения с одним и тем-же конвертером

Как заменить стандартное отображение имен членов перечисления?

Для этого декорируем атрибутом Description каждый член перечисления и реализуем свой конвертер наследовав его от EnumConverter:

Реализуем EnumTypeConverter

using System;
using System.ComponentModel;
using System.Globalization;
using System.Reflection;

namespace TestApp.TypeConverters
{
    public class EnumTypeConverter : EnumConverter
    {
        private readonly Type _enumType;

        public EnumTypeConverter(Type type) : base(type)
            => _enumType = type;

        public override bool CanConvertFrom(ITypeDescriptorContext context, Type srcType)
            => srcType == typeof(string);

        public override bool CanConvertTo(ITypeDescriptorContext context, Type destType)
            => destType == typeof(string);

        public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destType)
        {
            FieldInfo fieldInfo = _enumType.GetField(Enum.GetName(_enumType, value));
            return Attribute.GetCustomAttribute(fieldInfo, typeof(DescriptionAttribute)) is DescriptionAttribute attr
                ? attr.Description
                : value.ToString();
        }

        public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
        {
            foreach (FieldInfo fieldInfo in _enumType.GetFields())
            {
                var attr = Attribute.GetCustomAttribute(fieldInfo, typeof(DescriptionAttribute)) as DescriptionAttribute;
                if (attr is not null && (string)value == attr.Description)
                {
                    return Enum.Parse(_enumType, fieldInfo.Name);
                }
            }
            return Enum.Parse(_enumType, (string)value);
        }
    }
}

Так выглядит наше перечисление

using System.ComponentModel;

namespace TestApp
{
    public enum UserRole
    {
        [Description("Не определено")]
        NotSet = 0,
        [Description("Читатель")]
        Reader = 1,
        [Description("Редактор")]
        Editor = 2,
        [Description("Модератор")]
        Moderator = 3,
        [Description("Администратор")]
        Administrator = 4
    }
}

Декорируем свойство

[Category("Управление")]
[DisplayName("Роль пользователя")]
[Description("Определяет права пользователя в системе")]
[TypeConverter(typeof(EnumTypeConverter))]
public UserRole Role { get; set; }

Как показать иконку для каждого значения из перечисления?

Необходимо реализовать своего наследника UITypeEditor и в нём переопределить отрисовку:

Реализация UserRoleEditor

using System.ComponentModel;
using System.Drawing;
using System.Drawing.Design;
using TestApp.Properties;

namespace TestApp.Editors
{
    public class UserRoleEditor : UITypeEditor
    {
        public override bool GetPaintValueSupported(ITypeDescriptorContext context)
            => true;

        public override void PaintValue(PaintValueEventArgs e)
        {
            string resourcename = $"{nameof(UserRole)}_{(UserRole)e.Value}";

            Bitmap image = (Bitmap)Resources.ResourceManager.GetObject(resourcename);
            image.MakeTransparent();

            e.Graphics.DrawImage(image, e.Bounds);
        }
    }
}

Декорируем атрибутом Editor свойство

[Category("Управление")]
[DisplayName("Роль пользователя")]
[Description("Определяет права пользователя в системе")]
[TypeConverter(typeof(EnumTypeConverter))]
[Editor(typeof(UserRoleEditor), typeof(UITypeEditor))]
public UserRole Role { get; set; }

Как организовать выбор значения из выпадающего списка, формируемого программно?

Необходимо реализовать TypeConverter, предоставляющий список, из которого можно будет делать выбор:

public class EmployeePositionTypeConverter : StringConverter
{
  public override bool GetStandardValuesSupported(ITypeDescriptorContext context) => true;

  public override bool GetStandardValuesExclusive(ITypeDescriptorContext context)
  {
    // false - можно вводить вручную
    // true - только выбор из списка
    return true;
  }

  public override StandardValuesCollection GetStandardValues(ITypeDescriptorContext context)
  {
    // возвращаем список строк из настроек программы
    // (базы данных, интернет и т.д.)
    return new StandardValuesCollection(Settings.Default.EmployeePositionList);
  }
}

В данном случае возвращается список строк из настроек программы. Затем нужно задать этот класс в качестве параметра атрибута TypeConverter для редактируемого свойства:

[DisplayName("Должность")]
[Description("Занимаемая должность согласно штатного расписания")]
[Category("3. Дополнительно")]
[TypeConverter(typeof(EmployeePositionTypeConverter))]
public string EmployeePosition { get; set; }

Значения выпадающего списка формируемого программно

Аналогично реализуется и выбор из списка фиксированных значений например double - см. класс PossibleValuesTypeConverter в тестовом проекте.

Как избавиться от ошибки "Конструктор для типа "System.String" не найден" при редактировании свойств типа StringCollection?

Свойства типа StringCollection...

[DisplayName("Дети")]
[Description("Дети")]
[Category("2. Общие")]
[PropertyOrder(30)]
public StringCollection Children { get; set; }

... открываются для редактирования в PropertyGrid, но при попытке добавить строку к списку выдается сообщение об ошибке "Конструктор для типа "System.String" не найден" (Constructor on type "System.String" not found):

Ошибка при редактировании свойства типа StringCollection

Исправить положение можно добавив атрибут Editor со следующими параметрами:

[DisplayName("Дети")]
[Description("Дети")]
[Category("2. Общие")]
[PropertyOrder(30)]
[Editor(
    "System.Windows.Forms.Design.StringCollectionEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a",
    "System.Drawing.Design.UITypeEditor,System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"
)]
public StringCollection Children {get; set; }

Окно редактирования StringCollection примет при этом следующий вид:

Корректное редактирование свойства типа StringCollection

Как реализовать отображение составного свойства?

Бывает так, что тип свойства является сложным объектом, также имеющим свойства и конечно хотелось бы иметь возможность редактировать свойства этого объекта в раскрывающемся списке. Для этого к классу, используемому в качестве типа составного свойства, необходимо применить атрибут TypeConverter с ExpandableObjectConverter в качестве параметра:

[TypeConverter(typeof(ExpandableObjectConverter))]
public class AddressData
{
  public AddressData(string town, string street, uint house) 
  {
    Town = town;
    Street = street;
    House = house;
  }
  
  [DisplayName("Город")]
  [Description("Наименование населенного пункта")]
  public string Town { get; set; }
  
  [DisplayName("Улица")]
  [Description("Название улицы")]
  public string Street { get; set; }
  
  [DisplayName("Дом")]
  [Description("Номер дома")]
  public uint House { get; set; }

  public override string ToString() => $"{Town}, {Street} - {House}";
}

Задавать дополнительные атрибуты для редактируемого свойства не нужно:

[DisplayName("Место жительства")]
[Description("Адрес")]
[Category("3. Дополнительно")]
public AddressData Address { get; set; }

Как организовать выбор файла с заданным расширением?

Для этого необходимо реализовать свой Editor наследуемый от FileNameEditor

Реализация простого редактора имени файла

public class DocFileEditor : FileNameEditor
{
  protected override void InitializeDialog(OpenFileDialog ofd)
  {
    ofd.CheckFileExists = false;
    ofd.Filter = "Doc files (*.doc)|*.doc|All files (*.*)|*.*";
  }
}

После этого можно декорировать свойство:

[DisplayName("Личное дело")]
[Description("Имя файла личного дела")]
[Category("3. Дополнительно")]
[Editor(typeof(DocFileEditor), typeof(UITypeEditor))]
public string PersonalFileName { get; set; }

Как организовать редактирование свойства в собственной форме?

Необходимо реализовать наследника UITypeEditor, обеспечивающего вызов нужной формы (в данном случае IPAddressEditorForm), передачу ей редактируемого значения и получение результата:

public class IPAddressEditor : UITypeEditor 
{
  // Реализация метода редактирования
  public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value)
  {
    if(context != null && provider != null) 
    {
      IWindowsFormsEditorService svc = (IWindowsFormsEditorService)provider.GetService(typeof(IWindowsFormsEditorService));

      if(svc!= null) 
      {
        using (IPAddressEditorForm ipfrm = new IPAddressEditorForm((IPAddress)value))
        {
          if (svc.ShowDialog(ipfrm) == DialogResult.OK)
          {
            value = ipfrm.IP;
          }
        }
      }
    }
    return base.EditValue(context, provider, value);
  }

  // Возвращаем стиль редактора - модальное окно
  public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context)
  {
    return context is null
        ? base.GetEditStyle(context)
        : UITypeEditorEditStyle.Modal;
  }
}

Затем, как обычно, декорируем свойство:

[DisplayName("IP адрес")]
[Description("IP адрес компьютера рабочего места")]
[Category("3. Дополнительно")]
[Editor(typeof(IPAddressEditor), typeof(UITypeEditor))]
public IPAddress IPaddress { get; set; }

Редактирование свойства в собственной форме

Как организовать редактирование свойства в выпадающем списке?

Опять же, реализовать своего наследника UITypeEditor, отображающего выпадающий список с нужным control-ом, передать ему исходное значение редактируемого свойства и принять результат по окончании редактирования (ForeignLangsControl – составной UserControl c элементами, необходимыми для редактирования свойства):

public class ForeignLangsDropDownEditor : UITypeEditor 
{
  public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value)
  {
    if(context != null && provider != null)
    {
      var svc = (IWindowsFormsEditorService)provider.GetService(typeof(IWindowsFormsEditorService));

      if(svc!= null) 
      {
        var flctrl = new ForeignLangsControl((ForeignLangs)value);
        flctrl.Tag = svc;

        svc.DropDownControl(flctrl);

        value = flctrl.Foreignlangs;
      }
    }
    return base.EditValue(context, provider, value);
  }
  
  public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context)
  {
    return context != null
        ? UITypeEditorEditStyle.DropDown
        : base.GetEditStyle(context);
  }
}

Далее декорируем свойство:

[DisplayName("Иностанные языки")]
[Description("Какими иностранными языками владеет")]
[Category("3. Дополнительно")]
[Editor(typeof(ForeignLangsDropDownEditor), typeof(UITypeEditor))]
public ForeignLangs Foreignlangs { get; set; }

Редактирование свойства в выпадающем списке

Как скрыть пароль при редактировании?

Для этого необходимо декорировать свойство атрибутом PasswordPropertyText:

[DisplayName("Пароль")]
[Description("Пароль для доступа на сервер компании")]
[Category("3. Дополнительно")]
[PropertyOrder(80)]
[PasswordPropertyText(true)]
public string Password { get; set; }

Скрытие пароля при редактировании свойства в PropertyGrid

Как управлять видимостью свойства в зависимости от значения другого свойства?

Стандартный атрибут Browsable позволяет задавать видимость свойства в PropertyGrid только на этапе написания кода. Чтобы управлять видимостью свойства в зависимости от значения другого свойства настраиваемого объекта, понадобится новый атрибут - DynamicPropertyFilter и базовый класс – FilterablePropertyBase:

[AttributeUsage(AttributeTargets.Property, Inherited = true)]
public class DynamicPropertyFilterAttribute : Attribute
{
  /// <summary> Название свойства, от которого будет зависить видимость </summary>
  public string PropertyName { get; private set; }

  /// <summary>
  /// Значения свойства, от которого зависит видимость
  /// (через запятую, если несколько), при котором свойство, к
  /// которому применен атрибут, будет видимо.
  /// </summary>
  public string ShowOn { get; private set; }

  /// <summary>
  /// Конструктор
  /// </summary>
  /// <param name="propName">Название свойства, от которого будет зависеть видимость</param>
  /// <param name="value">Значения свойства (через запятую, если несколько),
  /// при котором свойство, к которому применен атрибут, будет видимо.</param>
  public DynamicPropertyFilterAttribute(string propertyName, string value)
  {
    PropertyName = propertyName;
    ShowOn = value;
  }
}

/// <summary>
/// Базовый класс для объектов, поддерживающих динамическое
/// отображение свойств в PropertyGrid
/// </summary>
public class FilterablePropertyBase : ICustomTypeDescriptor
{

  protected PropertyDescriptorCollection GetFilteredProperties(Attribute[] attributes)
  {
    PropertyDescriptorCollection pdc = TypeDescriptor.GetProperties(this, attributes, true);

    var finalProps =  new PropertyDescriptorCollection(new PropertyDescriptor[0]);

    foreach (PropertyDescriptor pd in pdc)
    {
      bool include = false;
      bool dynamic = false;

      foreach (Attribute a in pd.Attributes)
      {
        if (a is DynamicPropertyFilterAttribute)
        {
          dynamic = true;

          var dpf =  (DynamicPropertyFilterAttribute)a;

          PropertyDescriptor temp = pdc[dpf.PropertyName];

          if (dpf.ShowOn.IndexOf(temp.GetValue(this).ToString()) > -1)
          {
            include = true;
          }
        }
      }

      if (!dynamic || include)
      {
        finalProps.Add(pd);
      }
    }

    return finalProps;
  }

  public TypeConverter GetConverter()
            => TypeDescriptor.GetConverter(this, true);

  public EventDescriptorCollection GetEvents(Attribute[] attributes)
            => TypeDescriptor.GetEvents(this, attributes, true);

  EventDescriptorCollection ICustomTypeDescriptor.GetEvents() =>
            TypeDescriptor.GetEvents(this, true);

  public string GetComponentName() =>
            TypeDescriptor.GetComponentName(this, true);

  public object GetPropertyOwner(PropertyDescriptor pd) => this;

  public AttributeCollection GetAttributes() =>
            TypeDescriptor.GetAttributes(this, true);

  public PropertyDescriptorCollection GetProperties(Attribute[] attributes) =>
            GetFilteredProperties(attributes);

  PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties() =>
            GetFilteredProperties(new Attribute[0]);

  public object GetEditor(Type editorBaseType) =>
            TypeDescriptor.GetEditor(this, editorBaseType, true);

  public PropertyDescriptor GetDefaultProperty() =>
            TypeDescriptor.GetDefaultProperty(this, true);

  public EventDescriptor GetDefaultEvent() =>
            TypeDescriptor.GetDefaultEvent(this, true);

  public string GetClassName() => TypeDescriptor.GetClassName(this, true);
}

Указываем базовый класс для класса настраиваемого объекта:

public class PersonData : FilterablePropertyBase
{
  public PersonData() { }
}

А для свойства, видимость которого зависит от другого свойства – атрибут DynamicPropertyFilter:

[DisplayName("Должность")]
[Description("Занимаемая должность согласно штатному расписанию")]
[Category("3. Дополнительно")]
[TypeConverter(typeof(PostTypeConverter))]
public string EmployeePosition { get; set; }

[DisplayName("Личное дело")]
[Description("Имя файла личного дела")]
[Category("3. Дополнительно")]
[Editor(typeof(DocFileEditor), typeof(UITypeEditor))]
[DynamicPropertyFilter(nameof(EmployeePosition), "Уборщик, Инженер, Начальник отдела, Начальник сектора, Секретарь")]
public string PersonalFileName { get; set; }

Также нужно добавить обработчик события PropertyGrid.PropertyValueChanged:

private void propertyGrid1_PropertyValueChanged(object s, PropertyValueChangedEventArgs e)
{
  propertyGrid1.Refresh();
}

В данном случае свойство PersonalFileName (Имя файла личного дела) будет показано в PropertyGrid только тогда, когда свойство EmployeePosition (Должность) будет иметь любое из указанных в атрибуте значений:

Отображение свойства в PropertyGrid в зависимости от другого свойства

Если переключить свойство Должность в значение, отсутствующее в параметре атрибута DynamicPropertyFilter, свойство Личное дело исчезнет из списка отображаемых свойств:

Скрытие свойства в PropertyGrid в зависимости от другого свойства

Аналогично, вторым параметром атрибута DynamicPropertyFilter можно передавать значения параметров других типов, например, перечисления или bool:

[DynamicPropertyFilter(nameof(UserRole), "Moderator,Administrator")]
// ...
[DynamicPropertyFilter(nameof(IsActive), "True")]

Решение не красивое, так как делает данные зависимыми от средств отображения и редактирования.

Как избавиться от стандартного "(Collection)" в правой колонке для свойств-коллекций?

Для этого необходимо реализовать CollectionTypeConverter:

public class CollectionTypeConverter : TypeConverter
{
  public override bool CanConvertTo(ITypeDescriptorContext context, Type destType) =>
            destType == typeof (string);

  public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destType) =>
            "< Список... >";
}

И далее использовать CollectionTypeConverter как параметр в атрибуте TypeConverter:

[DisplayName("Телефоны")]
[Description("Список номеров телефонов")]
[Category("3. Дополнительно")]
[TypeConverter(typeof(CollectionTypeConverter))]
public List<PhoneNumber> Phones { get; set; }

Замена стандартного отображения Collection

При переходе к редактированию коллекции отобразится стандартное окно CollectionEditor с данными редактируемой коллекции:

Как заменить стандартные подписи (Members, properties) в окне Collection Editor?

"Members", "properties", "Add" и "Remove" можно заменить русскими аналогами переключением CurrentUICulture,как это сделано в методе Main() тестовой программы:

Thread.CurrentThread.CurrentUICulture = new CultureInfo("ru-RU", false);

Однако, если надпись "Члены" над списком телефонов вас тоже не устраивает, можно применить и более радикальный способ. Заодно решим и следующую проблему.

Как добавить в Collection Editor окно с расширенной подсказкой по редактируемым свойствам?

Реализуем потомка CollectionEditor - PhoneNumbersCollectionEditor, который умеет запоминать положение и размеры своего окна, меняет стандартные подписи на соответствующие редактируемым данным и добавляет окно с расширенной подсказкой по свойствам:

/// <summary>
/// Свой CollectionEditor для редактирования списка телефонов абонента -
/// для задания заголовка и запоминания положения окна
/// </summary>
public class PhoneNumbersCollectionEditor : CollectionEditor
{
  public PhoneNumbersCollectionEditor(Type t) : base(t) { }

  /// <summary>
  /// Перекрытый метод создания формы редактора -
  /// для сохранения/восстановления размеров и положения окна
  /// </summary>
  protected override CollectionForm CreateCollectionForm()
  {
    CollectionForm collform = base.CreateCollectionForm();

    // подключаем свой обработчик открытия и в нем
    // восстанавливаем положение и размер окна
    collform.Load += delegate(object sender, EventArgs e)
    {
      System.Diagnostics.Trace.WriteLine("collform.Load()");
      collform.HelpButton = false;

      #region Восстановление положения окна и смена заголовка

      // пока это положение первый раз не сохранено, при
      // попытке чтения будет кирдык
      try
      {
        collform.Size = Settings.Default.PhoneNumbersCollectFormSize;
        collform.Location = Settings.Default.PhoneNumbersCollectFormLocation;
        collform.WindowState = Settings.Default.PhoneNumbersCollectFormState;
      }
      catch
      {
        Trace.WriteLine("PhoneNumbersCollectionEditor::CreateCollectionForm() exception");
      }

      collform.Text = "Номера телефонов абонента";

      #endregion
      
      #region Русификация и изменение надписей на форме

      Label BlaBlaProperties = new Label();
      string MembersText = "&Телефоны:";
      string PropertiesText = "&Номера телефонов:";

      // перебираем все control-ы на форме и заменяем неправильные надписи
      foreach (Control ctrl in collform.Controls)
      {
        foreach (Control ctrl1 in ctrl.Controls)
        {
          if (ctrl1.GetType().ToString()== "System.Windows.Forms.Label"
            && (ctrl1.Text == "&Members:" || ctrl1.Text == "&Члены:"))
          {
            ctrl1.Text = MembersText;
          }

          if (ctrl1.GetType().ToString() == "System.Windows.Forms.Label"
            && (ctrl1.Text.Contains("&properties") 
            || ctrl1.Text.Contains("&Cвойства")))
          {
            BlaBlaProperties = (Label)ctrl1;
            BlaBlaProperties.Text = PropertiesText;
          }

          if (ctrl1.GetType().ToString() == "System.ComponentModel.Design.CollectionEditor+FilterListBox")
          {
            // это самый правильный обработчик, но после него
            // срабатывает обработчик формы и меняет надпись на свою
            //((ListBox)ctrl1).SelectedValueChanged +=
            //  delegate(object sndr, EventArgs ea)
            //  {//    Trace.WriteLine("SelectedValueChanged()");
            //    BlaBlaProperties.Text = PropertiesText ;
            //  };
            // вместо одного правильного - два обходных -
            // на смену индекса в листбоксе
            ((ListBox)ctrl1).SelectedIndexChanged += delegate(object sndr, EventArgs ea)
              {
                BlaBlaProperties.Text = PropertiesText;
              };
          }

          if (ctrl1.GetType().ToString() == "System.Windows.Forms.Design.VsPropertyGrid")
          {
            // и на редактирование в PropertyGrid
            ((PropertyGrid)ctrl1).SelectedGridItemChanged +=
              delegate(Object sndr, SelectedGridItemChangedEventArgs segichd)
              {
                BlaBlaProperties.Text = PropertiesText;
              };

            // также сделать доступным окно с подсказками по параметрам 
            // в нижней части
            ((PropertyGrid)ctrl1).HelpVisible = true;
            ((PropertyGrid)ctrl1).HelpBackColor = System.Drawing.SystemColors.Info;
          }

        }
      }

      #endregion
    };

    // подключаем свой обработчик закрытия 
    // и в нем сохраняем положение и размер окна
    collform.FormClosing += delegate(Object sender, FormClosingEventArgs e)
    {
      System.Diagnostics.Trace.WriteLine("collform.FormClosing()");

      #region Сохранение положения окна

      Settings.Default.PhoneNumbersCollectFormState = collform.WindowState;

      if (collform.WindowState == FormWindowState.Normal)
      {
        Settings.Default.PhoneNumbersCollectFormSize = collform.Size;
        Settings.Default.PhoneNumbersCollectFormLocation = collform.Location;
      }
      else
      {
        Settings.Default.PhoneNumbersCollectFormSize = 
          collform.RestoreBounds.Size;
        Settings.Default.PhoneNumbersCollectFormLocation = 
          collform.RestoreBounds.Location;
      }

      #endregion
    };
    return collform;
  }
}

Далее добавляем к свойству-коллекции атрибут Editor со специализированной версией CollectionEditor:

[DisplayName("Телефоны")]
[Description("Список номеров телефонов")]
[Category("3. Дополнительно")]
[TypeConverter(typeof(CollectionTypeConverter))]
[Editor(typeof(PhoneNumbersCollectionEditor), typeof(UITypeEditor))]
public List<PhoneNumber> Phones { get; set; }

Использование PhoneNumbersCollectionEditor

Как задать отличный от алфавитного порядок следования свойств внутри категории?

Нужно реализовать новый атрибут для задания порядка сортировки – PropertyOrderAttribute, и наследника ExpandableObjectConverter (PropertySorter), возвращающего список свойств, упорядоченный согласно значениям, заданным для них в атрибуте PropertyOrder:

public class PropertySorter : ExpandableObjectConverter
{
  public override bool GetPropertiesSupported(ITypeDescriptorContext context) => true;

  /// <summary>
  /// Возвращает упорядоченный список свойств
  /// </summary>
  public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContext context, object value, Attribute[] attributes)
  {
    PropertyDescriptorCollection pdc = TypeDescriptor.GetProperties(value, attributes);

    ArrayList orderedProperties = new ArrayList();

    foreach (PropertyDescriptor pd in pdc)
    {
      Attribute attribute = pd.Attributes[typeof(PropertyOrderAttribute)];

      if (attribute != null)
      {
        // атрибут есть - используем номер п/п из него
        PropertyOrderAttribute poa = (PropertyOrderAttribute)attribute;
        orderedProperties.Add(new PropertyOrderPair(pd.Name, poa.Order));
      }
      else
      {
        // атрибута нет – считаем, что 0
        orderedProperties.Add(new PropertyOrderPair(pd.Name, 0));
      }
    }

    // сортируем по Order-у
    orderedProperties.Sort();

    // формируем список имен свойств
    ArrayList propertyNames = new ArrayList();

    foreach (PropertyOrderPair pop in orderedProperties)
    {
      propertyNames.Add(pop.Name);
    }
      
    return pdc.Sort((string[])propertyNames.ToArray(typeof(string)));
  }
}

[AttributeUsage(AttributeTargets.Property)]
public class PropertyOrderAttribute : Attribute
{
  public PropertyOrderAttribute(int order)
  {
    Order = order;
  }

  public int Order { get; private set; }
}


/// <summary>
/// Пара имя/номер п/п с сортировкой по номеру
/// </summary>
public class PropertyOrderPair : IComparable
{
  private int _order;
  public string Name { get; private set; }

  public PropertyOrderPair(string name, int order)
  {
    Name = name;
    _order = order;
  }
  
  public int CompareTo(object obj)
  {
    int otherOrder = ((PropertyOrderPair)obj)._order;

    if (otherOrder == _order)
    {
      // если Order одинаковый - сортируем по именам
      string otherName = ((PropertyOrderPair)obj).Name;
      return string.Compare(Name, otherName);
    }
    else if (otherOrder > _order)
    {
      return -1;
    }

    return 1;
  }
}

Задаем атрибут TypeConverter с параметром PropertySorter для всего класса с настраиваемыми свойствами и указываем атрибут PropertyOrder для упорядочиваемых свойств:

[TypeConverter(typeof(PropertySorter))]
public class PersonData : FilterablePropertyBase
{

[DisplayName("Место жительства")]
[Description("Адрес")]
[PropertyOrder(30)]
[Category("3. Дополнительно")]
public AddressData Address { get; set; }

[DisplayName("Наличие страховки")]
[Description("Наличие страховки")]
[PropertyOrder(40)]
[Category("3. Дополнительно")]
[TypeConverter(typeof(BooleanTypeConverter))]
public bool Insurance { get; set; }

[DisplayName("Телефоны")]
[Description("Список номеров телефонов")]
[PropertyOrder(50)]
[Category("3. Дополнительно")]
[TypeConverter(typeof(CollectionTypeConverter))]
[Editor(typeof(PhoneNumbersCollectionEditor), typeof(UITypeEditor))]
public List<PhoneNumber> Phones { get; set; }

[DisplayName("Личное дело")]
[Description("Имя файла личного дела")]
[Category("3. Дополнительно")]
[PropertyOrder(20)]
[Editor(typeof(DocFileEditor), typeof(UITypeEditor))]
[DynamicPropertyFilter(nameof(EmployeePosition), "Уборщик, Инженер, Начальник отдела, Начальник сектора, Секретарь")]
public string PersonalFileName { get; set; }

[DisplayName("IP-адрес")]
[Description("IP-адрес компьютера рабочего места")]
[PropertyOrder(70)]
[Category("3. Дополнительно")]
[Editor(typeof(IPAddressEditor), typeof(UITypeEditor))]
public IPAddress IPaddress { get; set; }

[DisplayName("Иностранные языки")]
[Description("Какими иностранными языками владеет")]
[PropertyOrder(60)]
[Category("3. Дополнительно")]
[Editor(typeof(ForeignLangsDropDownEditor), typeof(UITypeEditor))]
public ForeignLangs Foreignlangs { get; set; }

[DisplayName("Должность")]
[Description("Занимаемая должность согласно штатного расписания")]
[Category("3. Дополнительно")]
[PropertyOrder(10)]
[TypeConverter(typeof(EmployeePositionTypeConverter))]
public string EmployeePosition { get; set; }
}

Переопределение порядка сортировки свойств

Как запомнить и восстановить положение разделителя колонок в PropertyGrid?

Это можно сделать следующим образом:

private void SaveGridSplitterPos()
{
  Type type = propertyGrid1.GetType();
  FieldInfo field = type.GetField("gridView",
        BindingFlags.NonPublic | BindingFlags.Instance);
  object valGrid = field.GetValue(propertyGrid1);
  Type gridType = valGrid.GetType();
  Settings.Default.GridSplitterPos = (int)gridType.InvokeMember("GetLabelWidth",
    BindingFlags.Public | BindingFlags.InvokeMethod | BindingFlags.Instance,
    null,
    valGrid, new object[] { });
}

private void RestoreGridSplitterPos()
{
  try
  {
    Type type = propertyGrid1.GetType();
    FieldInfo field = type.GetField("gridView", BindingFlags.NonPublic | BindingFlags.Instance);

    object valGrid = field.GetValue(propertyGrid1);
    Type gridType = valGrid.GetType();
    gridType.InvokeMember("MoveSplitterTo",
      BindingFlags.NonPublic | BindingFlags.InvokeMethod | BindingFlags.Instance,
      null,
      valGrid, new object[] { Settings.Default.GridSplitterPos });
  }
  catch
  {
    Trace.WriteLine("RestoreGridSplitterPos() exception");
  }
}

Вызываются методы перед загрузкой и закрытием окна формы, содержащей PropertyGrid:

private void MainForm_Load(object sender, EventArgs e)
{
  //устанавливаем редактируемый объект
  propertyGrid1.SelectedObject = _personData;

  // восстанавливаем положение окна
  RestorePos();

  // и разделителя колонок в гриде
  RestoreGridSplitterPos();
}

private void MainForm_FormClosing(object sender, FormClosingEventArgs e)
{
  // запоминаем положение окна
  SavePos();

  // и разделителя в гриде
  SaveGridSplitterPos();

  // сохраним возможно измененные значения параметров
  Settings.Default.Save();
}

Поиск по этому блогу

Developer shadow