Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

RootProfilePropertySettingsCollection Class

Acts as the top of a two-level named hierarchy of ProfilePropertySettingsCollection collections.

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

[ConfigurationCollectionAttribute(typeof(ProfilePropertySettings))]
public sealed class RootProfilePropertySettingsCollection : ProfilePropertySettingsCollection

The RootProfilePropertySettingsCollection type exposes the following members.

  NameDescription
Public methodRootProfilePropertySettingsCollectionInfrastructure. Initializes a new instance of the RootProfilePropertySettingsCollection class using default settings.
Top

  NameDescription
Protected propertyAddElementNameGets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public propertyAllKeysReturns an array containing the names of all the ProfileSection objects contained in the collection. (Inherited from ProfilePropertySettingsCollection.)
Protected propertyAllowClearInfrastructure. Gets a value indicating whether the <clear> element is valid as a ProfilePropertySettings object. (Inherited from ProfilePropertySettingsCollection.)
Protected propertyClearElementNameGets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public propertyCollectionTypeGets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Public propertyCountGets the number of elements in the collection. (Inherited from ConfigurationElementCollection.)
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementNameGets the name used to identify this collection of elements in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Public propertyEmitClearGets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection.)
Protected propertyEvaluationContextGets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Public propertyGroupSettingsGets a ProfileGroupSettingsCollection containing a collection of ProfileGroupSettings objects.
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized (thread safe). (Inherited from ConfigurationElementCollection.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Public propertyItem[Int32]Gets or sets the ProfilePropertySettings object at the specified index location. (Inherited from ProfilePropertySettingsCollection.)
Public propertyItem[String]Gets or sets the ProfilePropertySettings object with the specified name. (Inherited from ProfilePropertySettingsCollection.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Protected propertyPropertiesGets a collection of configuration properties. (Inherited from ProfilePropertySettingsCollection.)
Protected propertyRemoveElementNameGets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public propertySyncRootGets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected propertyThrowOnDuplicateGets a value indicating whether an error should be thrown if an attempt to create a duplicate object is made. (Inherited from ProfilePropertySettingsCollection.)
Top

  NameDescription
Public methodAddAdds a ProfilePropertySettings object to the collection. (Inherited from ProfilePropertySettingsCollection.)
Protected methodBaseAdd(ConfigurationElement)Adds a configuration element to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseAdd(ConfigurationElement, Boolean)Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseAdd(Int32, ConfigurationElement)Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseClearRemoves all configuration element objects from the collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGet(Int32)Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGet(Object)Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGetAllKeysReturns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGetKeyGets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected methodBaseIndexOfThe index of the specified ConfigurationElement. (Inherited from ConfigurationElementCollection.)
Protected methodBaseIsRemovedGets a value indicating whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseRemoveRemoves a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseRemoveAtRemoves the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Public methodClearRemoves all ProfilePropertySettings objects from the collection. (Inherited from ProfilePropertySettingsCollection.)
Public methodCopyToCopies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.)
Protected methodCreateNewElement()When overridden in a derived class, creates a new ConfigurationElement. (Inherited from ProfilePropertySettingsCollection.)
Protected methodCreateNewElement(String)Creates a new ConfigurationElement when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsInfrastructure. Compares the current RootProfilePropertySettingsCollection object to another A RootProfilePropertySettingsCollection object. (Overrides ConfigurationElementCollection.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGet(Int32)Returns the ProfileSection object at the specified index. (Inherited from ProfilePropertySettingsCollection.)
Public methodGet(String)Returns the ProfileSection object with the specified name. (Inherited from ProfilePropertySettingsCollection.)
Protected methodGetElementKeyGets the key for the specified configuration element. (Inherited from ProfilePropertySettingsCollection.)
Public methodGetEnumeratorInfrastructure. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Public methodGetHashCodeGenerates a hash code for the collection. (Overrides ConfigurationElementCollection.GetHashCode().)
Public methodGetKeyGets the name of the ProfilePropertySettings at the specified index location. (Inherited from ProfilePropertySettingsCollection.)
Protected methodGetTransformedAssemblyStringReturns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.)
Protected methodGetTransformedTypeStringReturns the transformed version of the specified type name. (Inherited from ConfigurationElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfReturns the index of the specified ProfilePropertySettings object. (Inherited from ProfilePropertySettingsCollection.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodIsElementNameIndicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodIsElementRemovableGets a value indicating whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodIsModifiedIndicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection.)
Protected methodListErrorsAdds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnDeserializeUnrecognizedAttributeGets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.)
Protected methodOnDeserializeUnrecognizedElementHandles the reading of unrecognized configuration elements from a configuration file and causes the configuration system to throw an exception if the element cannot be handled. (Inherited from ProfilePropertySettingsCollection.)
Protected methodOnRequiredPropertyNotFoundThrows an exception when a required property is not found. (Inherited from ConfigurationElement.)
Protected methodPostDeserializeCalled after deserialization. (Inherited from ConfigurationElement.)
Protected methodPreSerializeCalled before serialization. (Inherited from ConfigurationElement.)
Public methodRemoveRemoves a ProfilePropertySettings object from the collection. (Inherited from ProfilePropertySettingsCollection.)
Public methodRemoveAtRemoves a ProfilePropertySettings object at the specified index location from the collection. (Inherited from ProfilePropertySettingsCollection.)
Protected methodResetResets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodResetModifiedResets the value of the IsModified property to false when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodSerializeElementWrites the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Public methodSetAdds the specified ProfilePropertySettings object to the collection. (Inherited from ProfilePropertySettingsCollection.)
Protected methodSetPropertyValueSets a property to the specified value. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlyInfrastructure. Sets the IsReadOnly property for the ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeInfrastructure. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Inherited from ConfigurationElementCollection.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.)
Top

