ProfileSection クラス

リファレンス

定義

名前空間:: System.Web.Configuration

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ProfileSection クラスを使用すると、構成ファイルの profile セクションにプログラムからアクセスして変更できます。このクラスは継承できません。

public ref class ProfileSection sealed : System::Configuration::ConfigurationSection

public sealed class ProfileSection : System.Configuration.ConfigurationSection

type ProfileSection = class
    inherit ConfigurationSection

Public NotInheritable Class ProfileSection
Inherits ConfigurationSection

継承: Object

ConfigurationElement

ConfigurationSection
ProfileSection

例

次の構成ファイルの抜粋は、クラスのいくつかのプロパティの値を宣言的に指定する方法を ProfileSection 示しています。

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

次のコード例は、型の使用方法を ProfileSection 示しています。

using System;
using System.Collections;
using System.Collections.Specialized;
using System.IO;
using System.Text;
using System.Text.RegularExpressions;
using System.Configuration;
using System.Web.Configuration;

namespace Samples.Aspnet.SystemWebConfiguration
{
    // Accesses the System.Web.Configuration.ProfileSection members
    // selected by the user.
    class UsingProfileSection
    {
        public static void Main()
        {
            // Process the System.Web.Configuration.ProfileSectionobject.
            try
            {
                // Get the Web application configuration.
                System.Configuration.Configuration configuration = 
                    System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration("/aspnet");
                
                // Get the section.
                System.Web.Configuration.ProfileSection profileSection = 
                    (System.Web.Configuration.ProfileSection) 
                    configuration.GetSection("system.web/profile");

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

// Set the AutomaticSaveEnabled property to false.
profileSection.AutomaticSaveEnabled = false;

                

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

// Set the DefaultProvider property to "AspNetSqlProvider".
profileSection.DefaultProvider = "AspNetSqlProvider";

                

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

// Set the Inherits property to
// "CustomProfiles.MyCustomProfile, CustomProfiles.dll".
profileSection.Inherits = "CustomProfiles.MyCustomProfile, CustomProfiles.dll";

                

// 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 Providers.
Console.WriteLine("Current Providers:");
int providerCtr = 0;
foreach (ProviderSettings provider in profileSection.Providers)
{
    Console.WriteLine("  {0}: Provider '{1}' of type '{2}'", ++providerCtr, 
        provider.Name, provider.Type);
}

// Add a new provider.
profileSection.Providers.Add(new ProviderSettings("AspNetSqlProvider", "...SqlProfileProvider"));

                

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

// Set the Enabled property to false.
profileSection.Enabled = false;

                
                // Update if not locked.
                if (!profileSection.SectionInformation.IsLocked)
                {
                    configuration.Save();
                    Console.WriteLine("** Configuration updated.");
                }
                else
                {
                    Console.WriteLine("** Could not update, section is locked.");
                }
            }
            catch (System.ArgumentException e)
            {
                // Unknown error.
                Console.WriteLine(
                    "A invalid argument exception detected in UsingProfileSection Main. Check your");
                Console.WriteLine("command line for errors.");
            }
        }
    } // UsingProfileSection class end.
} // Samples.Aspnet.SystemWebConfiguration namespace end.

Imports System.Collections
Imports System.Collections.Specialized
Imports System.IO
Imports System.Text
Imports System.Text.RegularExpressions
Imports System.Configuration
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
    ' Accesses the System.Web.Configuration.ProfileSection members
    ' selected by the user.
    Class UsingProfileSection
        Public Shared Sub Main()
            ' Process the System.Web.Configuration.ProfileSectionobject.
            Try
                ' Get the Web application configuration.
                Dim configuration As System.Configuration.Configuration = System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration("/aspnet")
                
                ' Get the section.
                Dim profileSection As System.Web.Configuration.ProfileSection = CType(configuration.GetSection("system.web/profile"), System.Web.Configuration.ProfileSection)

' Get the current AutomaticSaveEnabled property value.
Console.WriteLine( _
    "Current AutomaticSaveEnabled value: '{0}'", profileSection.AutomaticSaveEnabled)

' Set the AutomaticSaveEnabled property to false.
profileSection.AutomaticSaveEnabled = false

                

' Get the current DefaultProvider property value.
Console.WriteLine( _
    "Current DefaultProvider value: '{0}'", profileSection.DefaultProvider)

' Set the DefaultProvider property to "AspNetSqlProvider".
profileSection.DefaultProvider = "AspNetSqlProvider"

                

' Get the current Inherits property value.
Console.WriteLine( _
    "Current Inherits value: '{0}'", profileSection.Inherits)

' Set the Inherits property to
' "CustomProfiles.MyCustomProfile, CustomProfiles.dll".
profileSection.Inherits = "CustomProfiles.MyCustomProfile, CustomProfiles.dll"

                


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

                

Console.WriteLine("Current Providers:")
Dim providerCtr As Integer = 0
For Each provider As ProviderSettings In profileSection.Providers
    Console.WriteLine("  {0}: Provider '{1}' of type '{2}'", ++providerCtr, _
        provider.Name, provider.Type)
Next

' Add a new provider.
profileSection.Providers.Add(new ProviderSettings("AspNetSqlProvider", "...SqlProfileProvider"))

                

' Get the current Enabled property value.
Console.WriteLine( _
    "Current Enabled value: '{0}'", profileSection.Enabled)

' Set the Enabled property to false.
profileSection.Enabled = false

                
                ' Update if not locked.
                If Not profileSection.SectionInformation.IsLocked Then
                    configuration.Save()
                    Console.WriteLine("** Configuration updated.")
                Else
                    Console.WriteLine("** Could not update, section is locked.")
                End If
            Catch e As System.ArgumentException
                ' Unknown error.
                Console.WriteLine( _
                    "A invalid argument exception detected in UsingProfileSection Main. Check your")
                Console.WriteLine("command line for errors.")
            End Try
        End Sub
    End Class
    
End Namespace ' Samples.Aspnet.SystemWebConfiguration

注釈

クラスは ProfileSection 、構成ファイル profile セクションの内容にプログラムでアクセスして変更する方法を提供します。構成ファイルのセクションでは profile 、ユーザープロファイルのスキーマを指定します。実行時に、ASP.NET コンパイルシステムは、セクションで指定された情報をprofile使用して、からProfileBase派生したというProfileCommonクラスを生成します。 ProfileCommonクラス定義は、構成ファイルのセクションで定義されているprofileプロパティに基づいています。クラスを使用すると、個々のプロファイルの値にアクセスして変更できます。このクラスのインスタンスは、ユーザープロファイルごとに作成され、プロパティを使用してコード内の個々のプロファイル値に HttpContext.Profile アクセスできます。 ASP.NET 2.0 に追加されるプロファイル機能の詳細については、「 ASP.NET プロファイルプロパティの概要」を参照してください。

コンストラクター

ProfileSection()

既定の設定を使用して ProfileSection クラスの新しいインスタンスを初期化します。

プロパティ

AutomaticSaveEnabled	ユーザープロファイル情報への変更を、ページ終了時に自動的に保存するかどうかを決定する値を取得または設定します。
CurrentConfiguration	現在の Configuration インスタンスが属している構成階層を表す最上位の ConfigurationElement インスタンスへの参照を取得します。 (継承元 ConfigurationElement)
DefaultProvider	既定のプロファイルプロバイダーの名前を取得または設定します。
ElementInformation	ElementInformation オブジェクトのカスタマイズできない情報と機能を格納する ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
ElementProperty	ConfigurationElementProperty オブジェクト自体を表す ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
Enabled	ASP.NET プロファイル機能を有効にするかどうかを示す値を取得または設定します。
EvaluationContext	ContextInformation オブジェクトの ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
HasContext	CurrentConfiguration プロパティが `null` であるかどうかを示す値を取得します。 (継承元 ConfigurationElement)
Inherits	ProfileBase から派生したカスタム型の型参照を取得または設定します。
Item[ConfigurationProperty]	この構成要素のプロパティまたは属性を取得または設定します。 (継承元 ConfigurationElement)
Item[String]	この構成要素のプロパティ、属性、または子要素を取得または設定します。 (継承元 ConfigurationElement)
LockAllAttributesExcept	ロックされている属性のコレクションを取得します。 (継承元 ConfigurationElement)
LockAllElementsExcept	ロックされている要素のコレクションを取得します。 (継承元 ConfigurationElement)
LockAttributes	ロックされている属性のコレクションを取得します。 (継承元 ConfigurationElement)
LockElements	ロックされている要素のコレクションを取得します。 (継承元 ConfigurationElement)
LockItem	要素がロックされているかどうかを示す値を取得または設定します。 (継承元 ConfigurationElement)
Properties	プロパティのコレクションを取得します。 (継承元 ConfigurationElement)
PropertySettings	RootProfilePropertySettingsCollection オブジェクトの ProfilePropertySettings コレクションを取得します。
Providers	ProviderSettings オブジェクトのコレクションを取得します。
SectionInformation	SectionInformation オブジェクトのカスタマイズできない情報と機能を格納する ConfigurationSection オブジェクトを取得します。 (継承元 ConfigurationSection)

メソッド

DeserializeElement(XmlReader, Boolean)	構成ファイルから XML を読み取ります。 (継承元 ConfigurationElement)
DeserializeSection(XmlReader)	構成ファイルから XML を読み取ります。 (継承元 ConfigurationSection)
Equals(Object)	現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 (継承元 ConfigurationElement)
GetHashCode()	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 (継承元 ConfigurationElement)
GetRuntimeObject()	派生クラスでオーバーライドされると、カスタムオブジェクトを返します。 (継承元 ConfigurationSection)
GetTransformedAssemblyString(String)	指定されたアセンブリ名を変換して返します。 (継承元 ConfigurationElement)
GetTransformedTypeString(String)	指定された型名を変換して返します。 (継承元 ConfigurationElement)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Init()	ConfigurationElement オブジェクトを初期状態に設定します。 (継承元 ConfigurationElement)
InitializeDefault()	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 (継承元 ConfigurationElement)
IsModified()	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 (継承元 ConfigurationSection)
IsReadOnly()	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 (継承元 ConfigurationElement)
ListErrors(IList)	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 (継承元 ConfigurationElement)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
OnDeserializeUnrecognizedAttribute(String, String)	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 (継承元 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 (継承元 ConfigurationElement)
OnRequiredPropertyNotFound(String)	必要なプロパティが見つからないと例外がスローされます。 (継承元 ConfigurationElement)
PostDeserialize()	逆シリアル化後に呼び出されます。 (継承元 ConfigurationElement)
PreSerialize(XmlWriter)	シリアル化前に呼び出されます。 (継承元 ConfigurationElement)
Reset(ConfigurationElement)	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティコレクションなど) をリセットします。 (継承元 ConfigurationElement)
ResetModified()	IsModified() メソッドの値が派生クラスに実装されたときに、`false` にリセットします。 (継承元 ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 (継承元 ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	ファイルに書き込む 1 つのセクションとして、ConfigurationSection オブジェクトのアンマージされたビューを含む XML 文字列を作成します。 (継承元 ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 (継承元 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	プロパティを指定した値に設定します。 (継承元 ConfigurationElement)
SetReadOnly()	IsReadOnly() オブジェクトおよびすべてのサブ要素に ConfigurationElement プロパティを設定します。 (継承元 ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	指定したターゲットバージョンの .NET Framework に対して構成オブジェクト階層をシリアル化するときに、指定した要素をシリアル化する必要があるかどうかを示します。 (継承元 ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	指定したターゲットバージョンの .NET Framework に対して構成オブジェクト階層をシリアル化するときに、指定したプロパティをシリアル化する必要があるかどうかを示します。 (継承元 ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	指定したターゲットバージョンの .NET Framework に対して構成オブジェクト階層をシリアル化するときに、現在 ConfigurationSection のインスタンスをシリアル化する必要があるかどうかを示します。 (継承元 ConfigurationSection)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 (継承元 ConfigurationElement)

適用対象

次の方法で共有

ProfileSection クラス

定義

例

注釈

コンストラクター

プロパティ

メソッド

適用対象

こちらもご覧ください

その他のリソース