SessionParameter Classe

Referência

Definição

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Associa o valor de uma variável de sessão a um objeto de parâmetro.

public ref class SessionParameter : System::Web::UI::WebControls::Parameter

public class SessionParameter : System.Web.UI.WebControls.Parameter

type SessionParameter = class
    inherit Parameter

Public Class SessionParameter
Inherits Parameter

Herança: Object

Parameter
SessionParameter

Exemplos

O exemplo a seguir mostra como usar um SessionParameter objeto . O exemplo pressupõe que outra página tenha armazenado um valor de ID de funcionário em uma variável de sessão chamada empid. A página de exemplo usa a empid variável de sessão na Where cláusula de uma consulta e exibe o resultado da consulta em um GridView controle. Como a DefaultValue propriedade do SessionParameter objeto é definida como 5, os dados do registro que tem o employeeID valor 5 ainda serão exibidos se nenhuma variável de sessão nomeada empid for definida antes de executar o exemplo.

<%@ 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>

<%@ Page language="VB"%>
<!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>

Comentários

Um SessionParameter objeto normalmente é usado para incluir o valor de uma HttpSessionState variável na Where cláusula de uma consulta de banco de dados. A SessionField propriedade identifica a variável de sessão da qual o SessionParameter recupera um valor.

Observação

Controles que associam dados a um parâmetro usando um SessionParameter objeto podem gerar uma exceção se a variável de sessão especificada não estiver definida. Para evitar esse erro (quando apropriado), defina a DefaultValue propriedade .

Construtores

SessionParameter()	Inicializa uma nova instância não nomeada da classe SessionParameter.
SessionParameter(SessionParameter)	Inicializa uma nova instância da classe SessionParameter com os valores da instância especificada pelo parâmetro `original`.
SessionParameter(String, DbType, String)	Inicializa uma nova instância da classe SessionParameter usando o nome e tipo especificados e associando o parâmetro ao par nome-valor de estado de sessão especificado. Este construtor é para tipos de banco de dados.
SessionParameter(String, String)	Inicializa uma nova instância nomeada da classe SessionParameter, usando a cadeia de caracteres especificada para identificar a qual par nome-valor do estado de sessão se associar.
SessionParameter(String, TypeCode, String)	Inicializa uma nova instância nomeada e fortemente tipada da classe SessionParameter, usando a cadeia de caracteres especificada para identificar a qual par nome-valor do estado de sessão se associar.

Propriedades

ConvertEmptyStringToNull	Obtém ou define um valor que indica se o valor ao qual o objeto Parameter está associado deverá ser convertido em `null` se ele for Empty. (Herdado de Parameter)
DbType	Obtém ou define o tipo de banco de dados do parâmetro. (Herdado de Parameter)
DefaultValue	Especifica um valor padrão para o parâmetro, caso o valor a que o parâmetro esteja associado não devesse ser inicializado quando o método Evaluate(HttpContext, Control) for chamado. (Herdado de Parameter)
Direction	Indica se o objeto Parameter é usado para associar um valor a um controle ou o controle pode ser usado para alterar o valor. (Herdado de Parameter)
IsTrackingViewState	Obtém um valor que indica se o objeto Parameter está salvando alterações no estado de exibição. (Herdado de Parameter)
Name	Obtém ou define o nome do parâmetro. (Herdado de Parameter)
SessionField	Obtém ou define o nome da variável de sessão à qual o parâmetro se associa.
Size	Obtém ou define o tamanho do parâmetro. (Herdado de Parameter)
Type	Obtém ou define o tipo do parâmetro. (Herdado de Parameter)
ViewState	Obtém um dicionário de informações de estado que permite salvar e restaurar o estado de exibição de um objeto Parameter em várias solicitações da mesma página. (Herdado de Parameter)

Métodos

Clone()	Retorna uma duplicata da instância de SessionParameter atual.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
Evaluate(HttpContext, Control)	Atualiza e retorna o valor do objeto SessionParameter.
GetDatabaseType()	Obtém o valor DbType que é equivalente ao tipo CLR da instância Parameter atual. (Herdado de Parameter)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
LoadViewState(Object)	Restaura o estado de exibição salvo anteriormente da exibição de fonte de dados. (Herdado de Parameter)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
OnParameterChanged()	Chama o método OnParametersChanged(EventArgs) da coleção ParameterCollection que contém o objeto Parameter. (Herdado de Parameter)
SaveViewState()	Salva as alterações ao estado de exibição do objeto Parameter desde a hora em que a página foi postada de volta no servidor. (Herdado de Parameter)
SetDirty()	Marca o objeto Parameter de modo que seu estado seja registrado no estado de exibição. (Herdado de Parameter)
ToString()	Converte o valor dessa instância na representação da cadeia de caracteres equivalente. (Herdado de Parameter)
TrackViewState()	Faz com que o objeto Parameter controle as alterações a seu estado de exibição de modo que elas possam ser armazenadas no objeto ViewState do controle e persistidas entre solicitações para a mesma página. (Herdado de Parameter)

Implantações explícitas de interface

ICloneable.Clone()	Retorna uma duplicata da instância de Parameter atual. (Herdado de Parameter)
IStateManager.IsTrackingViewState	Obtém um valor que indica se o objeto Parameter está salvando alterações no estado de exibição. (Herdado de Parameter)
IStateManager.LoadViewState(Object)	Restaura o estado de exibição salvo anteriormente da exibição de fonte de dados. (Herdado de Parameter)
IStateManager.SaveViewState()	Salva as alterações ao estado de exibição do objeto Parameter desde a hora em que a página foi postada de volta no servidor. (Herdado de Parameter)
IStateManager.TrackViewState()	Faz com que o objeto Parameter controle as alterações a seu estado de exibição de modo que elas possam ser armazenadas no objeto ViewState do controle e persistidas entre solicitações para a mesma página. (Herdado de Parameter)

Aplica-se a

Compartilhar via