Compartilhar via


CodeDomSerializer Classe

Definição

Serializa um grafo de objeto em uma série de instruções CodeDOM. Essa classe fornece uma classe base abstrata para um serializador.

public ref class CodeDomSerializer abstract
public ref class CodeDomSerializer : System::ComponentModel::Design::Serialization::CodeDomSerializerBase
public abstract class CodeDomSerializer
public class CodeDomSerializer : System.ComponentModel.Design.Serialization.CodeDomSerializerBase
type CodeDomSerializer = class
type CodeDomSerializer = class
    inherit CodeDomSerializerBase
Public MustInherit Class CodeDomSerializer
Public Class CodeDomSerializer
Inherits CodeDomSerializerBase
Herança
CodeDomSerializer
Herança
CodeDomSerializer
Derivado

Exemplos

O exemplo de código a seguir ilustra como criar um serializador CodeDOM personalizado que deriva de CodeDomSerializer.

#using <System.Drawing.dll>
#using <System.dll>
#using <System.Design.dll>

using namespace System;
using namespace System::CodeDom;
using namespace System::ComponentModel;
using namespace System::ComponentModel::Design;
using namespace System::ComponentModel::Design::Serialization;
using namespace System::Drawing;
using namespace System::Windows::Forms;

namespace CodeDomSerializerSample
{
   ref class MyComponent;
   private ref class MyCodeDomSerializer: public CodeDomSerializer
   {
   public:
      Object^ Deserialize( IDesignerSerializationManager^ manager, Object^ codeObject ) new
      {
         // This is how we associate the component with the serializer.
         CodeDomSerializer^ baseClassSerializer = (CodeDomSerializer^)(
            manager->GetSerializer(
               MyComponent::typeid->BaseType, CodeDomSerializer::typeid ));
         
         /* This is the simplest case, in which the class just calls the base class
            to do the work. */
         return baseClassSerializer->Deserialize( manager, codeObject );
      }

      Object^ Serialize( IDesignerSerializationManager^ manager, Object^ value ) new
      {
         /* Associate the component with the serializer in the same manner as with
            Deserialize */
         CodeDomSerializer^ baseClassSerializer = (CodeDomSerializer^)(
            manager->GetSerializer(
               MyComponent::typeid->BaseType, CodeDomSerializer::typeid ));

         Object^ codeObject = baseClassSerializer->Serialize( manager, value );
         
         /* Anything could be in the codeObject.  This sample operates on a
            CodeStatementCollection. */
         if ( (CodeStatementCollection^)(codeObject) )
         {
            CodeStatementCollection^ statements = (CodeStatementCollection^)(codeObject);
            
            // The code statement collection is valid, so add a comment.
            String^ commentText = "This comment was added to this object by a custom serializer.";
            CodeCommentStatement^ comment = gcnew CodeCommentStatement( commentText );
            statements->Insert( 0, comment );
         }
         return codeObject;
      }
   };

   [DesignerSerializer(CodeDomSerializerSample::MyCodeDomSerializer::typeid,
      CodeDomSerializer::typeid)]
   public ref class MyComponent: public Component
   {
   private:
      String^ localProperty;

   public:
      MyComponent()
      {
         localProperty = "Component Property Value";
      }

      property String^ LocalProperty 
      {
         String^ get()
         {
            return localProperty;
         }
         void set( String^ value )
         {
            localProperty = value;
         }
      }
   };
}
using System;
using System.CodeDom;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.ComponentModel.Design.Serialization;
using System.Drawing;
using System.Windows.Forms;
 
namespace CodeDomSerializerSample
{
    internal class MyCodeDomSerializer : CodeDomSerializer {
        public override object Deserialize(IDesignerSerializationManager manager, object codeObject) {
            // This is how we associate the component with the serializer.
                CodeDomSerializer baseClassSerializer = (CodeDomSerializer)manager.
                GetSerializer(typeof(MyComponent).BaseType, typeof(CodeDomSerializer));

            /* This is the simplest case, in which the class just calls the base class
                to do the work. */
            return baseClassSerializer.Deserialize(manager, codeObject);
        }
 
        public override object Serialize(IDesignerSerializationManager manager, object value) {
            /* Associate the component with the serializer in the same manner as with
                Deserialize */
            CodeDomSerializer baseClassSerializer = (CodeDomSerializer)manager.
                GetSerializer(typeof(MyComponent).BaseType, typeof(CodeDomSerializer));
 
            object codeObject = baseClassSerializer.Serialize(manager, value);
 
            /* Anything could be in the codeObject.  This sample operates on a
                CodeStatementCollection. */
            if (codeObject is CodeStatementCollection) {
                CodeStatementCollection statements = (CodeStatementCollection)codeObject;
 
                // The code statement collection is valid, so add a comment.
                string commentText = "This comment was added to this object by a custom serializer.";
                CodeCommentStatement comment = new CodeCommentStatement(commentText);
                statements.Insert(0, comment);
            }
            return codeObject;
        }
    }
 
    [DesignerSerializer(typeof(MyCodeDomSerializer), typeof(CodeDomSerializer))]
    public class MyComponent : Component {
        private string localProperty = "Component Property Value";
        public string LocalProperty {
            get {
                return localProperty;
            }
            set {
                localProperty = value;
            }
        }
    }
}
Imports System.CodeDom
Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.ComponentModel.Design.Serialization
Imports System.Drawing
Imports System.Windows.Forms

Namespace CodeDomSerializerSample
   Friend Class MyCodeDomSerializer
      Inherits CodeDomSerializer

      Public Overrides Function Deserialize(ByVal manager As IDesignerSerializationManager, _
                                                ByVal codeObject As Object) As Object
         ' This is how we associate the component with the serializer.
         Dim baseClassSerializer As CodeDomSerializer = CType(manager.GetSerializer( _
                GetType(MyComponent).BaseType, GetType(CodeDomSerializer)), CodeDomSerializer)

         ' This is the simplest case, in which the class just calls the base class
         '  to do the work. 
         Return baseClassSerializer.Deserialize(manager, codeObject)
      End Function 'Deserialize

      Public Overrides Function Serialize(ByVal manager As IDesignerSerializationManager, _
                                            ByVal value As Object) As Object
         ' Associate the component with the serializer in the same manner as with
         '  Deserialize
         Dim baseClassSerializer As CodeDomSerializer = CType(manager.GetSerializer( _
                GetType(MyComponent).BaseType, GetType(CodeDomSerializer)), CodeDomSerializer)

         Dim codeObject As Object = baseClassSerializer.Serialize(manager, value)

         ' Anything could be in the codeObject.  This sample operates on a
         '  CodeStatementCollection.
         If TypeOf codeObject Is CodeStatementCollection Then
            Dim statements As CodeStatementCollection = CType(codeObject, CodeStatementCollection)

            ' The code statement collection is valid, so add a comment.
            Dim commentText As String = "This comment was added to this object by a custom serializer."
            Dim comment As New CodeCommentStatement(commentText)
            statements.Insert(0, comment)
         End If
         Return codeObject
      End Function 'Serialize
   End Class

   <DesignerSerializer(GetType(MyCodeDomSerializer), GetType(CodeDomSerializer))> _
   Public Class MyComponent
      Inherits Component
      Private localProperty As String = "Component Property Value"

      Public Property LocalProp() As String
         Get
            Return localProperty
         End Get
         Set(ByVal Value As String)
            localProperty = Value
         End Set
      End Property
   End Class

End Namespace

Comentários

Você pode implementar um personalizado CodeDomSerializer para controlar a geração de código de inicialização de componente para um tipo de componente em tempo de design.

Para implementar um personalizado CodeDomSerializer para um tipo, você deve:

  1. Defina uma classe derivada de CodeDomSerializer.

  2. Implemente substituições de método para métodos de serialização ou desserialização. (Consulte as informações abaixo para obter detalhes.)

  3. Associe sua implementação personalizada CodeDomSerializer a um tipo de componente usando um DesignerSerializerAttribute.