The RootProfilePropertySettingsCollection class is both a root-level ProfilePropertySettingsCollection collection and a container for a ProfileGroupSettingsCollection collection. These collections allow you to create named groups of more ProfilePropertySettingsCollection collections, each containing individual named ProfilePropertySettings objects. For more information about the profile features added to ASP.NET 2.0, see Creating Web Sites for Individual Users.

The PropertySettings property is a RootProfilePropertySettingsCollection object that contains all the properties defined within the properties subsection of the profile section of the configuration file.

The following code example shows how to use the RootProfilePropertySettingsCollection type as the PropertySettings property of the ProfileSection class. This code example is part of a larger example provided for the ProfileSection class.



// Display all current root ProfilePropertySettings.
Console.WriteLine("Current Root ProfilePropertySettings:");
int rootPPSCtr = 0;
foreach (ProfilePropertySettings rootPPS in profileSection.PropertySettings)
{
    Console.WriteLine("  {0}: ProfilePropertySetting '{1}'", ++rootPPSCtr,
        rootPPS.Name);
}

// Get and modify a root ProfilePropertySettings object.
Console.WriteLine(
    "Display and modify 'LastReadDate' ProfilePropertySettings:");
ProfilePropertySettings profilePropertySettings =
    profileSection.PropertySettings["LastReadDate"];

// Get the current ReadOnly property value.
Console.WriteLine(
    "Current ReadOnly value: '{0}'", profilePropertySettings.ReadOnly);

// Set the ReadOnly property to true.
profilePropertySettings.ReadOnly = true;

// Get the current AllowAnonymous property value.
Console.WriteLine(
    "Current AllowAnonymous value: '{0}'", profilePropertySettings.AllowAnonymous);

// Set the AllowAnonymous property to true.
profilePropertySettings.AllowAnonymous = true;

// Get the current SerializeAs property value.
Console.WriteLine(
    "Current SerializeAs value: '{0}'", profilePropertySettings.SerializeAs);

// Set the SerializeAs property to SerializationMode.Binary.
profilePropertySettings.SerializeAs = SerializationMode.Binary;

// Get the current Type property value.
Console.WriteLine(
    "Current Type value: '{0}'", profilePropertySettings.Type);

// Set the Type property to "System.DateTime".
profilePropertySettings.Type = "System.DateTime";

// Get the current DefaultValue property value.
Console.WriteLine(
    "Current DefaultValue value: '{0}'", profilePropertySettings.DefaultValue);

// Set the DefaultValue property to "March 16, 2004".
profilePropertySettings.DefaultValue = "March 16, 2004";

// Get the current ProviderName property value.
Console.WriteLine(
    "Current ProviderName value: '{0}'", profilePropertySettings.Provider);

// Set the ProviderName property to "AspNetSqlRoleProvider".
profilePropertySettings.Provider = "AspNetSqlRoleProvider";

// Get the current Name property value.
Console.WriteLine(
    "Current Name value: '{0}'", profilePropertySettings.Name);

// Set the Name property to "LastAccessDate".
profilePropertySettings.Name = "LastAccessDate";

// Display all current ProfileGroupSettings.
Console.WriteLine("Current ProfileGroupSettings:");
int PGSCtr = 0;
foreach (ProfileGroupSettings propGroups in profileSection.PropertySettings.GroupSettings)
{
    Console.WriteLine("  {0}: ProfileGroupSetting '{1}'", ++PGSCtr,
        propGroups.Name);
    int PPSCtr = 0;
    foreach (ProfilePropertySettings props in propGroups.PropertySettings)
    {
        Console.WriteLine("    {0}: ProfilePropertySetting '{1}'", ++PPSCtr,
            props.Name);
    }
}

// Add a new group.
ProfileGroupSettings newPropGroup = new ProfileGroupSettings("Forum");
profileSection.PropertySettings.GroupSettings.Add(newPropGroup);

// Add a new PropertySettings to the group.
ProfilePropertySettings newProp = new ProfilePropertySettings("AvatarImage");
newProp.Type = "System.String, System.dll";
newPropGroup.PropertySettings.Add(newProp);

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

// Clear all PropertySettings from the group.
newPropGroup.PropertySettings.Clear();



.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2015 Microsoft