Page.ViewStateUserKey Property

Reference

Definition

Namespace:: System.Web.UI

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.

Assigns an identifier to an individual user in the view-state variable associated with the current page.

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

[System.ComponentModel.Browsable(false)]
public string ViewStateUserKey { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.ViewStateUserKey : string with get, set

Public Property ViewStateUserKey As String

Property Value

String

The identifier for the individual user.

Attributes: BrowsableAttribute

Exceptions

HttpException

The ViewStateUserKey property was accessed too late during page processing.

Remarks

Setting the ViewStateUserKey property can help you prevent attacks on your application from malicious users. It does this by allowing you to assign an identifier to the view-state variable for individual users so that they cannot use the variable to generate an attack. For more information about Web attacks and about what you can do to help prevent them, see Take Advantage of ASP.NET Built-in Features to Fend Off Web Attacks.

You can set this property to any string value, such as the user's authenticated name or the SessionID value.

Note

You must set this property during the Page_Init phase of page processing. Setting this property during the Page_Load phase throws an exception.

Applies to

Jaa