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

WebPart.ShouldSerializeAllowEdit method

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

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

public virtual bool ShouldSerializeAllowEdit()

Return value

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

The ShouldSerializeAllowEdit method is provided because the AllowEdit 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 ShouldSerializeAllowEdit() 
{
    return SerializeAll || defaultAllowEdit != _allowEdit; 
}
Show:
© 2015 Microsoft