ProfilePropertySettingsCollection.Remove Method (String)

 
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 a ProfilePropertySettings object from the collection.

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

public void Remove(
	string name
)

Parameters

name
Type: System.String

The name of a ProfilePropertySettings object to remove from the collection.

Exception Condition
ConfigurationException

There is no ProfilePropertySettings object with the specified key in the collection.

- or -

The element has already been removed.

- or -

The collection is read-only.

This method inserts a remove element into the appropriate section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the appropriate section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection.

The following code example shows how to use the Remove method. This code example is part of a larger example provided for the ProfileSection class.

// Remove a PropertySettings from the group.
newPropGroup.PropertySettings.Remove("AvatarImage");
newPropGroup.PropertySettings.RemoveAt(0);

.NET Framework
Available since 2.0
Return to top
Show: