Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.

WebPart.ShouldSerializeDetailLink Method

Windows SharePoint Services 3

Returns whether the DetailLink property has changed from its default value.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

public virtual bool ShouldSerializeDetailLink()

Return Value

Type: System.Boolean
true if the property value has changed from the default value; otherwise, false.

The ShouldSerializeDetailLink method is provided because the DetailLink property does not have a simple default value. This method indicates whether the property has changed from its default value. You typically invoke this method if you are developing a designer for the WebPart class, or are creating your own Web Part or tool part, so that you can avoid unnecessarily persisting default values.

If you override this function, your function should return true if the corresponding property has changed from its default or if the SerializeAll property is true. For example:

public override bool ShouldSerializeDetailLink) 
    return SerializeAll || defaultDetailLink != _detailLink; 

Community Additions

© 2015 Microsoft