ProfileSection Class

.NET Framework (current version)

The ProfileSection class provides a way to programmatically access and modify the profile section of a configuration file. This class cannot be inherited.

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

Inheritance Hierarchy

System::Object
System.Configuration::ConfigurationElement
System.Configuration::ConfigurationSection
System.Web.Configuration::ProfileSection

Syntax

C++

public ref class ProfileSection sealed : ConfigurationSection

Constructors

	Name	Description
	ProfileSection()	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ProfileSection class using default settings.

Properties

	Name	Description
	AutomaticSaveEnabled	Gets or sets a value that determines whether changes to user-profile information are automatically saved on page exit.
	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.)
	DefaultProvider	Gets or sets the name of the default profile provider.
	ElementInformation	Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
	ElementProperty	Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.(Inherited from ConfigurationElement.)
	Enabled	Gets or sets a value indicating whether the ASP.NET profile feature is enabled.
	Inherits	Gets or sets a type reference for a custom type derived from ProfileBase.
	Item[ConfigurationProperty^]	Gets or sets a property or attribute of this configuration element.(Inherited from ConfigurationElement.)
	Item[String^]	Gets or sets a property, attribute, or child element of this configuration element.(Inherited from ConfigurationElement.)
	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 the collection of properties.(Inherited from ConfigurationElement.)
	PropertySettings	Gets a RootProfilePropertySettingsCollection collection of ProfilePropertySettings objects.
	Providers	Gets a collection of ProviderSettings objects.
	SectionInformation	Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection.)

Methods

	Name	Description
	DeserializeElement(XmlReader^, Boolean)	Reads XML from the configuration file.(Inherited from ConfigurationElement.)
	DeserializeSection(XmlReader^)	This API supports the product infrastructure and is not intended to be used directly from your code. Reads XML from the configuration file.(Inherited from ConfigurationSection.)
	Equals(Object^)	Compares the current ConfigurationElement instance to the specified object.(Inherited from ConfigurationElement.)
	GetHashCode()	Gets a unique value representing the current ConfigurationElement instance.(Inherited from ConfigurationElement.)
	GetRuntimeObject()	Returns a custom object when overridden in a derived class.(Inherited from ConfigurationSection.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	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.)
	IsModified()	Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class.(Inherited from ConfigurationSection.)
	IsReadOnly()	Gets a value indicating whether the ConfigurationElement object is read-only.(Inherited from ConfigurationElement.)
	Reset(ConfigurationElement^)	Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.(Inherited from ConfigurationElement.)
	ResetModified()	Resets the value of the IsModified method to false when implemented in a derived class.(Inherited from ConfigurationSection.)
	SerializeElement(XmlWriter^, Boolean)	Writes the contents of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)
	SerializeSection(ConfigurationElement^, String^, ConfigurationSaveMode)	This API supports the product infrastructure and is not intended to be used directly from your code. Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file.(Inherited from ConfigurationSection.)
	SerializeToXmlElement(XmlWriter^, String^)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)
	SetReadOnly()	Sets the IsReadOnly property for the ConfigurationElement object and all subelements.(Inherited from ConfigurationElement.)
	ShouldSerializeElementInTargetVersion(ConfigurationElement^, String^, FrameworkName^)	Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.(Inherited from ConfigurationSection.)
	ShouldSerializePropertyInTargetVersion(ConfigurationProperty^, String^, FrameworkName^, ConfigurationElement^)	Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.(Inherited from ConfigurationSection.)
	ShouldSerializeSectionInTargetVersion(FrameworkName^)	Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.(Inherited from ConfigurationSection.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	Unmerge(ConfigurationElement^, ConfigurationElement^, ConfigurationSaveMode)	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)

The ProfileSection class provides a way to programmatically access and modify the content of the configuration file profile section. The profile section of the configuration file specifies a schema for user profiles. At run time, the ASP.NET compilation system uses the information specified in the profile section to generate a class called ProfileCommon, which is derived from ProfileBase. The ProfileCommon class definition is based on the properties defined in the profile section of the configuration file. The class allows you to access and modify the values for individual profiles. An instance of this class is created for each user profile, and you can access the individual profile values in your code through the HttpContext::Profile property. For more information about the profile features added to ASP.NET 2.0, see ASP.NET Profile Properties Overview.

Examples

The following configuration file excerpt shows how to declaratively specify values for several properties of the ProfileSection class.

<system.web>
  <profile enabled = "true" 
     defaultProvider="AspNetSqlProfileProvider">
    <providers>
      <add  name="AspNetSqlProfileProvider"
        type="System.Web.Profile.SqlProfileProvider"
        connectionStringName="LocalSqlServer"
        applicationName="/"
        description="Stores and retrieves profile data from the 
local Microsoft SQL Server database" />
    </providers>
    <properties>
      <add name = "FirstName"/>
      <add name = "LastName"/>
      <add name = "FavoriteURLs" type =
        "System.Collection.Specialized.StringCollection, System" 
        serializeAs = "Xml"/>      
      <add name = "ShoppingCart" type = 
        "MyCommerce.ShoppingCart, MyCommerce" 
        serializeAs = "Binary"/>
      <group name = "SiteColors" >
        <add name = "BackGround"/>
        <add name = "SideBar"/>
        <add name = "ForeGroundText"/>
        <add name = "ForeGroundBorders"/>
      </group>
      <group name="Forums">
        <add name = "HasAvatar" type="bool" provider="Forums"/>
        <add name = "LastLogin" type="DateTime" provider="Forums"/>
        <add name = "TotalPosts" type="int" provider="Forums"/>
      </group>
    </properties>
  </profile>
</system.web>

The following code example shows how to use the ProfileSection type.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 2.0

Thread Safety

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