Para implementar um método de serialização para gerar código de configuração para um componente:

  1. Dentro de uma classe que deriva de CodeDomSerializer, substitua um método de serialização ou desserialização apropriado da classe base.

  2. Se você quiser que o serializador padrão gere instruções de código que executam a configuração de componente padrão, você deve obter e chamar o serializador base para o componente. Para obter o serializador de base para o componente, chame o GetSerializer método do IDesignerSerializationManager passado para a substituição do método. Passe o GetSerializer método do tipo do componente para serializar a configuração de, juntamente com o tipo base de serializador que você está solicitando, que é CodeDomSerializer. Chame o método de mesmo nome que você está substituindo no serializador base, usando o IDesignerSerializationManager objeto e passado para a substituição do método. Se você estiver implementando o Serialize método , o Serialize método do serializador base retornará um objeto . O tipo desse objeto depende do tipo de serializador base que depende do tipo de componente do qual você está serializando os valores. Se você estiver implementando o SerializeEventsmétodo , SerializePropertiesou SerializePropertiesToResources , deverá criar um novo CodeStatementCollection para conter as instruções de código geradas e passá-lo para o método .

  3. Se você tiver chamado um método de serializador base, terá um CodeStatementCollection que contém as instruções a serem geradas para inicializar o componente. Caso contrário, você deve criar um CodeStatementCollection. Você pode adicionar CodeStatement objetos que representam instruções a serem geradas no código de configuração do componente a essa coleção.

  4. Retornar o CodeStatementCollection que representa o código-fonte a ser gerado para configurar o componente.

Notas aos Implementadores

Ao herdar de CodeDomSerializer, você deve substituir os seguintes membros: Deserialize(IDesignerSerializationManager, Object) e Serialize(IDesignerSerializationManager, Object).

Construtores

CodeDomSerializer()

Inicializa uma nova instância da classe CodeDomSerializer.

Métodos

Deserialize(IDesignerSerializationManager, Object)

Desserializa o objeto CodeDOM serializado especificado em um objeto.

DeserializeExpression(IDesignerSerializationManager, String, CodeExpression)

Desserializa a expressão especificada.

DeserializeExpression(IDesignerSerializationManager, String, CodeExpression)

Desserializa a expressão especificada em um objeto na memória.

(Herdado de CodeDomSerializerBase)
DeserializeInstance(IDesignerSerializationManager, Type, Object[], String, Boolean)

Retorna uma instância do tipo fornecido.

(Herdado de CodeDomSerializerBase)
DeserializePropertiesFromResources(IDesignerSerializationManager, Object, Attribute[])

Desserializa as propriedades do objeto especificado que correspondem ao filtro especificado, se um filtro é especificado.

DeserializePropertiesFromResources(IDesignerSerializationManager, Object, Attribute[])

Desserializa as propriedades em determinado objeto do grupo de recursos da cultura invariável.

(Herdado de CodeDomSerializerBase)
DeserializeStatement(IDesignerSerializationManager, CodeStatement)

Desserializa a instrução especificada.

DeserializeStatement(IDesignerSerializationManager, CodeStatement)

Desserializa uma instrução, interpretando e executando uma instrução de CodeDOM.

(Herdado de CodeDomSerializerBase)
DeserializeStatementToInstance(IDesignerSerializationManager, CodeStatement)

Desserializa uma única instrução.

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetExpression(IDesignerSerializationManager, Object)

Retorna uma expressão para o objeto fornecido.

(Herdado de CodeDomSerializerBase)
GetHashCode()

Serve como a função de hash padrão.

(Herdado de Object)
GetSerializer(IDesignerSerializationManager, Object)

Localiza um serializador para o valor do objeto especificado.

(Herdado de CodeDomSerializerBase)
GetSerializer(IDesignerSerializationManager, Type)

Localiza um serializador para o tipo especificado.

(Herdado de CodeDomSerializerBase)
GetTargetComponentName(CodeStatement, CodeExpression, Type)

Determina a qual grupo de instruções a instrução fornecida deve pertencer.

GetType()

Obtém o Type da instância atual.

(Herdado de Object)
GetUniqueName(IDesignerSerializationManager, Object)

Retorna um nome exclusivo para o objeto fornecido.

(Herdado de CodeDomSerializerBase)
IsSerialized(IDesignerSerializationManager, Object)

