StaticSiteMapProvider::Clear Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.
   virtual void Clear() override
   {
      System::Threading::Monitor::Enter( this );
      try
      {
         rootNode = nullptr;
         StaticSiteMapProvider::Clear();
      }
      finally
      {
         System::Threading::Monitor::Exit( this );
      }

   }


public:

.NET Framework
Available since 2.0
Return to top
Show: