CodeDomSerializer Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
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 abstractpublic ref class CodeDomSerializer : System::ComponentModel::Design::Serialization::CodeDomSerializerBasepublic abstract class CodeDomSerializerpublic class CodeDomSerializer : System.ComponentModel.Design.Serialization.CodeDomSerializerBasetype CodeDomSerializer = classtype CodeDomSerializer = class
inherit CodeDomSerializerBasePublic MustInherit Class CodeDomSerializerPublic Class CodeDomSerializer
Inherits CodeDomSerializerBase- Herança
-
CodeDomSerializer
- Herança
- 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:
Defina uma classe derivada de CodeDomSerializer.
Implemente substituições de método para métodos de serialização ou desserialização. (Consulte as informações abaixo para obter detalhes.)
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:
Dentro de uma classe que deriva de CodeDomSerializer, substitua um método de serialização ou desserialização apropriado da classe base.
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 .
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.
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
Aplica-se a
Confira também
- DesignerSerializerAttribute
- Dynamic Source Code Generation and Compilation (Compilação e geração de código-fonte dinâmico)
