ProfilePropertySettings.DefaultValue Property

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the default value used for the associated property in the dynamically generated ProfileCommon class.

public:
 property System::String ^ DefaultValue { System::String ^ get(); void set(System::String ^ value); };

[System.Configuration.ConfigurationProperty("defaultValue", DefaultValue="")]
public string DefaultValue { get; set; }

[<System.Configuration.ConfigurationProperty("defaultValue", DefaultValue="")>]
member this.DefaultValue : string with get, set

Public Property DefaultValue As String

Property Value

String

A string containing the default value used for the associated property in the dynamically generated ProfileCommon class. The default is an empty string ("").

Attributes: ConfigurationPropertyAttribute

Examples

The following code example shows how to use the DefaultValue property. This code example is part of a larger example provided for the ProfileSection class.

// 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 DefaultValue property value.
Console.WriteLine( _
    "Current DefaultValue value: '{0}'", profilePropertySettings.DefaultValue)

' Set the DefaultValue property to "March 16, 2004".
profilePropertySettings.DefaultValue = "March 16, 2004"

Remarks

At run time, the ASP.NET compilation system uses the information specified in the profile section of the configuration file to generate a class called ProfileCommon, which is derived from ProfileBase. The class allows you to access and modify the values for individual user profiles.

The ProfileCommon class definition is based on the properties defined in the properties subsection of the profile section of the configuration file. The property values that you specify for an instance of the ProfilePropertySettings class will be used to define an associated property in the ProfileCommon class.

The default value is used as the initial value for the associated ProfileCommon class property when an individual user profile does not contain a value for the property. The DefaultValue property may be a string value, an XML-encoded value (serialization mode for the property is XML serialization) or a base-64-encoded binary string (if the serialization mode for the property is binary serialization).

Applies to

Jaa