Partilhar via

Definindo valores padrão com os métodos ShouldSerialize e Reset

  • Artigo

ShouldSerialize e Reset são métodos opcionais que você pode fornecer para uma propriedade, se a propriedade não tiver um valor padrão simples. Se a propriedade tiver um valor padrão simples, você deverá aplicar o DefaultValueAttribute e fornecer o valor padrão ao construtor da classe de atributo. Qualquer um desses mecanismos habilita os seguintes recursos no designer:

  • A propriedade fornece indicação visual no navegador de propriedades se ela tiver sido modificada de seu valor padrão.

  • O usuário pode clicar com o botão direito do mouse na propriedade e escolher Redefinir para restaurar a propriedade ao seu valor padrão.

  • O designer gera um código mais eficiente.

Observação

Aplique o DefaultValueAttribute ou forneça os métodos de ResetPropertyName e de ShouldSerializePropertyName. Não utilize ambos.

Ao declarar um método ShouldSerialize ou Reset, use o modificador de acesso private. Esses métodos geralmente são invocados pelo designer e não pelo código do usuário.

O método PropertyName define uma propriedade para seu valor padrão, conforme mostrado no fragmento de código a seguir.

Private Sub ResetMyFont()
   MyFont = Nothing
End Sub

private void ResetMyFont()
{
   MyFont = null;
}

Observação

Se uma propriedade não tiver um método , não estiver marcada com um e não tiver um valor padrão fornecido em sua declaração, a opção para essa propriedade será desabilitada no menu de atalho da janela Propriedades do Windows Forms Designer no Visual Studio.

Designers como o Visual Studio usam o método ShouldSerializePropertyName para verificar se uma propriedade foi alterada de seu valor padrão e gravar código no formulário somente se uma propriedade for alterada, permitindo assim uma geração de código mais eficiente. Por exemplo:

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

Dica

Caso pretenda impedir permanentemente que uma propriedade seja serializada pelo designer, adicione o atributo DesignerSerializationVisibility com o valor de Hidden.

Segue-se um exemplo de código completo.

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

Neste caso, mesmo quando o valor da variável privada acedida pela propriedade MyFont é null, o navegador de propriedades não mostra null; em vez disso, exibe a propriedade Font do elemento pai, se esta não for null, ou o valor padrão Font definido em Control. Assim, o valor padrão para MyFont não pode ser simplesmente definido e um DefaultValueAttribute não pode ser aplicado a essa propriedade. Em vez disso, os métodos ShouldSerialize e Reset devem ser implementados para a propriedade MyFont.

Ver também