CodeDomSerializer Класс

Определение

Выполняет сериализацию графы объекта в серии операторов CodeDOM.Serializes an object graph to a series of CodeDOM statements. Этот класс предоставляет абстрактный базовый класс для сериализатора.This class provides an abstract base class for a serializer.

public ref class CodeDomSerializer : System::ComponentModel::Design::Serialization::CodeDomSerializerBase
public ref class CodeDomSerializer abstract
public class CodeDomSerializer : System.ComponentModel.Design.Serialization.CodeDomSerializerBase
public abstract class CodeDomSerializer
type CodeDomSerializer = class
    inherit CodeDomSerializerBase
type CodeDomSerializer = class
Public Class CodeDomSerializer
Inherits CodeDomSerializerBase
Public MustInherit Class CodeDomSerializer
Наследование
CodeDomSerializer
Наследование
CodeDomSerializer
Производный

Примеры

В следующем примере кода показано, как создать пользовательский сериализатор CodeDOM, производный от CodeDomSerializer .The following code example illustrates how to create a custom CodeDOM serializer that derives from 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 для управления созданием кода инициализации компонента для типа компонента во время разработки.You can implement a custom CodeDomSerializer to control the generation of component initialization code for a type of component at design time.

Для реализации пользовательского CodeDomSerializer для типа необходимо выполнить следующие действия.To implement a custom CodeDomSerializer for a type, you must:

  1. Определите класс, производный от класса CodeDomSerializer.Define a class that derives from CodeDomSerializer.

  2. Реализуйте Переопределение методов для методов сериализации или десериализации.Implement method overrides for serialization or deserialization methods. (Дополнительные сведения см. в приведенных ниже сведениях.)(See the information below for details.)

  3. Свяжите пользовательскую CodeDomSerializer реализацию с типом компонента, используя DesignerSerializerAttribute .Associate your custom CodeDomSerializer implementation with a type of component using a DesignerSerializerAttribute.

Реализация метода сериализации для создания кода конфигурации для компонента:To implement a serialization method for generating configuration code for a component:

  1. В классе, производном от CodeDomSerializer , переопределите соответствующий метод сериализации или десериализации базового класса.Within a class that derives from CodeDomSerializer, override an appropriate serialization or deserialization method of the base class.

  2. Если требуется, чтобы сериализатор по умолчанию создавал инструкции кода, выполняющие конфигурацию компонентов по умолчанию, необходимо получить и вызвать базовый сериализатор для компонента.If you want the default serializer to generate code statements that perform the default component configuration, you must obtain and call the base serializer for the component. Чтобы получить базовый сериализатор для компонента, вызовите GetSerializer метод класса, IDesignerSerializationManager переданного в переопределение метода.To obtain the base serializer for the component, call the GetSerializer method of the IDesignerSerializationManager passed to your method override. Передайте GetSerializer методу тип компонента для сериализации конфигурации, а также базовый тип запрашиваемого сериализатора, то есть CodeDomSerializer .Pass the GetSerializer method the type of the component to serialize the configuration of, along with the base type of serializer you are requesting, which is CodeDomSerializer. Вызовите метод с тем же именем, которое вы переопределяете в базовом сериализаторе, используя IDesignerSerializationManager объект и, передаваемый в переопределение метода.Call the method of the same name you are overriding on the base serializer, using the IDesignerSerializationManager and object passed to your method override. При реализации Serialize метода Serialize метод базового сериализатора вернет объект.If you are implementing the Serialize method, the Serialize method of the base serializer will return an object. Тип этого объекта зависит от типа базового сериализатора, который зависит от типа компонента, для которого выполняется сериализация значений.The type of this object depends on the type of base serializer which depends on the type of component you are serializing the values of. При реализации SerializeEvents SerializeProperties метода, или SerializePropertiesToResources необходимо создать новый объект, CodeStatementCollection содержащий сформированные инструкции кода, и передать его в метод.If you are implementing the SerializeEvents, SerializeProperties, or SerializePropertiesToResources method, you must create a new CodeStatementCollection to contain the generated code statements, and pass it to the method.

  3. Если вы вызвали базовый метод сериализатора, у вас будет объект CodeStatementCollection , содержащий инструкции, которые будут созданы для инициализации компонента.If you have called a base serializer method, you will have a CodeStatementCollection that contains the statements to generate to initialize the component. В противном случае следует создать CodeStatementCollection .Otherwise you should create a CodeStatementCollection. В CodeStatement эту коллекцию можно добавлять объекты, представляющие инструкции, которые создаются в коде конфигурации компонента.You can add CodeStatement objects representing statements to generate in the component configuration code to this collection.

  4. Возвращает объект CodeStatementCollection , представляющий исходный код, который создается для настройки компонента.Return the CodeStatementCollection that represents the source code to generate to configure the component.

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

При наследовании от класса CodeDomSerializer необходимо переопределить следующие члены: Deserialize(IDesignerSerializationManager, Object) и Serialize(IDesignerSerializationManager, Object).When you inherit from CodeDomSerializer, you must override the following members: Deserialize(IDesignerSerializationManager, Object) and Serialize(IDesignerSerializationManager, Object).

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

CodeDomSerializer()

Инициализирует новый экземпляр класса CodeDomSerializer.Initializes a new instance of the CodeDomSerializer class.

Методы

Deserialize(IDesignerSerializationManager, Object)

Выполняет десериализацию указанного сериализованного объекта CodeDOM.Deserializes the specified serialized CodeDOM object into an object.

DeserializeExpression(IDesignerSerializationManager, String, CodeExpression)

Выполняет десериализацию указанного выражения.Deserializes the specified expression.

DeserializeExpression(IDesignerSerializationManager, String, CodeExpression)

Выполняет десериализацию заданного выражения в объект в памяти.Deserializes the given expression into an in-memory object.

(Унаследовано от CodeDomSerializerBase)
DeserializeInstance(IDesignerSerializationManager, Type, Object[], String, Boolean)

Возвращает экземпляр заданного типа.Returns an instance of the given type.

(Унаследовано от CodeDomSerializerBase)
DeserializePropertiesFromResources(IDesignerSerializationManager, Object, Attribute[])

Выполняет десериализацию свойств указанного объекта, соответствующего указанному фильтру, если фильтр был указан.Deserializes the properties of the specified object that match the specified filter, if a filter was specified.

DeserializePropertiesFromResources(IDesignerSerializationManager, Object, Attribute[])

Выполняет десериализацию свойств заданного объекта из набора ресурсов нейтральной культуры.Deserializes properties on the given object from the invariant culture's resource bundle.

(Унаследовано от CodeDomSerializerBase)
DeserializeStatement(IDesignerSerializationManager, CodeStatement)

Десериализует указанный оператор.Deserializes the specified statement.

DeserializeStatement(IDesignerSerializationManager, CodeStatement)

Выполняет десериализацию оператора путем обработки и выполнения инструкции CodeDOM.Deserializes a statement by interpreting and executing a CodeDOM statement.

(Унаследовано от CodeDomSerializerBase)
DeserializeStatementToInstance(IDesignerSerializationManager, CodeStatement)

Выполняет десериализацию одиночного оператора.Deserializes a single statement.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetExpression(IDesignerSerializationManager, Object)

Возвращает выражение для заданного объекта.Returns an expression for the given object.

(Унаследовано от CodeDomSerializerBase)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetSerializer(IDesignerSerializationManager, Object)

Определяет местоположение сериализатора для значения заданного объекта.Locates a serializer for the given object value.

(Унаследовано от CodeDomSerializerBase)
GetSerializer(IDesignerSerializationManager, Type)

Определяет местоположение сериализатора для заданного типа.Locates a serializer for the given type.

(Унаследовано от CodeDomSerializerBase)
GetTargetComponentName(CodeStatement, CodeExpression, Type)

Определяет, к какой группе инструкций принадлежит заданная инструкция.Determines which statement group the given statement should belong to.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
GetUniqueName(IDesignerSerializationManager, Object)

Возвращает уникальное имя для заданного объекта.Returns a unique name for the given object.

(Унаследовано от CodeDomSerializerBase)
IsSerialized(IDesignerSerializationManager, Object)

Возвращает значение, указывающее, выполнена ли сериализация заданного объекта.Returns a value indicating whether the given object has been serialized.

(Унаследовано от CodeDomSerializerBase)
IsSerialized(IDesignerSerializationManager, Object, Boolean)

Возвращает значение, указывающее, выполнена ли сериализация заданного объекта (при необходимости рассматривается заранее установленное значение).Returns a value indicating whether the given object has been serialized, optionally considering preset expressions.

(Унаследовано от CodeDomSerializerBase)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
Serialize(IDesignerSerializationManager, Object)

Выполняет сериализацию заданного объекта в объект CodeDOM.Serializes the specified object into a CodeDOM object.

SerializeAbsolute(IDesignerSerializationManager, Object)

Выполняет сериализацию заданного объекта, учитывая значения по умолчанию.Serializes the given object, accounting for default values.

SerializeCreationExpression(IDesignerSerializationManager, Object, Boolean)

