WebPart.ShouldSerializeHelpMode method

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

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


Public Overridable Function ShouldSerializeHelpMode As Boolean
Dim instance As WebPart
Dim returnValue As Boolean

returnValue = instance.ShouldSerializeHelpMode()
public virtual bool ShouldSerializeHelpMode()

Return value

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


The ShouldSerializeHelpMode method is provided because the HelpMode 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 ShouldSerializeHelpMode() 
    return SerializeAll || defaultHelpMode != _helpMode; 

See also


WebPart class

WebPart members

Microsoft.SharePoint.WebPartPages namespace