CodeDomSerializer Класс

Определение

Пространство имен:

System.ComponentModel.Design.Serialization

Сборка:

System.Windows.Forms.Design.dll

Выполняет сериализацию графы объекта в серии операторов CodeDOM. Этот класс предоставляет абстрактный базовый класс для сериализатора.

public ref class CodeDomSerializer : System::ComponentModel::Design::Serialization::CodeDomSerializerBase

public class CodeDomSerializer : System.ComponentModel.Design.Serialization.CodeDomSerializerBase

type CodeDomSerializer = class
    inherit CodeDomSerializerBase

Public Class CodeDomSerializer
Inherits CodeDomSerializerBase

Наследование

Object

CodeDomSerializerBase

CodeDomSerializer

Производный

System.ComponentModel.Design.Serialization.CollectionCodeDomSerializer

System.Windows.Forms.Design.ImageListCodeDomSerializer

System.Workflow.ComponentModel.Serialization.DependencyObjectCodeDomSerializer

Примеры

В следующем примере кода показано, как создать пользовательский сериализатор CodeDOM, производный от 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

Комментарии

Можно реализовать пользовательский CodeDomSerializer для управления созданием кода инициализации компонента для типа компонента во время разработки.

Чтобы реализовать пользовательский CodeDomSerializer для типа, необходимо:

1. Определите класс, производный от класса CodeDomSerializer.

2. Реализуйте переопределения методов сериализации или десериализации. (Дополнительные сведения см. в приведенных ниже сведениях.)

3. Свяжите пользовательскую CodeDomSerializer реализацию с типом компонента с помощью DesignerSerializerAttribute.

Чтобы реализовать метод сериализации для создания кода конфигурации для компонента, выполните следующие действия.

1. В классе, производном от CodeDomSerializer, переопределите соответствующий метод сериализации или десериализации базового класса.

2. Если требуется, чтобы сериализатор по умолчанию создавал операторы кода, выполняющие конфигурацию компонента по умолчанию, необходимо получить и вызвать базовый сериализатор для компонента. Чтобы получить базовый сериализатор для компонента, вызовите GetSerializer метод объекта , переданного IDesignerSerializationManager в переопределение метода. GetSerializer Передайте методу тип компонента для сериализации конфигурации, а также базовый тип сериализатора, который вы запрашиваете, — CodeDomSerializer. Вызовите метод с тем же именем, который вы переопределяете в базовом сериализаторе, используя IDesignerSerializationManager объект и , переданный в переопределение метода. При реализации Serialize метода Serialize метод базового сериализатора вернет объект . Тип этого объекта зависит от типа базового сериализатора, который зависит от типа компонента, для которого выполняется сериализация значений. При реализации SerializeEventsметода , SerializePropertiesили SerializePropertiesToResources необходимо создать новый CodeStatementCollection объект , содержащий созданные операторы кода, и передать его методу .

3. Если вы вызвали метод базового сериализатора, у CodeStatementCollection вас будет объект , содержащий инструкции для создания для инициализации компонента. В противном случае следует создать CodeStatementCollection. В эту коллекцию можно добавить CodeStatement объекты, представляющие инструкции для создания в коде конфигурации компонента.

4. Возвращает объект , CodeStatementCollection представляющий исходный код, создаваемый для настройки компонента.

Примечания для тех, кто реализует этот метод

При наследовании от класса CodeDomSerializer необходимо переопределить следующие члены: Deserialize(IDesignerSerializationManager, Object) и Serialize(IDesignerSerializationManager, Object).

Конструкторы

CodeDomSerializer()

Инициализирует новый экземпляр класса CodeDomSerializer.

Методы

