This documentation is archived and is not being maintained.

ProfileGroupSettingsCollection.Remove Method

Removes a ProfileGroupSettings 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 the ProfileGroupSettings object to remove from the collection.

ExceptionCondition
ConfigurationErrorsException

There is no ProfileGroupSettings object at the specified index in the collection, 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

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: