CodeDomSerializer クラス

.NET Framework クラス ライブラリ リファレンス

CodeDomSerializer クラス

オブジェクト グラフを一連の CodeDOM ステートメントにシリアル化します。このクラスは、シリアライザの抽象基本クラスを提供します。

名前空間: System.ComponentModel.Design.Serialization
アセンブリ: System.Design (system.design.dll 内)
構文

Visual Basic (宣言)

Public Class CodeDomSerializer
    Inherits CodeDomSerializerBase

Visual Basic (使用法)

Dim instance As CodeDomSerializer

C#

public class CodeDomSerializer : CodeDomSerializerBase

C++

public ref class CodeDomSerializer : public
 CodeDomSerializerBase

J#

public class CodeDomSerializer extends CodeDomSerializerBase

JScript

public class CodeDomSerializer extends
 CodeDomSerializerBase

解説

カスタム CodeDomSerializer を実装すると、デザイン時にコンポーネントの型に対応するコンポーネント初期化コードの生成を制御できます。

ある型に対するカスタム CodeDomSerializer を実装するには、次の処理を実行する必要があります。

1. CodeDomSerializer から派生するクラスを定義します。

2. シリアル化や逆シリアル化の各メソッドのメソッド オーバーライドを実装します (詳細については、以下を参照してください)。

3. DesignerSerializerAttribute を使用して、カスタム CodeDomSerializer 実装をコンポーネントの型に関連付けます。

コンポーネントの構成コードを生成するためのシリアル化メソッドを実装するには、次の手順に従います。

1. CodeDomSerializer から派生したクラス内で、基本クラスの該当するシリアル化または逆シリアル化のメソッドをオーバーライドします。

2. 既定のコンポーネント構成を実行するコード ステートメントを生成する、既定のシリアライザが必要な場合は、コンポーネントの基本シリアライザを取得して呼び出します。コンポーネントの基本シリアライザを取得するには、メソッド オーバーライドに渡される IDesignerSerializationManager の GetSerializer メソッドを呼び出します。要求するシリアライザの基本型 (CodeDomSerializer) と共に、構成をシリアル化するコンポーネントの型を GetSerializer メソッドに渡します。IDesignerSerializationManager とメソッド オーバーライドに渡されるオブジェクトを使用して、オーバーライドする同じ名前のメソッドを基本シリアライザで呼び出します。Serialize メソッドを実装する場合、基本シリアライザの Serialize メソッドはオブジェクトを返します。このオブジェクトの型は基本シリアライザの型に依存し、基本シリアライザの型は値をシリアル化するコンポーネントの型に依存します。SerializeEvents メソッド、SerializeProperties メソッド、または SerializePropertiesToResources メソッドを実装する場合、生成されるコード ステートメントを格納する新しい CodeStatementCollection を作成し、それをメソッドに渡す必要があります。

3. 基本シリアライザ メソッドを呼び出すと、コンポーネントを初期化するために生成されるステートメントを格納した CodeStatementCollection が得られます。それ以外の場合は、CodeStatementCollection を作成する必要があります。コンポーネントの構成コードに生成されるステートメントを表す CodeStatement オブジェクトをこのコレクションに追加できます。

4. コンポーネントを構成するために生成されるソース コードを表す CodeStatementCollection を返します。

継承時の注意 CodeDomSerializer から継承する場合は、Deserialize および Serialize の両メンバをオーバーライドする必要があります。

使用例

CodeDomSerializer から派生したカスタム CodeDOM シリアライザを作成する方法を次のコード例に示します。

Visual Basic

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

C#

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;
            }
        }
    }

}

J#

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

継承階層

System.Object
   System.ComponentModel.Design.Serialization.CodeDomSerializerBase
    System.ComponentModel.Design.Serialization.CodeDomSerializer
       System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer
       System.Windows.Forms.Design.ImageListCodeDomSerializer

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
CodeDomSerializer メンバ
System.ComponentModel.Design.Serialization 名前空間
DesignerSerializerAttribute
その他の技術情報
動的なソース コードの生成とコンパイル