Поделиться через

Определение значений по умолчанию с помощью методов ShouldSerialize и Reset

  • Статья

ShouldSerialize и Reset являются необязательными методами, которые можно указать для свойства, если свойство не имеет простого значения по умолчанию. Если свойство имеет простое значение по умолчанию, следует применить DefaultValueAttribute и указать значение по умолчанию конструктору класса атрибутов. Любой из этих механизмов включает следующие функции в конструкторе:

  • Свойство предоставляет визуальное указание в браузере свойств, если оно было изменено со значения по умолчанию.

  • Пользователь может щелкнуть правой кнопкой мыши по свойству и выбрать Сброс, чтобы восстановить свойство до значения по умолчанию.

  • Конструктор создает более эффективный код.

Заметка

Примените DefaultValueAttribute или укажите ResetPropertyName и ShouldSerializePropertyName методы. Не используйте оба.

При объявлении метода ShouldSerialize или Reset используйте модификатор доступа private. Обычно эти методы вызываются конструктором, а не пользовательским кодом.

Метод ResetPropertyName задает для свойства значение по умолчанию, как показано в следующем фрагменте кода.

Private Sub ResetMyFont()
   MyFont = Nothing
End Sub

private void ResetMyFont()
{
   MyFont = null;
}

Заметка

Если свойство не имеет метода Reset, не отмечено DefaultValueAttributeи не имеет значения по умолчанию, предоставленного в объявлении, параметр Reset для этого свойства отключен в контекстном меню контекстного меню окна "Свойства" конструктора Windows Forms в Visual Studio.

Конструкторы, такие как Visual Studio, используют метод ShouldSerializePropertyName, чтобы проверить, изменилось ли свойство со значения по умолчанию и написать код в форму только в том случае, если свойство изменено, что позволяет повысить эффективность создания кода. Например:

'Returns true if the font has changed; otherwise, returns false.
' The designer writes code to the form only if true is returned.
Private Function ShouldSerializeMyFont() As Boolean
   Return thefont IsNot Nothing
End Function

// Returns true if the font has changed; otherwise, returns false.
// The designer writes code to the form only if true is returned.
private bool ShouldSerializeMyFont()
{
   return thefont != null;
}

Совет

Если вы хотите окончательно предотвратить сериализацию свойства конструктором, добавьте атрибут DesignerSerializationVisibility со значением Hidden.

Ниже приведен полный пример кода.

Option Explicit
Option Strict

Imports System.Drawing
Imports System.Windows.Forms

Public Class MyControl
   Inherits Control

   ' Declare an instance of the Font class
   ' and set its default value to Nothing.
   Private thefont As Font = Nothing

   ' The MyFont property.
   Public Property MyFont() As Font
      ' Note that the Font property never
      ' returns null.
      Get
         If Not (thefont Is Nothing) Then
            Return thefont
         End If
         If Not (Parent Is Nothing) Then
            Return Parent.Font
         End If
         Return Control.DefaultFont
      End Get
      Set
         thefont = value
      End Set
   End Property

   Private Function ShouldSerializeMyFont() As Boolean
      Return thefont IsNot Nothing
   End Function

   Private Sub ResetMyFont()
      MyFont = Nothing
   End Sub
End Class

using System;
using System.Drawing;
using System.Windows.Forms;

public class MyControl : Control {
   // Declare an instance of the Font class
   // and set its default value to null.
   private Font thefont = null;

   // The MyFont property.
   public Font MyFont {
      // Note that the MyFont property never
      // returns null.
      get {
         if (thefont != null) return thefont;
         if (Parent != null) return Parent.Font;
         return Control.DefaultFont;
      }
      set {
         thefont = value;
      }
   }

   private bool ShouldSerializeMyFont()
   {
      return thefont != null;
   }

   private void ResetMyFont()
   {
      MyFont = null;
   }
}

В этом случае, даже если значение приватной переменной, к которой осуществляется доступ через свойство MyFont, равно null, браузер свойств не отображает null, а вместо этого показывает свойство Font родительского объекта, если оно не имеет значения null, или значение по умолчанию Font, указанное в Control. Таким образом, значение по умолчанию для MyFont нельзя просто задать, и DefaultValueAttribute нельзя применить к этому свойству. Вместо этого для свойства MyFont необходимо реализовать методы ShouldSerialize и Reset.

См. также