Export (0) Print
Expand All

StaticSiteMapProvider.Clear Method

Removes all elements in the collections of child and parent site map nodes that the StaticSiteMapProvider tracks as part of its state.

Namespace:  System.Web
Assembly:  System.Web (in System.Web.dll)

protected virtual void Clear()

Classes that are derived from the StaticSiteMapProvider class can override the Clear method to perform additional cleanup, depending on what state the derived classes maintain.

The Clear method does not reset state that is initialized during the Initialize method—it resets only state that is initialized during the BuildSiteMap method.

The following code example demonstrates how to override the Clear method to perform additional cleanup of state that is maintained by the class.

This code example is part of a larger example provided for the StaticSiteMapProvider class.

// Clean up any collections or other state that an instance of this may hold. 
protected override void Clear() {
    lock (this) {
        rootNode = null;
        base.Clear();
    }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft