CodeDomSerializer-Klasse
Serialisiert ein Objektdiagramm in eine Reihe von CodeDOM-Anweisungen. Diese Klasse stellt eine abstrakte Basisklasse für ein Serialisierungsprogramm bereit.
Namespace: System.ComponentModel.Design.Serialization
Assembly: System.Design (in system.design.dll)
Syntax
'Declaration
Public Class CodeDomSerializer
Inherits CodeDomSerializerBase
'Usage
Dim instance As CodeDomSerializer
public class CodeDomSerializer : CodeDomSerializerBase
public ref class CodeDomSerializer : public CodeDomSerializerBase
public class CodeDomSerializer extends CodeDomSerializerBase
public class CodeDomSerializer extends CodeDomSerializerBase
Hinweise
Sie können einen benutzerdefinierten CodeDomSerializer implementieren, um zur Entwurfszeit die Generierung von Initialisierungscode für Komponenten eines bestimmten Typs zu steuern.
Führen Sie zum Implementieren eines benutzerdefinierten CodeDomSerializer für einen Typ die folgenden Aktionen durch:
Definieren einer Klasse, die von CodeDomSerializer abgeleitet ist.
Implementieren von Methodenüberschreibungen für Serialisierungs- oder Deserialisierungmethoden. (Weitere Informationen finden Sie weiter unten.)
Zuordnen der benutzerdefinierten CodeDomSerializer-Implementierung zu einem Komponententyp unter Verwendung eines DesignerSerializerAttribute.
So implementieren Sie eine Serialisierungsmethode zum Generieren von Konfigurationscode für eine Komponente:
Überschreiben Sie in einer von CodeDomSerializer abgeleiteten Klasse eine entsprechende Serialisierungs- oder Deserialisierungsmethode der Basisklasse.
Wenn das Standardserialisierungsprogramm Codeanweisungen für die Durchführung der Standardkonfiguration der Komponente generieren soll, müssen Sie das Basisserialisierungsprogramm für die Komponente abrufen und aufrufen. Um das Basisserialisierungsprogramm für die Komponente abzurufen, rufen Sie die GetSerializer-Methode des an die Methodenüberschreibung übergebenen IDesignerSerializationManager auf. Übergeben Sie den Typ der Komponente, deren Konfiguration serialisiert werden soll, zusammen mit dem Basistyp des angeforderten Serialisierungsprogramms, d. h. CodeDomSerializer, an die GetSerializer-Methode. Rufen Sie unter Verwendung des an die Methodenüberschreibung übergebenen IDesignerSerializationManager und Objekts die Methode auf, die denselben Namen wie die im Basisserialisierungsprogramm überschriebene Methode hat. Wenn Sie die Serialize-Methode implementieren, gibt die Serialize-Methode des Basisserialisierungsprogramms ein Objekt zurück. Der Typ dieses Objekts hängt vom Typ des Basisserialisierungsprogramms ab, der wiederum vom Typ der Komponente abhängig ist, deren Werte Sie serialisieren. Wenn Sie die SerializeEvents-Methode, die SerializeProperties-Methode oder die SerializePropertiesToResources-Methode implementieren, müssen Sie eine neue CodeStatementCollection erstellen, die die generierten Codeanweisungen enthalten soll, und diese an die Methode übergeben.
Wenn Sie eine Methode des Basisserialisierungsprogramms aufgerufen haben, verfügen Sie über eine CodeStatementCollection, die die zu generierenden Anweisungen zum Initialisieren der Komponente enthält. Andernfalls müssen Sie eine CodeStatementCollection erstellen. Sie können dieser Auflistung CodeStatement-Objekte hinzufügen, die Anweisungen darstellen, die im Konfigurationscode der Komponente generiert werden sollen.
Geben Sie die CodeStatementCollection zurück, die den zum Konfigurieren der Komponente zu generierenden Quellcode darstellt.
Hinweise für Erben Wenn Sie CodeDomSerializer vererben, müssen Sie die folgenden Member überschreiben: Deserialize und Serialize.
Beispiel
Im folgenden Codebeispiel wird veranschaulicht, wie ein von CodeDomSerializer abgeleitetes benutzerdefiniertes CodeDOM-Serialisierungsprogramm erstellt wird.
Imports System
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 'MyCodeDomSerializer
<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 'MyComponent
End Namespace
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;
}
}
}
}
import System.*;
import System.CodeDom.*;
import System.ComponentModel.*;
import System.ComponentModel.Design.*;
import System.ComponentModel.Design.Serialization.*;
import System.Drawing.*;
import System.Windows.Forms.*;
class MyCodeDomSerializer extends CodeDomSerializer
{
public Object Deserialize(IDesignerSerializationManager manager,
Object codeObject) {
// This is how we associate the component with the serializer.
CodeDomSerializer baseClassSerializer = (CodeDomSerializer)
manager.GetSerializer(MyComponent.class.ToType().get_BaseType(),
CodeDomSerializer.class.ToType());
/* This is the simplest case, in which the class just calls the base
class to do the work.
*/
return baseClassSerializer.Deserialize(manager, codeObject);
} //Deserialize
public Object Serialize(IDesignerSerializationManager manager,
Object value)
{
/* Associate the component with the serializer in the same manner as
with Deserialize
*/
CodeDomSerializer baseClassSerializer = (CodeDomSerializer)
manager.GetSerializer(MyComponent.class.ToType().
get_BaseType(), CodeDomSerializer.class.ToType());
Object codeObject = baseClassSerializer.Serialize(manager, value);
/* Anything could be in the codeObject. This sample operates on a
CodeStatementCollection.
*/
if (codeObject instanceof 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;
} //Serialize
} //MyCodeDomSerializer
/** @attribute DesignerSerializer(MyCodeDomSerializer.class,
CodeDomSerializer.class)
*/
public class MyComponent extends Component
{
private String localProperty = "Component Property Value";
/** @property
*/
public String get_LocalProperty()
{
return localProperty;
} //get_LocalProperty
/** @property
*/
public void set_LocalProperty (String value )
{
localProperty = value;
} //set_LocalProperty
} //MyComponent
Vererbungshierarchie
System.Object
System.ComponentModel.Design.Serialization.CodeDomSerializerBase
System.ComponentModel.Design.Serialization.CodeDomSerializer
System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer
System.Windows.Forms.Design.ImageListCodeDomSerializer
Threadsicherheit
Alle öffentlichen statischen (Shared in Visual Basic) Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.
Plattformen
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.
Versionsinformationen
.NET Framework
Unterstützt in: 2.0, 1.1, 1.0
Siehe auch
Referenz
CodeDomSerializer-Member
System.ComponentModel.Design.Serialization-Namespace
DesignerSerializerAttribute