CodeDomSerializer Class
Serializes an object graph to a series of CodeDOM statements. This class provides an abstract base class for a serializer.
System.ComponentModel.Design.Serialization::CodeDomSerializerBase
System.ComponentModel.Design.Serialization::CodeDomSerializer
System.ComponentModel.Design.Serialization::CollectionCodeDomSerializer
System.Windows.Forms.Design::ImageListCodeDomSerializer
System.Workflow.ComponentModel.Serialization::DependencyObjectCodeDomSerializer
Assembly: System.Design (in System.Design.dll)
The CodeDomSerializer type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Deserialize | Deserializes the specified serialized CodeDOM object into an object. |
![]() | DeserializeExpression | Deserializes the given expression into an in-memory object. (Inherited from CodeDomSerializerBase.) |
![]() | DeserializeInstance | Returns an instance of the given type. (Inherited from CodeDomSerializerBase.) |
![]() | DeserializePropertiesFromResources | Deserializes properties on the given object from the invariant culture’s resource bundle. (Inherited from CodeDomSerializerBase.) |
![]() | DeserializeStatement | Deserializes a statement by interpreting and executing a CodeDOM statement. (Inherited from CodeDomSerializerBase.) |
![]() | DeserializeStatementToInstance | Deserializes a single statement. |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetExpression | Returns an expression for the given object. (Inherited from CodeDomSerializerBase.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetSerializer(IDesignerSerializationManager, Object) | Locates a serializer for the given object value. (Inherited from CodeDomSerializerBase.) |
![]() | GetSerializer(IDesignerSerializationManager, Type) | Locates a serializer for the given type. (Inherited from CodeDomSerializerBase.) |
![]() | GetTargetComponentName | Determines which statement group the given statement should belong to. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetUniqueName | Returns a unique name for the given object. (Inherited from CodeDomSerializerBase.) |
![]() | IsSerialized(IDesignerSerializationManager, Object) | Returns a value indicating whether the given object has been serialized. (Inherited from CodeDomSerializerBase.) |
![]() | IsSerialized(IDesignerSerializationManager, Object, Boolean) | Returns a value indicating whether the given object has been serialized, optionally considering preset expressions. (Inherited from CodeDomSerializerBase.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | Serialize | Serializes the specified object into a CodeDOM object. |
![]() | SerializeAbsolute | Serializes the given object, accounting for default values. |
![]() | SerializeCreationExpression | Returns an expression representing the creation of the given object. (Inherited from CodeDomSerializerBase.) |
![]() | SerializeEvent | Serializes the given event into the given statement collection. (Inherited from CodeDomSerializerBase.) |
![]() | SerializeEvents | Serializes the specified events into the given statement collection. (Inherited from CodeDomSerializerBase.) |
![]() | SerializeMember | Serializes the given member on the given object. |
![]() | SerializeMemberAbsolute | Serializes the given member, accounting for default values. |
![]() | SerializeProperties | Serializes the properties on the given object into the given statement collection. (Inherited from CodeDomSerializerBase.) |
![]() | SerializePropertiesToResources | Serializes the properties on the given object into the invariant culture’s resource bundle. (Inherited from CodeDomSerializerBase.) |
![]() | SerializeProperty | Serializes a property on the given object. (Inherited from CodeDomSerializerBase.) |
![]() | SerializeResource | Serializes the given object into a resource bundle using the given resource name. (Inherited from CodeDomSerializerBase.) |
![]() | SerializeResourceInvariant | Serializes the given object into a resource bundle using the given resource name. (Inherited from CodeDomSerializerBase.) |
![]() | SerializeToExpression | Serializes the given object into an expression. (Inherited from CodeDomSerializerBase.) |
![]() | SerializeToReferenceExpression | Obsolete. Serializes the specified value to a CodeDOM expression. |
![]() | SerializeToResourceExpression(IDesignerSerializationManager, Object) | Serializes the given object into an expression. (Inherited from CodeDomSerializerBase.) |
![]() | SerializeToResourceExpression(IDesignerSerializationManager, Object, Boolean) | Serializes the given object into an expression appropriate for the invariant culture. (Inherited from CodeDomSerializerBase.) |
![]() | SetExpression(IDesignerSerializationManager, Object, CodeExpression) | Associates an object with an expression. (Inherited from CodeDomSerializerBase.) |
![]() | SetExpression(IDesignerSerializationManager, Object, CodeExpression, Boolean) | Associates an object with an expression, optionally specifying a preset expression. (Inherited from CodeDomSerializerBase.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
You can implement a custom CodeDomSerializer to control the generation of component initialization code for a type of component at design time.
To implement a custom CodeDomSerializer for a type, you must:
Define a class that derives from CodeDomSerializer.
Implement method overrides for serialization or deserialization methods. (See the information below for details.)
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:
Within a class that derives from CodeDomSerializer, override an appropriate serialization or deserialization method of the base class.
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. To obtain the base serializer for the component, call the GetSerializer method of the IDesignerSerializationManager passed to your method override. 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. Call the method of the same name you are overriding on the base serializer, using the IDesignerSerializationManager and object passed to your method override. 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. 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.
If you have called a base serializer method, you will have a CodeStatementCollection that contains the statements to generate to initialize the component. Otherwise you should create a CodeStatementCollection. You can add CodeStatement objects representing statements to generate in the component configuration code to this collection.
Return the CodeStatementCollection that represents the source code to generate to configure the component.
When you inherit from CodeDomSerializer, you must override the following members: Deserialize and Serialize.
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; } } }; }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
