Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
ShouldSerializeIsIncludedFilter method
Collapse the table of content
Expand the table of content

WebPart.ShouldSerializeIsIncludedFilter method

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

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

public virtual bool ShouldSerializeIsIncludedFilter()

Return value

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

The ShouldSerializeIsIncludedFilter method is provided because the IsIncludedFilter 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 ShouldSerializeIsIncludedFilter() 
{
    return SerializeAll || defaultIsIncludedFilter != 
        _isIncludedFilter; 
}  
Show:
© 2015 Microsoft