CodeDomSerializer Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Serializuje wykres obiektu do serii instrukcji CodeDOM. Ta klasa udostępnia abstrakcyjną klasę bazową dla serializatora.
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
- Dziedziczenie
-
CodeDomSerializer
- Dziedziczenie
- Pochodne
Przykłady
Poniższy przykład kodu ilustruje sposób tworzenia niestandardowego serializatora CodeDOM, który pochodzi z .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
Uwagi
Można zaimplementować niestandardowy CodeDomSerializer element do kontrolowania generowania kodu inicjowania składnika dla typu składnika w czasie projektowania.
Aby zaimplementować niestandardowy CodeDomSerializer typ, należy wykonać następujące czynności:
Zdefiniuj klasę pochodzącą z klasy CodeDomSerializer.
Zaimplementuj przesłonięcia metod serializacji lub deserializacji. (Aby uzyskać szczegółowe informacje, zobacz poniższe informacje).
Skojarz implementację niestandardową CodeDomSerializer z typem składnika przy użyciu elementu DesignerSerializerAttribute.
Aby zaimplementować metodę serializacji do generowania kodu konfiguracji dla składnika:
W klasie pochodzącej z CodeDomSerializerklasy należy zastąpić odpowiednią metodę serializacji lub deserializacji klasy bazowej.
Jeśli chcesz, aby domyślny serializator wygenerował instrukcje kodu, które wykonują domyślną konfigurację składnika, należy uzyskać i wywołać serializator podstawowy dla składnika. Aby uzyskać podstawowy serializator dla składnika, wywołaj GetSerializer metodę przekazanej IDesignerSerializationManager do przesłonięcia metody. Przekaż metodę GetSerializer typu składnika, aby serializować konfigurację, wraz z podstawowym typem serializatora, którego żądasz, czyli CodeDomSerializer. Wywołaj metodę o tej samej nazwie, którą zastępujesz w serializatorze podstawowym, przy użyciu IDesignerSerializationManager obiektu i przekazanego do zastąpienia metody . Jeśli implementujesz metodę Serialize , Serialize metoda serializatora podstawowego zwróci obiekt. Typ tego obiektu zależy od typu serializatora podstawowego, który zależy od typu składnika serializacji wartości. Jeśli implementujesz metodę SerializeEvents, SerializePropertieslub SerializePropertiesToResources , musisz utworzyć nową CodeStatementCollection , aby zawierała wygenerowane instrukcje kodu i przekazać ją do metody .
Jeśli wywołasz metodę serializatora podstawowego, będziesz mieć CodeStatementCollection element zawierający instrukcje do wygenerowania w celu zainicjowania składnika. W przeciwnym razie należy utworzyć element CodeStatementCollection. Do tej kolekcji można dodawać CodeStatement obiekty reprezentujące instrukcje do generowania w kodzie konfiguracji składnika.
Zwróć wartość CodeStatementCollection reprezentującą kod źródłowy do wygenerowania w celu skonfigurowania składnika.
Uwagi dotyczące implementowania
Podczas dziedziczenia z CodeDomSerializerprogramu należy zastąpić następujące elementy członkowskie: Deserialize(IDesignerSerializationManager, Object) i Serialize(IDesignerSerializationManager, Object).
Konstruktory
CodeDomSerializer() |
Inicjuje nowe wystąpienie klasy CodeDomSerializer. |