Page.ViewStateUserKey Property (System.Web.UI)

ViewStateUserKey Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Page..::.ViewStateUserKey Property

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

Namespace: System.Web.UI
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

<BrowsableAttribute(False)> _
Public Property ViewStateUserKey As String

Visual Basic (Usage)

Dim instance As Page
Dim value As String

value = instance.ViewStateUserKey

instance.ViewStateUserKey = value

[BrowsableAttribute(false)]
public string ViewStateUserKey { get; set; }

Visual C++

[BrowsableAttribute(false)]
public:
property String^ ViewStateUserKey {
    String^ get ();
    void set (String^ value);
}

JScript

public function get ViewStateUserKey () : String
public function set ViewStateUserKey (value : String)

ASP.NET

<asp:Page ViewStateUserKey="String" />

Property Value

Type: System..::.String
The identifier for the individual user.

Exceptions

Exception	Condition
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. You can set this property to any string value, such as the user's session ID or the user's authenticated name.

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1

Reference

Page Class

Page Members

System.Web.UI Namespace