StaticSiteMapProvider.Clear Method

Definition

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

protected:
 virtual void Clear();
protected virtual void Clear ();
abstract member Clear : unit -> unit
override this.Clear : unit -> unit
Protected Overridable Sub Clear ()

Examples

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:

// Clean up any collections or other state that an instance of this may hold.
protected override void Clear() {
    lock (this) {
        rootNode = null;
        base.Clear();
    }
}
' SiteMapProvider and StaticSiteMapProvider methods that this derived class must override.
'
' Clean up any collections or other state that an instance of this may hold.
Protected Overrides Sub Clear()
    SyncLock Me
        aRootNode = Nothing
        MyBase.Clear()
    End SyncLock
End Sub

Remarks

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.

Applies to

See also