RootProfilePropertySettingsCollection Class

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class RootProfilePropertySettingsCollection sealed : System::Web::Configuration::ProfilePropertySettingsCollection

[System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.ProfilePropertySettings))]
public sealed class RootProfilePropertySettingsCollection : System.Web.Configuration.ProfilePropertySettingsCollection

[<System.Configuration.ConfigurationCollection(typeof(System.Web.Configuration.ProfilePropertySettings))>]
type RootProfilePropertySettingsCollection = class
    inherit ProfilePropertySettingsCollection

Public NotInheritable Class RootProfilePropertySettingsCollection
Inherits ProfilePropertySettingsCollection

Inheritance: Object

ConfigurationElement

ConfigurationElementCollection

ProfilePropertySettingsCollection
RootProfilePropertySettingsCollection

Attributes: ConfigurationCollectionAttribute

Examples

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();



' Display all current root ProfilePropertySettings.
Console.WriteLine("Current Root ProfilePropertySettings:")
Dim rootPPSCtr As Integer = 0
For Each rootPPS As ProfilePropertySettings In profileSection.PropertySettings
    Console.WriteLine("  {0}: ProfilePropertySetting '{1}'", ++rootPPSCtr, _
        rootPPS.Name)
Next

' Get and modify a root ProfilePropertySettings object.
Console.WriteLine( _
    "Display and modify 'LastReadDate' ProfilePropertySettings:")
Dim profilePropertySettings As 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:")
Dim PGSCtr As Integer = 0
For Each propGroups As ProfileGroupSettings In profileSection.PropertySettings.GroupSettings
                    Console.WriteLine("  {0}: ProfileGroupSettings '{1}'", ++PGSCtr, _
        propGroups.Name)
    Dim PPSCtr As Integer = 0
    For Each props As ProfilePropertySettings In propGroups.PropertySettings
        Console.WriteLine("    {0}: ProfilePropertySetting '{1}'", ++PPSCtr, _
            props.Name)
    Next
Next

' Add a new group.
Dim newPropGroup As ProfileGroupSettings = new ProfileGroupSettings("Forum")
profileSection.PropertySettings.GroupSettings.Add(newPropGroup)

' Add a new PropertySettings to the group.
Dim newProp As ProfilePropertySettings = 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()

Remarks

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 ASP.NET Profile Properties.

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.

Constructors

RootProfilePropertySettingsCollection()

Initializes a new instance of the RootProfilePropertySettingsCollection class using default settings.

Properties

AddElementName	Gets 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)
AllKeys	Returns an array containing the names of all the ProfileSection objects contained in the collection. (Inherited from ProfilePropertySettingsCollection)
AllowClear	Gets a value indicating whether the <clear> element is valid as a ProfilePropertySettings object. (Inherited from ProfilePropertySettingsCollection)
ClearElementName	Gets 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)
CollectionType	Gets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
Count	Gets the number of elements in the collection. (Inherited from ConfigurationElementCollection)
CurrentConfiguration	Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement)
ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement)
ElementName	Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement)
EmitClear	Gets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection)
EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement)
GroupSettings	Gets a ProfileGroupSettingsCollection containing a collection of ProfileGroupSettings objects.
HasContext	Gets a value that indicates whether the CurrentConfiguration property is `null`. (Inherited from ConfigurationElement)
IsSynchronized	Gets a value indicating whether access to the collection is synchronized. (Inherited from ConfigurationElementCollection)
Item[ConfigurationProperty]	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement)
Item[Int32]	Gets or sets the ProfilePropertySettings object at the specified index location. (Inherited from ProfilePropertySettingsCollection)
Item[String]	Gets or sets the ProfilePropertySettings object with the specified name. (Inherited from ProfilePropertySettingsCollection)
LockAllAttributesExcept	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockAllElementsExcept	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockAttributes	Gets the collection of locked attributes. (Inherited from ConfigurationElement)
LockElements	Gets the collection of locked elements. (Inherited from ConfigurationElement)
LockItem	Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement)
Properties	Gets a collection of configuration properties. (Inherited from ProfilePropertySettingsCollection)
RemoveElementName	Gets 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)
SyncRoot	Gets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
ThrowOnDuplicate	Gets a value indicating whether an error should be thrown if an attempt to create a duplicate object is made. (Inherited from ProfilePropertySettingsCollection)