Retorna um valor que indica se o objeto fornecido foi serializado.

(Herdado de CodeDomSerializerBase)
IsSerialized(IDesignerSerializationManager, Object, Boolean)

Retorna um valor que indica se o objeto fornecido foi serializado, considerando opcionalmente expressões predefinidas.

(Herdado de CodeDomSerializerBase)
MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
Serialize(IDesignerSerializationManager, Object)

Serializa o objeto especificado em um objeto CodeDOM.

SerializeAbsolute(IDesignerSerializationManager, Object)

Serializa o objeto fornecido, considerando valores padrão.

SerializeCreationExpression(IDesignerSerializationManager, Object, Boolean)

Retorna uma expressão que representa a criação do objeto especificado.

(Herdado de CodeDomSerializerBase)
SerializeEvent(IDesignerSerializationManager, CodeStatementCollection, Object, EventDescriptor)

Serializa o evento especificado na coleção de instruções especificada.

(Herdado de CodeDomSerializerBase)
SerializeEvents(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Serializa todos os eventos do objeto especificado.

SerializeEvents(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Serializa os eventos especificados na coleção de instruções especificada.

(Herdado de CodeDomSerializerBase)
SerializeMember(IDesignerSerializationManager, Object, MemberDescriptor)

Serializa o membro fornecido no objeto especificado.

SerializeMemberAbsolute(IDesignerSerializationManager, Object, MemberDescriptor)

Serializa o membro fornecido, considerando valores padrão.

SerializeProperties(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Serializa todas as propriedades do objeto especificado, usando o filtro especificado.

SerializeProperties(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Serializa as propriedades no objeto especificado na coleção de instruções especificada.

(Herdado de CodeDomSerializerBase)
SerializePropertiesToResources(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Serializa as propriedades especificadas em recursos.

SerializePropertiesToResources(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Serializa as propriedades no objeto fornecido para o pacote de recursos da cultura invariável.

(Herdado de CodeDomSerializerBase)
SerializeProperty(IDesignerSerializationManager, CodeStatementCollection, Object, PropertyDescriptor)

Serializa uma propriedade no objeto especificado.

(Herdado de CodeDomSerializerBase)
SerializeResource(IDesignerSerializationManager, String, Object)

Serializa o objeto fornecido em um pacote de recursos usando o nome do recurso especificado.

SerializeResource(IDesignerSerializationManager, String, Object)

Serializa o objeto fornecido em um pacote de recursos usando o nome do recurso especificado.

(Herdado de CodeDomSerializerBase)
SerializeResourceInvariant(IDesignerSerializationManager, String, Object)

Serializa o objeto indicado em um pacote de recursos usando o nome de recurso dado usando cultura invariável.

SerializeResourceInvariant(IDesignerSerializationManager, String, Object)

Serializa o objeto fornecido em um pacote de recursos usando o nome do recurso especificado.

(Herdado de CodeDomSerializerBase)
SerializeToExpression(IDesignerSerializationManager, Object)

Serializa o valor especificado para uma expressão CodeDOM.

SerializeToExpression(IDesignerSerializationManager, Object)

Serializa o objeto fornecido em uma expressão.

(Herdado de CodeDomSerializerBase)
SerializeToReferenceExpression(IDesignerSerializationManager, Object)
Obsoleto.
Obsoleto.

Serializa o valor especificado para uma expressão CodeDOM.

SerializeToResourceExpression(IDesignerSerializationManager, Object)

Serializa o objeto fornecido em uma expressão.

(Herdado de CodeDomSerializerBase)
SerializeToResourceExpression(IDesignerSerializationManager, Object, Boolean)

Serializa o objeto fornecido em uma expressão apropriada para a cultura invariável.

(Herdado de CodeDomSerializerBase)
SetExpression(IDesignerSerializationManager, Object, CodeExpression)

Associa um objeto com uma expressão.

(Herdado de CodeDomSerializerBase)
SetExpression(IDesignerSerializationManager, Object, CodeExpression, Boolean)

Associa um objeto com uma expressão especificando, opcionalmente, uma expressão predefinida.

(Herdado de CodeDomSerializerBase)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Aplica-se a

Confira também