PropertyDescriptor.ShouldSerializeValue Method (Object)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted.

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

public abstract bool ShouldSerializeValue(
	object component


Type: System.Object

The component with the property to be examined for persistence.

Return Value

Type: System.Boolean

true if the property should be persisted; otherwise, false.

Typically, this method is implemented through reflection.

Notes to Inheritors:

When overridden in a derived class, this method returns true if the current value of the property is different from its default value. It looks for a default value by first looking for a DefaultValueAttribute. If the method finds this attribute, it compares the value of the attribute with the property's current value. If this method cannot find a DefaultValueAttribute, it looks for a "ShouldSerializeMyProperty" method that you need to implement. If it is found, ShouldSerializeValue invokes it. If this method cannot find a DefaultValueAttribute or a "ShouldSerializeMyProperty" method, it cannot create optimizations and it returns true.


The ComponentDesigner class implements special serialization logic for inherited components. For more information, see the remarks in ComponentDesigner.

.NET Framework
Available since 1.1
Return to top