Deserialize(IDesignerSerializationManager, Object)	Выполняет десериализацию указанного сериализованного объекта CodeDOM.
DeserializeExpression(IDesignerSerializationManager, String, CodeExpression)	Выполняет десериализацию заданного выражения в объект в памяти. (Унаследовано от CodeDomSerializerBase)
DeserializeInstance(IDesignerSerializationManager, Type, Object[], String, Boolean)	Возвращает экземпляр заданного типа. (Унаследовано от CodeDomSerializerBase)
DeserializePropertiesFromResources(IDesignerSerializationManager, Object, Attribute[])	Выполняет десериализацию свойств заданного объекта из набора ресурсов нейтральной культуры. (Унаследовано от CodeDomSerializerBase)
DeserializeStatement(IDesignerSerializationManager, CodeStatement)	Выполняет десериализацию оператора путем обработки и выполнения инструкции CodeDOM. (Унаследовано от CodeDomSerializerBase)
DeserializeStatementToInstance(IDesignerSerializationManager, CodeStatement)	Выполняет десериализацию одиночного оператора.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetExpression(IDesignerSerializationManager, Object)	Возвращает выражение для заданного объекта. (Унаследовано от CodeDomSerializerBase)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetSerializer(IDesignerSerializationManager, Object)	Определяет местоположение сериализатора для значения заданного объекта. (Унаследовано от CodeDomSerializerBase)
GetSerializer(IDesignerSerializationManager, Type)	Определяет местоположение сериализатора для заданного типа. (Унаследовано от CodeDomSerializerBase)
GetTargetComponentName(CodeStatement, CodeExpression, Type)	Определяет, к какой группе инструкций принадлежит заданная инструкция.
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
GetUniqueName(IDesignerSerializationManager, Object)	Возвращает уникальное имя для заданного объекта. (Унаследовано от CodeDomSerializerBase)
IsSerialized(IDesignerSerializationManager, Object)	Возвращает значение, указывающее, выполнена ли сериализация заданного объекта. (Унаследовано от CodeDomSerializerBase)
IsSerialized(IDesignerSerializationManager, Object, Boolean)	Возвращает значение, указывающее, выполнена ли сериализация заданного объекта (при необходимости рассматривается заранее установленное значение). (Унаследовано от CodeDomSerializerBase)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
Serialize(IDesignerSerializationManager, Object)	Выполняет сериализацию заданного объекта в объект CodeDOM.
SerializeAbsolute(IDesignerSerializationManager, Object)	Выполняет сериализацию заданного объекта, учитывая значения по умолчанию.
SerializeCreationExpression(IDesignerSerializationManager, Object, Boolean)	Возвращает выражение, представляющее создание заданного объекта. (Унаследовано от CodeDomSerializerBase)
SerializeEvent(IDesignerSerializationManager, CodeStatementCollection, Object, EventDescriptor)	Сериализует заданное событие в указанную коллекцию инструкций. (Унаследовано от CodeDomSerializerBase)
SerializeEvents(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])	Сериализует заданные события в указанную коллекцию инструкций. (Унаследовано от CodeDomSerializerBase)
SerializeMember(IDesignerSerializationManager, Object, MemberDescriptor)	Сериализует заданный элемент в заданном объекте.
SerializeMemberAbsolute(IDesignerSerializationManager, Object, MemberDescriptor)	Сериализует заданный элемент, учитывая значения по умолчанию.
SerializeProperties(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])	Сериализует свойства заданного объекта в указанную коллекцию инструкций. (Унаследовано от CodeDomSerializerBase)
SerializePropertiesToResources(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])	Сериализует свойства заданного объекта в набор ресурсов инвариантного языка и региональных параметров. (Унаследовано от CodeDomSerializerBase)
SerializeProperty(IDesignerSerializationManager, CodeStatementCollection, Object, PropertyDescriptor)	Сериализует свойство заданного объекта. (Унаследовано от CodeDomSerializerBase)
SerializeResource(IDesignerSerializationManager, String, Object)	Выполняет сериализацию заданного объекта в набор ресурсов, используя заданное имя ресурса. (Унаследовано от CodeDomSerializerBase)
SerializeResourceInvariant(IDesignerSerializationManager, String, Object)	Выполняет сериализацию заданного объекта в набор ресурсов, используя заданное имя ресурса. (Унаследовано от CodeDomSerializerBase)
SerializeToExpression(IDesignerSerializationManager, Object)	Выполняет сериализацию заданного объекта в выражение. (Унаследовано от CodeDomSerializerBase)
SerializeToReferenceExpression(IDesignerSerializationManager, Object)	Устаревшие.. Выполняет сериализацию указанного значения в выражение CodeDOM.
SerializeToResourceExpression(IDesignerSerializationManager, Object)	Выполняет сериализацию заданного объекта в выражение. (Унаследовано от CodeDomSerializerBase)
SerializeToResourceExpression(IDesignerSerializationManager, Object, Boolean)	выполняет сериализацию заданного объекта в выражение, соответствующее для нейтральной культуры. (Унаследовано от CodeDomSerializerBase)
SetExpression(IDesignerSerializationManager, Object, CodeExpression)	Связывает объект с выражением. (Унаследовано от CodeDomSerializerBase)
SetExpression(IDesignerSerializationManager, Object, CodeExpression, Boolean)	Связывает объект с выражением (при необходимости указывается заранее установленное выражение). (Унаследовано от CodeDomSerializerBase)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• DesignerSerializerAttribute
• Динамическое создание и компиляция исходного кода