This documentation is archived and is not being maintained.

SessionParameter.SessionField Property

Gets or sets the name of the session variable that the parameter binds to.

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

public string SessionField { get; set; }

Property Value

Type: System.String
A string that identifies the HttpSessionState that the parameter binds to.

The SessionField property identifies a name/value pair that is stored in the current session object associated with the Web browser. While the SessionField property identifies the name of the pair, the SessionParameter binds to its corresponding value at run time. If the expected session string name/value pair is not found in the session, the Evaluate method binds the parameter to the value of the DefaultValue property, if it is set. If the DefaultValue property is not set, the Evaluate method fails to bind the parameter to a value.

The following code example demonstrates how to declaratively create a SessionParameter object, set its Name, SessionField and DefaultValue properties, and add it to the SelectParameters collection of a SqlDataSource control. A GridView control displays the results of the SQL query submitted by the SqlDataSource control.


<%@ Page language="C#"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="Form1" method="post" runat="server">
      <p>Show My Orders:</p>

      <asp:SqlDataSource
          id="OdbcDataSource1"
          runat="server"
          ProviderName="System.Data.Odbc"
          ConnectionString="dsn=MyOdbcDsn;"
          SelectCommand="SELECT OrderId, CustomerId, OrderDate
                         FROM Orders
                         WHERE EmployeeID = ?
                         ORDER BY CustomerId ASC;">
          <SelectParameters>
              <asp:SessionParameter
                Name="empid"
                SessionField="empid"
                DefaultValue="5" />
          </SelectParameters>
      </asp:SqlDataSource>

      <p>
      <asp:GridView
          id="GridView1"
          runat="server"
          DataSourceID="OdbcDataSource1" />
      </p>
    </form>
  </body>
</html>


The following code example demonstrates how to programmatically set the SessionField property of a SessionParameter object.


// In this example, the session parameter "empid" is set
// after the employee successfully logs in.
SessionParameter empid = new SessionParameter();
empid.Name = "empid";
empid.Type = TypeCode.Int32;
empid.SessionField = "empid";


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: