Export (0) Print
Expand All

ProfileProviderAttribute Class

Identifies the profile provider for a user-profile property.

System.Object
  System.Attribute
    System.Web.Profile.ProfileProviderAttribute

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

'Declaration
<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class ProfileProviderAttribute _
	Inherits Attribute

The ProfileProviderAttribute type exposes the following members.

  NameDescription
Public methodProfileProviderAttributeCreates a new instance of the ProfileProviderAttribute class with the specified profile provider name.
Top

  NameDescription
Public propertyProviderNameGets the name of the profile provider for the user-profile property.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

The ProfileProviderAttribute class is used to identify the profile provider for a property of a custom profile implementation. A custom profile implementation is a class that inherits from the ProfileBase abstract class and defines properties for the user profile that are not specified in the profile configuration element. You can specify a custom type for the user profile using the inherits attribute of the profile configuration element in the Web.config file for an application, as shown in the following example.

<configuration>
  <connectionStrings>
    <add name="SqlServices" connectionString=
      "Data Source=localhost;Integrated Security=SSPI;Initial Catalog=aspnetdb;" />
  </connectionStrings>

  <system.web>
    <authentication mode="Forms" >
      <forms loginUrl="login.aspx"
        name=".ASPXFORMSAUTH" />
    </authentication>

    <authorization>
      <deny users="?" />
    </authorization>

    <profile inherits="Samples.AspNet.Profile.EmployeeProfile"
      defaultProvider="SqlProvider">
      <providers>
        <clear />
        <add
          name="SqlProvider"
          type="System.Web.Profile.SqlProfileProvider" 
          connectionStringName="SqlServices" 
          description="SQL Profile Provider for Sample"/> 
        <add
          name="EmployeeInfoProvider"
          type="System.Web.Profile.SqlProfileProvider" 
          connectionStringName="SqlServices" 
          description="SQL Profile Provider for Employee Info"/> 
      </providers>

      <properties>
        <add name="GarmentSize" />
      </properties>
    </profile>
  </system.web>
</configuration>

The following code example defines a class that inherits from the ProfileBase class to create a custom profile. The type of the custom profile is specified in the inherits attribute of the profile configuration element in the Web.config file for an application.

Imports System
Imports System.Web.Profile

Namespace Samples.AspNet.Profile

  Public Class EmployeeProfile
    Inherits ProfileBase

    <SettingsAllowAnonymous(False)> _
    <ProfileProvider("EmployeeInfoProvider")> _
    Public Property Department As String 
      Get 
        Return MyBase.Item("EmployeeDepartment").ToString()
      End Get 
      Set 
        MyBase.Item("EmployeeDepartment") = value
      End Set 
    End Property

    <SettingsAllowAnonymous(False)> _
    <ProfileProvider("EmployeeInfoProvider")> _
    Public Property Details As EmployeeInfo
      Get 
        Return CType(MyBase.Item("EmployeeInfo"), EmployeeInfo)
      End Get 
      Set 
        MyBase.Item("EmployeeInfo") = value
      End Set 
    End Property 
  End Class 

  Public Class EmployeeInfo
    Public Name As String 
    Public Address As String 
    Public Phone As String 
    Public EmergencyContactName As String 
    Public EmergencyContactAddress As String 
    Public EmergencyContactPhone As String 
  End Class 

End Namespace

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft