CodeDomSerializer Classe

Définition

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

Héritage

Object

CodeDomSerializer

Héritage

Object

CodeDomSerializerBase

CodeDomSerializer

Dérivé

System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer

System.Windows.Forms.Design.ImageListCodeDomSerializer

System.Workflow.ComponentModel.Serialization.DependencyObjectCodeDomSerializer

Exemples

L’exemple de code suivant montre comment créer un sérialiseur CodeDOM personnalisé qui dérive 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

Remarques

Vous pouvez implémenter un personnalisé CodeDomSerializer pour contrôler la génération de code d’initialisation de composant pour un type de composant au moment de la conception.

Pour implémenter un personnalisé CodeDomSerializer pour un type, vous devez :

1. Définissez une classe qui dérive de CodeDomSerializer.

2. Implémentez des remplacements de méthode pour les méthodes de sérialisation ou de désérialisation. (Pour plus d’informations, consultez les informations ci-dessous.)

3. Associez votre implémentation personnalisée CodeDomSerializer à un type de composant à l’aide d’un DesignerSerializerAttribute.

Pour implémenter une méthode de sérialisation pour générer du code de configuration pour un composant :

1. Dans une classe qui dérive de CodeDomSerializer, remplacez une méthode de sérialisation ou de désérialisation appropriée de la classe de base.

2. Si vous souhaitez que le sérialiseur par défaut génère des instructions de code qui effectuent la configuration du composant par défaut, vous devez obtenir et appeler le sérialiseur de base pour le composant. Pour obtenir le sérialiseur de base pour le composant, appelez la GetSerializer méthode du IDesignerSerializationManager passé à votre remplacement de méthode. Transmettez à la GetSerializer méthode le type du composant pour sérialiser la configuration de, ainsi que le type de base de sérialiseur que vous demandez, qui est CodeDomSerializer. Appelez la méthode du même nom que celui que vous remplacez sur le sérialiseur de base, à l’aide de l’objet IDesignerSerializationManager et passé à votre remplacement de méthode. Si vous implémentez la Serialize méthode , la Serialize méthode du sérialiseur de base retourne un objet . Le type de cet objet dépend du type de sérialiseur de base qui dépend du type de composant dont vous sérialisez les valeurs. Si vous implémentez la SerializeEventsméthode , SerializePropertiesou SerializePropertiesToResources , vous devez créer un nouveau CodeStatementCollection pour contenir les instructions de code générées et le transmettre à la méthode .

3. Si vous avez appelé une méthode de sérialiseur de base, vous aurez un CodeStatementCollection qui contient les instructions à générer pour initialiser le composant. Sinon, vous devez créer un CodeStatementCollection. Vous pouvez ajouter à CodeStatement cette collection des objets représentant des instructions à générer dans le code de configuration du composant.

4. Retourne le CodeStatementCollection qui représente le code source à générer pour configurer le composant.

Notes pour les responsables de l’implémentation

Lorsque vous héritez de CodeDomSerializer, vous devez substituer les membres suivants : Deserialize(IDesignerSerializationManager, Object) et Serialize(IDesignerSerializationManager, Object).

Constructeurs

Méthodes

S’applique à

Voir aussi

• DesignerSerializerAttribute
• Génération et compilation de code source dynamique