This documentation is archived and is not being maintained.

ComponentSerializationService Class

Provides the base class for serializing a set of components or serializable objects into a serialization store.


Namespace:  System.ComponentModel.Design.Serialization
Assembly:  System (in System.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public abstract class ComponentSerializationService

The ComponentSerializationService type exposes the following members.

Protected methodComponentSerializationServiceInitializes a new instance of the ComponentSerializationService class.

Public methodCreateStoreCreates a new SerializationStore.
Public methodDeserialize(SerializationStore)Deserializes the given store to produce a collection of objects.
Public methodDeserialize(SerializationStore, IContainer)Deserializes the given store and populates the given IContainer with deserialized IComponent objects.
Public methodDeserializeTo(SerializationStore, IContainer)Deserializes the given SerializationStore to the given container.
Public methodDeserializeTo(SerializationStore, IContainer, Boolean)Deserializes the given SerializationStore to the given container, optionally validating recycled types.
Public methodDeserializeTo(SerializationStore, IContainer, Boolean, Boolean)Deserializes the given SerializationStore to the given container, optionally applying default property values.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodLoadStoreLoads a SerializationStore from a stream.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSerializeSerializes the given object to the given SerializationStore.
Public methodSerializeAbsoluteSerializes the given object, accounting for default property values.
Public methodSerializeMemberSerializes the given member on the given object.
Public methodSerializeMemberAbsoluteSerializes the given member on the given object, accounting for the default property value.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The ComponentSerializationService serializes a set of components or serializable objects into a serialization store. The store can then be deserialized later. The ComponentSerializationService class differs from other serialization schemes in that the serialization format is opaque, and it allows for partial serialization of objects. For example, you can choose to serialize only selected properties for an object.

This class is abstract. Typically, a DesignerLoader will provide a concrete implementation of this class and add it as a service to its DesignSurface. This allows objects to be serialized in the format best suited for them.

The ComponentSerializationService class replaces the IDesignerSerializationService interface from the .NET Framework version 1.0, although the latter is retained for backward compatibility.


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Notes to Inheritors

When you inherit from the ComponentSerializationService class, you must override all the methods in this class. Some of these methods were designed to throw exceptions, as documented in their corresponding topics; it is strongly recommended that derived classes follow these guidelines to maintain consistency of operation. For more information, see the CodeDomComponentSerializationService class.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.