Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ProfileParameter Class

Binds the value of an ASP.NET Profile property to a parameter object.

System.Object
  System.Web.UI.WebControls.Parameter
    System.Web.UI.WebControls.ProfileParameter

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
public class ProfileParameter : Parameter

The ProfileParameter type exposes the following members.

  NameDescription
Public methodProfileParameter()Initializes a new instance of the ProfileParameter class.
Protected methodProfileParameter(ProfileParameter)Initializes a new instance of the ProfileParameter class with the values of the instance specified by the original parameter.
Public methodProfileParameter(String, String)Initializes a new named instance of the ProfileParameter class, using the specified property name to identify which ASP.NET Profile property to bind to.
Public methodProfileParameter(String, DbType, String)Initializes a new instance of the ProfileParameter class, using the specified property name to identify which ASP.NET Profile property to bind to.
Public methodProfileParameter(String, TypeCode, String)Initializes a new named and strongly typed instance of the ProfileParameter class, using the specified property name to identify which ASP.NET Profile property to bind to.
Top
  NameDescription
Public propertyConvertEmptyStringToNullGets or sets a value indicating whether the value that the Parameter object is bound to should be converted to null if it is String.Empty. (Inherited from Parameter.)
Public propertyDbTypeGets or sets the database type of the parameter. (Inherited from Parameter.)
Public propertyDefaultValueSpecifies a default value for the parameter, should the value that the parameter is bound to be uninitialized when the Evaluate method is called. (Inherited from Parameter.)
Public propertyDirectionIndicates whether the Parameter object is used to bind a value to a control, or the control can be used to change the value. (Inherited from Parameter.)
Protected propertyIsTrackingViewStateGets a value indicating whether the Parameter object is saving changes to its view state. (Inherited from Parameter.)
Public propertyNameGets or sets the name of the parameter. (Inherited from Parameter.)
Public propertyPropertyNameGets or sets the name of the ASP.NET Profile property that the parameter binds to.
Public propertySizeGets or sets the size of the parameter. (Inherited from Parameter.)
Public propertyTypeGets or sets the type of the parameter. (Inherited from Parameter.)
Protected propertyViewStateGets a dictionary of state information that allows you to save and restore the view state of a Parameter object across multiple requests for the same page. (Inherited from Parameter.)
Top
  NameDescription
Protected methodCloneReturns a duplicate of the current ProfileParameter instance. (Overrides Parameter.Clone().)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodEvaluateUpdates and returns the value of the ProfileParameter object. (Overrides Parameter.Evaluate(HttpContext, Control).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetDatabaseTypeGets the DbType value that is equivalent to the CLR type of the current Parameter instance. (Inherited from Parameter.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodLoadViewStateRestores the data source view's previously saved view state. (Inherited from Parameter.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnParameterChangedCalls the OnParametersChanged method of the ParameterCollection collection that contains the Parameter object. (Inherited from Parameter.)
Protected methodSaveViewStateSaves the changes to the Parameter object's view state since the time the page was posted back to the server. (Inherited from Parameter.)
Protected methodSetDirtyMarks the Parameter object so its state will be recorded in view state. (Inherited from Parameter.)
Public methodToStringConverts the value of this instance to its equivalent string representation. (Inherited from Parameter.)
Protected methodTrackViewStateCauses the Parameter object to track changes to its view state so they can be stored in the control's ViewState object and persisted across requests for the same page. (Inherited from Parameter.)
Top
  NameDescription
Explicit interface implemetationPrivate methodICloneable.CloneReturns a duplicate of the current Parameter instance. (Inherited from Parameter.)
Explicit interface implemetationPrivate propertyIStateManager.IsTrackingViewStateInfrastructure. Gets a value indicating whether the Parameter object is saving changes to its view state. (Inherited from Parameter.)
Explicit interface implemetationPrivate methodIStateManager.LoadViewStateInfrastructure. Restores the data source view's previously saved view state. (Inherited from Parameter.)
Explicit interface implemetationPrivate methodIStateManager.SaveViewStateInfrastructure. Saves the changes to the Parameter object's view state since the time the page was posted back to the server. (Inherited from Parameter.)
Explicit interface implemetationPrivate methodIStateManager.TrackViewStateInfrastructure. Causes the Parameter object to track changes to its view state so they can be stored in the control's ViewState object and persisted across requests for the same page. (Inherited from Parameter.)
Top

You can use the 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.

The ProfileParameter class provides the PropertyName property in addition to those inherited from the Parameter class. The PropertyName property identifies the ASP.NET Profile property from which the ProfileParameter retrieves a value.

NoteNote

Controls that bind data to the parameter might throw an exception if a 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 DefaultValue property to avoid these situations where appropriate.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, 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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.