PropertyDescriptor..::.ShouldSerializeValue Method Home
This page is specific to:.NET Framework Version:1.12.03.03.54.0
.NET Framework Class Library
PropertyDescriptor..::.ShouldSerializeValue Method

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)
Syntax

'Usage

Dim instance As PropertyDescriptor
Dim component As Object
Dim returnValue As Boolean

returnValue = instance.ShouldSerializeValue(component)

'Declaration

Public MustOverride Function ShouldSerializeValue ( _
    component As Object _
) As Boolean

Parameters

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.
Remarks

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.

NoteNote:

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

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

© 2009 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View