ProfileAttribute.xml

<Type Name="ProfileAttribute" FullName="System.Web.ModelBinding.ProfileAttribute">
  <TypeSignature Language="C#" Value="public sealed class ProfileAttribute : System.Web.ModelBinding.ValueProviderSourceAttribute" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ProfileAttribute extends System.Web.ModelBinding.ValueProviderSourceAttribute" />
  <TypeSignature Language="DocId" Value="T:System.Web.ModelBinding.ProfileAttribute" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class ProfileAttribute&#xA;Inherits ValueProviderSourceAttribute" />
  <TypeSignature Language="F#" Value="type ProfileAttribute = class&#xA;    inherit ValueProviderSourceAttribute" />
  <TypeSignature Language="C++ CLI" Value="public ref class ProfileAttribute sealed : System::Web::ModelBinding::ValueProviderSourceAttribute" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Web.ModelBinding.ValueProviderSourceAttribute</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Parameter, AllowMultiple=false, Inherited=false)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.AttributeUsage(System.AttributeTargets.Parameter, AllowMultiple=false, Inherited=false)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Represents an attribute that specifies that values for model binding are provided by a profile.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For a tutorial series on using model binding with Web Forms, see [Model Binding and Web Forms](/aspnet/web-forms/overview/presenting-and-managing-data/model-binding/retrieving-data).  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <MemberGroup MemberName=".ctor">
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.Web.ModelBinding.ProfileAttribute" /> class.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For a tutorial series on using model binding with Web Forms, see [Model Binding and Web Forms](/aspnet/web-forms/overview/presenting-and-managing-data/model-binding/retrieving-data).  
  
 ]]></format>
        </remarks>
      </Docs>
    </MemberGroup>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ProfileAttribute ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.ModelBinding.ProfileAttribute.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; ProfileAttribute();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.Web.ModelBinding.ProfileAttribute" /> class.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For a tutorial series on using model binding with Web Forms, see [Model Binding and Web Forms](/aspnet/web-forms/overview/presenting-and-managing-data/model-binding/retrieving-data).  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ProfileAttribute (string key);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string key) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.ModelBinding.ProfileAttribute.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (key As String)" />
      <MemberSignature Language="F#" Value="new System.Web.ModelBinding.ProfileAttribute : string -&gt; System.Web.ModelBinding.ProfileAttribute" Usage="new System.Web.ModelBinding.ProfileAttribute key" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; ProfileAttribute(System::String ^ key);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="key" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="key">The key.</param>
        <summary>Initializes a new instance of the <see cref="T:System.Web.ModelBinding.ProfileAttribute" /> class, using the profile key.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For a tutorial series on using model binding with Web Forms, see [Model Binding and Web Forms](/aspnet/web-forms/overview/presenting-and-managing-data/model-binding/retrieving-data).  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetModelName">
      <MemberSignature Language="C#" Value="public override string GetModelName ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string GetModelName() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.ModelBinding.ProfileAttribute.GetModelName" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetModelName () As String" />
      <MemberSignature Language="F#" Value="override this.GetModelName : unit -&gt; string" Usage="profileAttribute.GetModelName " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override System::String ^ GetModelName();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the model name.</summary>
        <returns>The model name.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This method returns the value of the <xref:System.Web.ModelBinding.ProfileAttribute.Key%2A> property.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetValueProvider">
      <MemberSignature Language="C#" Value="public override System.Web.ModelBinding.IValueProvider GetValueProvider (System.Web.ModelBinding.ModelBindingExecutionContext modelBindingExecutionContext);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Web.ModelBinding.IValueProvider GetValueProvider(class System.Web.ModelBinding.ModelBindingExecutionContext modelBindingExecutionContext) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.ModelBinding.ProfileAttribute.GetValueProvider(System.Web.ModelBinding.ModelBindingExecutionContext)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetValueProvider (modelBindingExecutionContext As ModelBindingExecutionContext) As IValueProvider" />
      <MemberSignature Language="F#" Value="override this.GetValueProvider : System.Web.ModelBinding.ModelBindingExecutionContext -&gt; System.Web.ModelBinding.IValueProvider" Usage="profileAttribute.GetValueProvider modelBindingExecutionContext" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override System::Web::ModelBinding::IValueProvider ^ GetValueProvider(System::Web::ModelBinding::ModelBindingExecutionContext ^ modelBindingExecutionContext);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.ModelBinding.IValueProvider</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="modelBindingExecutionContext" Type="System.Web.ModelBinding.ModelBindingExecutionContext" />
      </Parameters>
      <Docs>
        <param name="modelBindingExecutionContext">the execution context.</param>
        <summary>Gets the value provider.</summary>
        <returns>A new instance of the <see cref="T:System.Web.ModelBinding.ProfileValueProvider" /> class.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">The <paramref name="modelBindingExecutionContext" /> parameter is <see langword="null" />.</exception>
      </Docs>
    </Member>
    <Member MemberName="Key">
      <MemberSignature Language="C#" Value="public string Key { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Key" />
      <MemberSignature Language="DocId" Value="P:System.Web.ModelBinding.ProfileAttribute.Key" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Key As String" />
      <MemberSignature Language="F#" Value="member this.Key : string" Usage="System.Web.ModelBinding.ProfileAttribute.Key" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Key { System::String ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the profile key.</summary>
        <value>The profile key.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 For a tutorial series on using model binding with Web Forms, see [Model Binding and Web Forms](/aspnet/web-forms/overview/presenting-and-managing-data/model-binding/retrieving-data).  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>