PersonalizationDictionary.Remove(String) Method

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Removes a custom state entry based on the provided key.

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

public virtual void Remove (string key);

abstract member Remove : string -> unit
override this.Remove : string -> unit

Public Overridable Sub Remove (key As String)

Parameters

key

String

The key of the entry to be removed.

Exceptions

ArgumentNullException

key is null.

ArgumentException

key is either an empty string (""), or trimming key results in an empty string.

Remarks

Internally, when you remove a custom state entry, the count of the personalization dictionary is decremented by one. Any enumerators currently active against the dictionary should be invalidated.

No error occurs if you attempt to remove a nonexistent key.