Methods

Add(ProfilePropertySettings)	Adds a ProfilePropertySettings object to the collection. (Inherited from ProfilePropertySettingsCollection)
BaseAdd(ConfigurationElement, Boolean)	Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection)
BaseAdd(ConfigurationElement)	Adds a configuration element to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)	Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection)
BaseClear()	Removes all configuration element objects from the collection. (Inherited from ConfigurationElementCollection)
BaseGet(Int32)	Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection)
BaseGet(Object)	Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection)
BaseGetAllKeys()	Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseGetKey(Int32)	Gets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)	Indicates the index of the specified ConfigurationElement. (Inherited from ConfigurationElementCollection)
BaseIsRemoved(Object)	Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
BaseRemove(Object)	Removes a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection)
BaseRemoveAt(Int32)	Removes the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection)
Clear()	Removes all ProfilePropertySettings objects from the collection. (Inherited from ProfilePropertySettingsCollection)
CopyTo(ConfigurationElement[], Int32)	Copies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection)
CreateNewElement()	When overridden in a derived class, creates a new ConfigurationElement. (Inherited from ProfilePropertySettingsCollection)
CreateNewElement(String)	Creates a new ConfigurationElement when overridden in a derived class. (Inherited from ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
Equals(Object)	Compares the current RootProfilePropertySettingsCollection object to another A RootProfilePropertySettingsCollection object.
Get(Int32)	Returns the ProfileSection object at the specified index. (Inherited from ProfilePropertySettingsCollection)
Get(String)	Returns the ProfileSection object with the specified name. (Inherited from ProfilePropertySettingsCollection)
GetElementKey(ConfigurationElement)	Gets the key for the specified configuration element. (Inherited from ProfilePropertySettingsCollection)
GetEnumerator()	Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
GetHashCode()	Generates a hash code for the collection.
GetKey(Int32)	Gets the name of the ProfilePropertySettings at the specified index location. (Inherited from ProfilePropertySettingsCollection)
GetTransformedAssemblyString(String)	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement)
GetTransformedTypeString(String)	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IndexOf(ProfilePropertySettings)	Returns the index of the specified ProfilePropertySettings object. (Inherited from ProfilePropertySettingsCollection)
Init()	Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement)
InitializeDefault()	Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement)
IsElementName(String)	Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)	Indicates whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection)
IsModified()	Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection)
IsReadOnly()	Indicates whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection)
ListErrors(IList)	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Handles 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)
OnRequiredPropertyNotFound(String)	Throws an exception when a required property is not found. (Inherited from ConfigurationElement)
PostDeserialize()	Called after deserialization. (Inherited from ConfigurationElement)
PreSerialize(XmlWriter)	Called before serialization. (Inherited from ConfigurationElement)
Remove(String)	Removes a ProfilePropertySettings object from the collection. (Inherited from ProfilePropertySettingsCollection)
RemoveAt(Int32)	Removes a ProfilePropertySettings object at the specified index location from the collection. (Inherited from ProfilePropertySettingsCollection)
Reset(ConfigurationElement)	Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection)
ResetModified()	Resets the value of the IsModified() property to `false` when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)	Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
Set(ProfilePropertySettings)	Adds the specified ProfilePropertySettings object to the collection. (Inherited from ProfilePropertySettingsCollection)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Sets a property to the specified value. (Inherited from ConfigurationElement)
SetReadOnly()	Sets the IsReadOnly() property for the ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Reverses the effect of merging configuration information from different levels of the configuration hierarchy. (Inherited from ConfigurationElementCollection)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)

Copies the ConfigurationElementCollection to an array.

(Inherited from ConfigurationElementCollection)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to

Jaa