Возвращает выражение, представляющее создание заданного объекта.Returns an expression representing the creation of the given object.

(Унаследовано от CodeDomSerializerBase)
SerializeEvent(IDesignerSerializationManager, CodeStatementCollection, Object, EventDescriptor)

Сериализует заданное событие в указанную коллекцию инструкций.Serializes the given event into the given statement collection.

(Унаследовано от CodeDomSerializerBase)
SerializeEvents(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Сериализует все события указанного объекта.Serializes all events of the specified object.

SerializeEvents(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Сериализует заданные события в указанную коллекцию инструкций.Serializes the specified events into the given statement collection.

(Унаследовано от CodeDomSerializerBase)
SerializeMember(IDesignerSerializationManager, Object, MemberDescriptor)

Сериализует заданный элемент в заданном объекте.Serializes the given member on the given object.

SerializeMemberAbsolute(IDesignerSerializationManager, Object, MemberDescriptor)

Сериализует заданный элемент, учитывая значения по умолчанию.Serializes the given member, accounting for default values.

SerializeProperties(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Сериализует все свойства для указанного объекта с помощью указанного фильтра.Serializes all properties for the specified object, using the specified filter.

SerializeProperties(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Сериализует свойства заданного объекта в указанную коллекцию инструкций.Serializes the properties on the given object into the given statement collection.

(Унаследовано от CodeDomSerializerBase)
SerializePropertiesToResources(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Сериализует указанные свойства в ресурсы.Serializes the specified properties to resources.

SerializePropertiesToResources(IDesignerSerializationManager, CodeStatementCollection, Object, Attribute[])

Сериализует свойства заданного объекта в набор ресурсов инвариантного языка и региональных параметров.Serializes the properties on the given object into the invariant culture's resource bundle.

(Унаследовано от CodeDomSerializerBase)
SerializeProperty(IDesignerSerializationManager, CodeStatementCollection, Object, PropertyDescriptor)

Сериализует свойство заданного объекта.Serializes a property on the given object.

(Унаследовано от CodeDomSerializerBase)
SerializeResource(IDesignerSerializationManager, String, Object)

Выполняет сериализацию заданного объекта в набор ресурсов, используя заданное имя ресурса.Serializes the given object into a resource bundle using the given resource name.

SerializeResource(IDesignerSerializationManager, String, Object)

Выполняет сериализацию заданного объекта в набор ресурсов, используя заданное имя ресурса.Serializes the given object into a resource bundle using the given resource name.

(Унаследовано от CodeDomSerializerBase)
SerializeResourceInvariant(IDesignerSerializationManager, String, Object)

Выполняет сериализацию заданного объекта в набор ресурсов, используя заданное имя ресурса с инвариантными региональными параметрами.Serializes the given object into a resource bundle using the given resource name using invariant culture.

SerializeResourceInvariant(IDesignerSerializationManager, String, Object)

Выполняет сериализацию заданного объекта в набор ресурсов, используя заданное имя ресурса.Serializes the given object into a resource bundle using the given resource name.

(Унаследовано от CodeDomSerializerBase)
SerializeToExpression(IDesignerSerializationManager, Object)

Выполняет сериализацию указанного значения в выражение CodeDOM.Serializes the specified value to a CodeDOM expression.

SerializeToExpression(IDesignerSerializationManager, Object)

Выполняет сериализацию заданного объекта в выражение.Serializes the given object into an expression.

(Унаследовано от CodeDomSerializerBase)
SerializeToReferenceExpression(IDesignerSerializationManager, Object)
Является устаревшей.

Выполняет сериализацию указанного значения в выражение CodeDOM.Serializes the specified value to a CodeDOM expression.

SerializeToResourceExpression(IDesignerSerializationManager, Object)

Выполняет сериализацию заданного объекта в выражение.Serializes the given object into an expression.

(Унаследовано от CodeDomSerializerBase)
SerializeToResourceExpression(IDesignerSerializationManager, Object, Boolean)

выполняет сериализацию заданного объекта в выражение, соответствующее для нейтральной культуры.Serializes the given object into an expression appropriate for the invariant culture.

(Унаследовано от CodeDomSerializerBase)
SetExpression(IDesignerSerializationManager, Object, CodeExpression)

Связывает объект с выражением.Associates an object with an expression.

(Унаследовано от CodeDomSerializerBase)
SetExpression(IDesignerSerializationManager, Object, CodeExpression, Boolean)

Связывает объект с выражением (при необходимости указывается заранее установленное выражение).Associates an object with an expression, optionally specifying a preset expression.

(Унаследовано от CodeDomSerializerBase)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к

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