WebPart.ShouldSerializeHelpLink Method
Returns whether the HelpLink property has changed from its default value.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
Public Overridable Function ShouldSerializeHelpLink As Boolean
'Usage
Dim instance As WebPart
Dim returnValue As Boolean
returnValue = instance.ShouldSerializeHelpLink()
public virtual bool ShouldSerializeHelpLink()
Return Value
Type: System.Boolean
true if the property value has changed from the default value; otherwise, false.
Remarks
The ShouldSerializeHelpLink method is provided because the HelpLink 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 ShouldSerializeHelpLink()
{
return SerializeAll || defaultHelpLink != _helpLink;
}