CodeDomSerializer 類別

定義

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

繼承

Object

CodeDomSerializer

繼承

Object

CodeDomSerializerBase

CodeDomSerializer

衍生

System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer

System.Windows.Forms.Design.ImageListCodeDomSerializer

System.Workflow.ComponentModel.Serialization.DependencyObjectCodeDomSerializer

範例

以下程式碼範例說明如何建立由 CodeDomSerializer衍生的自訂 CodeDOM 序列化器。

#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

備註

你可以實作自訂 CodeDomSerializer ，在設計時控制某類型元件初始化程式碼的產生。

要實作一個型別的自訂 CodeDomSerializer ，你必須：

1. 定義一個由 CodeDomSerializer衍生的類別。

2. 為序列化或反序列化方法實作方法覆寫。 （詳情請見下方資訊。）

3. 將你的自訂 CodeDomSerializer 實作與一種元件類型關聯，使用 DesignerSerializerAttribute.

要實作一種用於產生元件組態程式碼的序列化方法：

1. 在由 衍生 CodeDomSerializer的類別中，會覆寫基底類別適當的序列化或反序列化方法。

2. 如果你想讓預設序列化器產生執行預設元件設定的程式碼語句，你必須取得並呼叫該元件的基礎序列化器。 要取得元件的基礎序列化器，請呼叫 GetSerializerIDesignerSerializationManager 傳遞給你的方法覆寫。 將要序列化設定的元件類型傳給GetSerializer方法，以及你所請求的基底序列化器類型。CodeDomSerializer 在基礎序列器上呼叫你覆寫的同名方法，並使用 IDesignerSerializationManager 傳給你方法覆寫的 and 物件。 如果你實作了這個 Serialize 方法， Serialize 基礎序列化器的方法會回傳一個物件。 這個物件的類型取決於基底序列化器的類型，而基底序列化器又取決於你序列化值的元件類型。 如果你實作的是 SerializeEvents、 SerializeProperties或 SerializePropertiesToResources 方法，你必須建立一個 CodeStatementCollection 新的 ，包含產生的程式碼語句，並傳給該方法。

3. 如果你呼叫了一個基礎序列化器方法，你會有一個 CodeStatementCollection 包含要產生的初始化元件的語句。 否則你應該建立一個 CodeStatementCollection。 你可以在這個集合中新增 CodeStatement 代表要在元件配置程式碼中產生的語句的物件。

4. 回傳 CodeStatementCollection 代表要產生的原始碼，以便配置元件。

給實施者的注意事項

當你從 繼承 CodeDomSerializer時，必須覆蓋以下成員： Deserialize(IDesignerSerializationManager, Object) 和 Serialize(IDesignerSerializationManager, Object)。

另請參閱

• DesignerSerializerAttribute
• 動態原始程式碼的產生和編譯