Definiowanie wartości domyślnych za pomocą metod ShouldSerialize i Reset

  • Artykuł
  • Czas czytania: 2 min

ShouldSerialize i Reset są opcjonalnymi metodami, które można podać dla właściwości, jeśli właściwość nie ma prostej wartości domyślnej. Jeśli właściwość ma prostą wartość domyślną, DefaultValueAttribute należy zastosować i podać wartość domyślną do konstruktora klasy atrybutu. Jeden z tych mechanizmów umożliwia korzystanie z następujących funkcji w projektancie:

  • Właściwość zapewnia wizualne wskazanie w przeglądarce właściwości, jeśli została zmodyfikowana z wartości domyślnej.

  • Użytkownik może kliknąć prawym przyciskiem myszy właściwość i wybrać polecenie Resetuj , aby przywrócić jej wartość domyślną.

  • Projektant generuje bardziej wydajny kod.

Uwaga

Zastosuj lub podaj DefaultValueAttribute metody ResetPropertyName i ShouldSerializePropertyName . Nie używaj obu tych funkcji.

Podczas deklarowania ShouldSerialize metody lub Reset użyj modyfikatora private dostępu. Te metody są zwykle wywoływane przez projektanta, a nie przez kod użytkownika.

Metoda ResetPropertyName ustawia właściwość na jej wartość domyślną, jak pokazano w poniższym fragmencie kodu.

Private Sub ResetMyFont()
   MyFont = Nothing
End Sub

private void ResetMyFont()
{
   MyFont = null;
}

Uwaga

Reset Jeśli właściwość nie ma metody , DefaultValueAttributenie jest oznaczona za pomocą , i nie ma wartości domyślnej podanej w jej deklaracji, Reset opcja dla tej właściwości jest wyłączona w menu skrótów okna Właściwości projektanta Windows Forms w programie Visual Studio.

Projektanci, tacy jak Visual StudioShouldSerialize, używają metody PropertyName, aby sprawdzić, czy właściwość została zmieniona z wartości domyślnej, i zapisają kod w formularzu tylko wtedy, gdy właściwość zostanie zmieniona, co pozwala na wydajniejsze generowanie kodu. Na przykład:

'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;
}

Porada

Jeśli chcesz trwale uniemożliwić serializację właściwości przez projektanta, dodaj atrybut DesignerSerializationVisibility z wartością Hidden.

Pełny przykład kodu jest następujący.

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;
   }
}

W takim przypadku nawet wtedy, MyFontnullFont gdy wartość zmiennej prywatnej, do której uzyskuje dostęp właściwość , nullprzeglądarka właściwości nie wyświetla wartości ; zamiast tego wyświetla właściwość elementu nadrzędnego, nulljeśli nie jest , FontControllub wartość domyślną zdefiniowaną w . W związku z tym nie MyFont można po prostu ustawić wartości domyślnej dla i nie DefaultValueAttribute można zastosować do tej właściwości. Zamiast tego należy ShouldSerialize zaimplementować Reset metody i dla MyFont właściwości .

Zobacz też