ShouldSerializeConnectionID Method
Collapse the table of content
Expand the table of content
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. ArchiveDisclaimer

WebPart.ShouldSerializeConnectionID Method

Windows SharePoint Services 3

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

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

public virtual bool ShouldSerializeConnectionID()

Return Value

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

The ShouldSerializeConnectionID method is provided because the ConnectionID 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 ShouldSerializeConnectionID() 
    return SerializeAll || defaultConnectionID != _connectionID;
© 2015 Microsoft