StateBag.Remove(String) Method

Definition

Namespace:

System.Web.UI

Assembly:

System.Web.dll

Removes the specified key/value pair from the StateBag object.

public:
 void Remove(System::String ^ key);

public void Remove (string key);

member this.Remove : string -> unit

Public Sub Remove (key As String)

Parameters

key

String

The item to remove.

Examples

The following code example demonstrates using the Remove method.

void MovePiece(string fromPosition, string toPosition) {
   StateBag bag = ViewState;
   object piece = bag[fromPosition];
   if (piece != null) {
      bag.Remove(fromPosition);
      bag.Add(toPosition, piece);
      RenderBoard();
   }
   else {
      throw new InvalidPositionException("There is no game piece at the \"from\" position."); 
   }
}

Sub MovePiece(fromPosition As String, toPosition As String)
   Dim bag As StateBag = ViewState
   Dim piece As Object = bag(fromPosition)
   If Not (piece Is Nothing) Then
      bag.Remove(fromPosition)
      bag.Add(toPosition, piece)
      RenderBoard()
   Else
      Throw New InvalidPositionException("There is no game piece at the ""from"" position.")
   End If
End Sub 'MovePiece

See also

• ViewState
• Clear()
• Item[String]
• Add(String, Object)