1<?xml version="1.0" encoding="utf-8"?>
2<Type Name="ProfileParameter" FullName="System.Web.UI.WebControls.ProfileParameter">
3  <TypeSignature Language="C#" Value="public class ProfileParameter : System.Web.UI.WebControls.Parameter" />
4  <AssemblyInfo>
5    <AssemblyName>System.Web</AssemblyName>
6    <AssemblyVersion>2.0.0.0</AssemblyVersion>
7  </AssemblyInfo>
8  <Base>
9    <BaseTypeName>System.Web.UI.WebControls.Parameter</BaseTypeName>
10  </Base>
11  <Interfaces />
12  <Docs>
13    <remarks>
14      <attribution license="cc4" from="Microsoft" modified="false" />
15      <para>You can use the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> class to bind the value of an ASP.NET Profile parameter to a parameter used in a parameterized SQL query, business object method, or filtering expression. </para>
16      <para>The <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> class provides the <see cref="P:System.Web.UI.WebControls.ProfileParameter.PropertyName" /> property in addition to those inherited from the <see cref="T:System.Web.UI.WebControls.Parameter" /> class. The <see cref="P:System.Web.UI.WebControls.ProfileParameter.PropertyName" /> property identifies the ASP.NET Profile property from which the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> retrieves a value. </para>
17      <block subset="none" type="note">
18        <para>Controls that bind data to the parameter might throw an exception if a <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> object is specified but no corresponding profile property is set. Similarly, they might display no data if the profile property is set with null. Set the <see cref="P:System.Web.UI.WebControls.Parameter.DefaultValue" /> property to avoid these situations where appropriate.</para>
19      </block>
20    </remarks>
21    <summary>
22      <attribution license="cc4" from="Microsoft" modified="false" />
23      <para>Binds the value of an ASP.NET Profile property to a parameter object. </para>
24    </summary>
25  </Docs>
26  <Members>
27    <Member MemberName=".ctor">
28      <MemberSignature Language="C#" Value="public ProfileParameter ();" />
29      <MemberType>Constructor</MemberType>
30      <AssemblyInfo>
31        <AssemblyVersion>2.0.0.0</AssemblyVersion>
32      </AssemblyInfo>
33      <Parameters />
34      <Docs>
35        <remarks>
36          <attribution license="cc4" from="Microsoft" modified="false" />
37          <para>A <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> object created with the <see cref="M:System.Web.UI.WebControls.ProfileParameter.#ctor" /> constructor is initialized with default values for all its properties. The <see cref="P:System.Web.UI.WebControls.ProfileParameter.PropertyName" /> properties are initialized to <see cref="F:System.String.Empty" />. Additionally, the <see cref="P:System.Web.UI.WebControls.Parameter.Name" /> property is initialized to <see cref="F:System.String.Empty" />, the <see cref="P:System.Web.UI.WebControls.Parameter.Type" /> property is initialized to <see cref="F:System.TypeCode.Object" />, the <see cref="P:System.Web.UI.WebControls.Parameter.Direction" /> property is initialized to <see cref="F:System.Data.ParameterDirection.Input" />, and the <see cref="P:System.Web.UI.WebControls.Parameter.DefaultValue" /> property is initialized to null (Nothing in Visual Basic).</para>
38        </remarks>
39        <summary>
40          <attribution license="cc4" from="Microsoft" modified="false" />
41          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> class.</para>
42        </summary>
43      </Docs>
44    </Member>
45    <Member MemberName=".ctor">
46      <MemberSignature Language="C#" Value="protected ProfileParameter (System.Web.UI.WebControls.ProfileParameter original);" />
47      <MemberType>Constructor</MemberType>
48      <AssemblyInfo>
49        <AssemblyVersion>2.0.0.0</AssemblyVersion>
50      </AssemblyInfo>
51      <Parameters>
52        <Parameter Name="original" Type="System.Web.UI.WebControls.ProfileParameter" />
53      </Parameters>
54      <Docs>
55        <remarks>
56          <attribution license="cc4" from="Microsoft" modified="false" />
57          <para>The <see cref="M:System.Web.UI.WebControls.ProfileParameter.#ctor(System.Web.UI.WebControls.ProfileParameter)" /> constructor is a protected copy constructor used to clone a <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> instance. The values of the <see cref="T:System.Web.UI.WebControls.ProfileParameter" />, including <see cref="P:System.Web.UI.WebControls.ProfileParameter.PropertyName" />, <see cref="P:System.Web.UI.WebControls.Parameter.Name" />, and <see cref="P:System.Web.UI.WebControls.Parameter.Type" /> are all transferred to the new instance.</para>
58        </remarks>
59        <summary>
60          <attribution license="cc4" from="Microsoft" modified="false" />
61          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> class with the values of the instance specified by the <paramref name="original" /> parameter.</para>
62        </summary>
63        <param name="original">
64          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> instance from which the current instance is initialized.</param>
65      </Docs>
66    </Member>
67    <Member MemberName=".ctor">
68      <MemberSignature Language="C#" Value="public ProfileParameter (string name, string propertyName);" />
69      <MemberType>Constructor</MemberType>
70      <AssemblyInfo>
71        <AssemblyVersion>2.0.0.0</AssemblyVersion>
72      </AssemblyInfo>
73      <Parameters>
74        <Parameter Name="name" Type="System.String" />
75        <Parameter Name="propertyName" Type="System.String" />
76      </Parameters>
77      <Docs>
78        <remarks>
79          <attribution license="cc4" from="Microsoft" modified="false" />
80          <para>A <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> object created with the <see cref="M:System.Web.UI.WebControls.ProfileParameter.#ctor(System.String,System.String)" /> constructor is initialized with the specified parameter name and <see cref="P:System.Web.UI.WebControls.ProfileParameter.PropertyName" />, which identifies the ASP.NET Profile property that the parameter binds to. Other properties, including <see cref="P:System.Web.UI.WebControls.Parameter.Type" />, <see cref="P:System.Web.UI.WebControls.Parameter.Direction" />, and <see cref="P:System.Web.UI.WebControls.Parameter.ConvertEmptyStringToNull" /> are initialized with default values.</para>
81        </remarks>
82        <summary>
83          <attribution license="cc4" from="Microsoft" modified="false" />
84          <para>Initializes a new named instance of the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> class, using the specified property name to identify which ASP.NET Profile property to bind to.</para>
85        </summary>
86        <param name="name">
87          <attribution license="cc4" from="Microsoft" modified="false" />The name of the parameter.</param>
88        <param name="propertyName">
89          <attribution license="cc4" from="Microsoft" modified="false" />The name of the ASP.NET Profile property that the parameter object is bound to. The default is <see cref="F:System.String.Empty" />.</param>
90      </Docs>
91    </Member>
92    <Member MemberName=".ctor">
93      <MemberSignature Language="C#" Value="public ProfileParameter (string name, TypeCode type, string propertyName);" />
94      <MemberType>Constructor</MemberType>
95      <AssemblyInfo>
96        <AssemblyVersion>2.0.0.0</AssemblyVersion>
97      </AssemblyInfo>
98      <Parameters>
99        <Parameter Name="name" Type="System.String" />
100        <Parameter Name="type" Type="System.TypeCode" />
101        <Parameter Name="propertyName" Type="System.String" />
102      </Parameters>
103      <Docs>
104        <remarks>
105          <attribution license="cc4" from="Microsoft" modified="false" />
106          <para>A <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> object created with the <see cref="M:System.Web.UI.WebControls.ProfileParameter.#ctor(System.String,System.TypeCode,System.String)" /> constructor is initialized with the specified parameter name, <see cref="P:System.Web.UI.WebControls.Parameter.Type" />, and <see cref="P:System.Web.UI.WebControls.ProfileParameter.PropertyName" />. Only the <see cref="P:System.Web.UI.WebControls.Parameter.Direction" /> and <see cref="P:System.Web.UI.WebControls.Parameter.ConvertEmptyStringToNull" /> properties are initialized with default values.</para>
107        </remarks>
108        <summary>
109          <attribution license="cc4" from="Microsoft" modified="false" />
110          <para>Initializes a new named and strongly typed instance of the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> class, using the specified property name to identify which ASP.NET Profile property to bind to.</para>
111        </summary>
112        <param name="name">
113          <attribution license="cc4" from="Microsoft" modified="false" />The name of the parameter.</param>
114        <param name="type">
115          <attribution license="cc4" from="Microsoft" modified="false" />The type that the parameter represents. The default is <see cref="F:System.TypeCode.Object" />.</param>
116        <param name="propertyName">
117          <attribution license="cc4" from="Microsoft" modified="false" />The name of the ASP.NET Profile property that the parameter object is bound to. The default is <see cref="F:System.String.Empty" />.</param>
118      </Docs>
119    </Member>
120    <Member MemberName="Clone">
121      <MemberSignature Language="C#" Value="protected override System.Web.UI.WebControls.Parameter Clone ();" />
122      <MemberType>Method</MemberType>
123      <AssemblyInfo>
124        <AssemblyVersion>2.0.0.0</AssemblyVersion>
125      </AssemblyInfo>
126      <ReturnValue>
127        <ReturnType>System.Web.UI.WebControls.Parameter</ReturnType>
128      </ReturnValue>
129      <Parameters />
130      <Docs>
131        <remarks>
132          <attribution license="cc4" from="Microsoft" modified="false" />
133          <para>The <see cref="M:System.Web.UI.WebControls.ProfileParameter.Clone" /> method calls the <see cref="M:System.Web.UI.WebControls.ProfileParameter.#ctor(System.Web.UI.WebControls.ProfileParameter)" /> copy constructor to initialize a new instance of the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> class with the values of the current instance.</para>
134        </remarks>
135        <summary>
136          <attribution license="cc4" from="Microsoft" modified="false" />
137          <para>Returns a duplicate of the current <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> instance.</para>
138        </summary>
139        <returns>
140          <attribution license="cc4" from="Microsoft" modified="false" />
141          <para>A <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> object that is an exact duplicate of the current one.</para>
142        </returns>
143      </Docs>
144    </Member>
145    <Member MemberName="Evaluate">
146      <MemberSignature Language="C#" Value="protected override object Evaluate (System.Web.HttpContext context, System.Web.UI.Control control);" />
147      <MemberType>Method</MemberType>
148      <AssemblyInfo>
149        <AssemblyVersion>2.0.0.0</AssemblyVersion>
150      </AssemblyInfo>
151      <ReturnValue>
152        <ReturnType>System.Object</ReturnType>
153      </ReturnValue>
154      <Parameters>
155        <Parameter Name="context" Type="System.Web.HttpContext" />
156        <Parameter Name="control" Type="System.Web.UI.Control" />
157      </Parameters>
158      <Docs>
159        <remarks>
160          <attribution license="cc4" from="Microsoft" modified="false" />
161          <para>The <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> attempts to bind to the value of the Profile property every time the <see cref="M:System.Web.UI.WebControls.ProfileParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method is called.</para>
162          <para>The <paramref name="context" /> parameter is used by the <see cref="M:System.Web.UI.WebControls.ProfileParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method to retrieve the ASP.NET Profile that the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> binds to. The <paramref name="control" /> parameter is ignored.</para>
163        </remarks>
164        <summary>
165          <attribution license="cc4" from="Microsoft" modified="false" />
166          <para>Updates and returns the value of the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> object.</para>
167        </summary>
168        <returns>
169          <attribution license="cc4" from="Microsoft" modified="false" />
170          <para>An object that represents the updated and current value of the parameter. If the context or the ASP.NET Profile is null (Nothing in Visual Basic), the <see cref="M:System.Web.UI.WebControls.ProfileParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method returns null.</para>
171        </returns>
172        <param name="context">
173          <attribution license="cc4" from="Microsoft" modified="false" />The current <see cref="T:System.Web.HttpContext" /> of the request.</param>
174        <param name="control">
175          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.Control" /> that is associated with the Web Form where the <see cref="T:System.Web.UI.WebControls.ProfileParameter" /> is used.</param>
176      </Docs>
177    </Member>
178    <Member MemberName="PropertyName">
179      <MemberSignature Language="C#" Value="public string PropertyName { set; get; }" />
180      <MemberType>Property</MemberType>
181      <AssemblyInfo>
182        <AssemblyVersion>2.0.0.0</AssemblyVersion>
183      </AssemblyInfo>
184      <ReturnValue>
185        <ReturnType>System.String</ReturnType>
186      </ReturnValue>
187      <Docs>
188        <value>To be added.</value>
189        <remarks>
190          <attribution license="cc4" from="Microsoft" modified="false" />
191          <para>The <see cref="P:System.Web.UI.WebControls.ProfileParameter.PropertyName" /> property identifies a property of the current ASP.NET Profile available through the current <see cref="T:System.Web.HttpContext" /> object. If the property does not exist for the Profile, the <see cref="M:System.Web.UI.WebControls.ProfileParameter.Evaluate(System.Web.HttpContext,System.Web.UI.Control)" /> method fails to bind the parameter to a value.</para>
192        </remarks>
193        <summary>
194          <attribution license="cc4" from="Microsoft" modified="false" />
195          <para>Gets or sets the name of the ASP.NET Profile property that the parameter binds to.</para>
196        </summary>
197      </Docs>
198    </Member>
199  </Members>
200</Type>