SessionParameter SessionParameter SessionParameter SessionParameter Class

Определение

Привязывает значение переменной сеанса к объекту параметра.Binds the value of a session variable to a parameter object.

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
Наследование
SessionParameterSessionParameterSessionParameterSessionParameter

Примеры

В следующем примере показано, как использовать SessionParameter объекта.The following example shows how to use a SessionParameter object. В примере предполагается, что другая страница хранимая значение идентификатора сотрудника в переменной сеанса с именем empid.The example assumes that another page has stored an employee ID value in a session variable named empid. На странице примера используется empid переменной сеанса в Where предложение запроса и отображает результат запроса в GridView элемента управления.The example page uses the empid session variable in the Where clause of a query and displays the result of the query in a GridView control. Так как DefaultValue свойство SessionParameter объекта имеет значение 5, данные для записи, которая имеет employeeID значение 5 по-прежнему отображается, если нет переменной сеанса с именем empid устанавливается перед запуском примера.Because the DefaultValue property of the SessionParameter object is set to 5, data for the record that has the employeeID value of 5 will still be displayed if no session variable named empid is set before you run the example.

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

Комментарии

Объект SessionParameter обычно используется для включения значение HttpSessionState переменных в Where предложение запроса к базе данных.A SessionParameter object is typically used in order to include the value of an HttpSessionState variable in the Where clause of a database query. SessionField Свойство идентифицирует переменной сеанса, с которого SessionParameter извлекает значение.The SessionField property identifies the session variable from which the SessionParameter retrieves a value.

Примечание

Элементы управления с привязкой данных к параметру с помощью SessionParameter объект может вызвать исключение, если указанный сеанс переменная не задана.Controls that bind data to a parameter by using a SessionParameter object might throw an exception if the specified session variable is not set. Чтобы избежать этой ошибки (где это необходимо), задайте DefaultValue свойство.To avoid this error (where appropriate), set the DefaultValue property.

Конструкторы

SessionParameter() SessionParameter() SessionParameter() SessionParameter()

Инициализирует новый безымянный экземпляр класса SessionParameter.Initializes a new unnamed instance of the SessionParameter class.

SessionParameter(SessionParameter) SessionParameter(SessionParameter) SessionParameter(SessionParameter) SessionParameter(SessionParameter)

Инициализирует новый экземпляр класса SessionParameter значениями экземпляра, заданного параметром original.Initializes a new instance of the SessionParameter class with the values of the instance specified by the original parameter.

SessionParameter(String, DbType, String) SessionParameter(String, DbType, String) SessionParameter(String, DbType, String) SessionParameter(String, DbType, String)

Инициализирует новый именованный экземпляр класса SessionParameter, используя заданные имя и тип и привязывая параметр к заданной паре строку имя-значение состояния сеанса.Initializes a new instance of the SessionParameter class, by using the specified name and type, and binding the parameter to the specified session state name/value pair. Этот конструктор предназначен для типов базы данных.This constructor is for database types.

SessionParameter(String, String) SessionParameter(String, String) SessionParameter(String, String) SessionParameter(String, String)

Инициализирует новый именованный экземпляр класса SessionParameter, используя заданную строку для идентификации пары имя-значение состояния сеанса, к которой выполняется привязка.Initializes a new named instance of the SessionParameter class, using the specified string to identify which session state name/value pair to bind to.

SessionParameter(String, TypeCode, String) SessionParameter(String, TypeCode, String) SessionParameter(String, TypeCode, String) SessionParameter(String, TypeCode, String)

Инициализирует новый именованный и строго типизированный экземпляр класса SessionParameter, используя указанную строку для идентификации пары имя-значение состоянии сеанса, к которой выполняется привязка.Initializes a new named and strongly typed instance of the SessionParameter class, using the specified string to identify which session state name/value pair to bind to.

Свойства

ConvertEmptyStringToNull ConvertEmptyStringToNull ConvertEmptyStringToNull ConvertEmptyStringToNull

Возвращает или задает значение, указывающее на необходимость преобразования значения, к которому привязан объект Parameter в null, если его значение равно Empty.Gets or sets a value indicating whether the value that the Parameter object is bound to should be converted to null if it is Empty.

(Inherited from Parameter)
DbType DbType DbType DbType

Возвращает или задает тип базы данных параметра.Gets or sets the database type of the parameter.

(Inherited from Parameter)
DefaultValue DefaultValue DefaultValue DefaultValue

Задает значение по умолчанию для параметра, если значение, к которому привязан параметр, должно быть инициализировано при вызове метода Evaluate(HttpContext, Control).Specifies a default value for the parameter, should the value that the parameter is bound to be uninitialized when the Evaluate(HttpContext, Control) method is called.

(Inherited from Parameter)
Direction Direction Direction Direction

Указывает, используется ли объект Parameter для привязки значения к элементу управления или же элемент управления можно использовать для изменения значения.Indicates whether the Parameter object is used to bind a value to a control, or the control can be used to change the value.

(Inherited from Parameter)
IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState

Получает значение, указывающее сохраняет ли объект Parameter изменения в данных о состоянии представления.Gets a value indicating whether the Parameter object is saving changes to its view state.

(Inherited from Parameter)
IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

Получает значение, указывающее сохраняет ли объект Parameter изменения в данных о состоянии представления.Gets a value indicating whether the Parameter object is saving changes to its view state.

(Inherited from Parameter)
Name Name Name Name

Получает или задает имя параметра.Gets or sets the name of the parameter.

(Inherited from Parameter)
SessionField SessionField SessionField SessionField

Возвращает или задает имя переменной сеанса, к которой привязывается параметр.Gets or sets the name of the session variable that the parameter binds to.

Size Size Size Size

Возвращает или задает размер параметра.Gets or sets the size of the parameter.

(Inherited from Parameter)
Type Type Type Type

Получает или задает тип параметра.Gets or sets the type of the parameter.

(Inherited from Parameter)
ViewState ViewState ViewState ViewState

Возвращает словарь сведений о состоянии, позволяющих сохранять и восстанавливать состояние представления объекта Parameter при нескольких запросах одной и той же страницы.Gets a dictionary of state information that allows you to save and restore the view state of a Parameter object across multiple requests for the same page.

(Inherited from Parameter)

Методы

Clone() Clone() Clone() Clone()

Возвращает дубликат текущего экземпляра SessionParameter.Returns a duplicate of the current SessionParameter instance.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Evaluate(HttpContext, Control) Evaluate(HttpContext, Control) Evaluate(HttpContext, Control) Evaluate(HttpContext, Control)

Обновляет и возвращает значение объекта SessionParameter.Updates and returns the value of the SessionParameter object.

GetDatabaseType() GetDatabaseType() GetDatabaseType() GetDatabaseType()

Возвращает значение DbType, эквивалентное типу среды CLR текущего экземпляра Parameter.Gets the DbType value that is equivalent to the CLR type of the current Parameter instance.

(Inherited from Parameter)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

Восстанавливает сохраненное раннее состояние представления источника данных.Restores the data source view's previously saved view state.

(Inherited from Parameter)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
OnParameterChanged() OnParameterChanged() OnParameterChanged() OnParameterChanged()

Вызывает метод OnParametersChanged(EventArgs) коллекции ParameterCollection, содержащей объект Parameter.Calls the OnParametersChanged(EventArgs) method of the ParameterCollection collection that contains the Parameter object.

(Inherited from Parameter)
SaveViewState() SaveViewState() SaveViewState() SaveViewState()

Сохраняет изменения в данных о состоянии представления объекта Parameter после обратной передачи страницы на сервер.Saves the changes to the Parameter object's view state since the time the page was posted back to the server.

(Inherited from Parameter)
SetDirty() SetDirty() SetDirty() SetDirty()

Обозначает объект Parameter как подлежащий записи его состояния в данные о состоянии представления.Marks the Parameter object so its state will be recorded in view state.

(Inherited from Parameter)
ToString() ToString() ToString() ToString()

Преобразует значение этого экземпляра в эквивалентное ему строковое представление.Converts the value of this instance to its equivalent string representation.

(Inherited from Parameter)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

Инициирует отслеживание объектом Parameter изменений в состоянии его представления, благодаря чему их можно сохранить для этого объекта ViewState элемента управления и хранить их для всех запросов одной и той же страницы.Causes the Parameter object to track changes to its view state so they can be stored in the control's ViewState object and persisted across requests for the same page.

(Inherited from Parameter)

Явные реализации интерфейса

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()

Возвращает дубликат текущего экземпляра Parameter.Returns a duplicate of the current Parameter instance.

(Inherited from Parameter)
IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object)

Восстанавливает сохраненное раннее состояние представления источника данных.Restores the data source view's previously saved view state.

(Inherited from Parameter)
IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState()

Сохраняет изменения в данных о состоянии представления объекта Parameter после обратной передачи страницы на сервер.Saves the changes to the Parameter object's view state since the time the page was posted back to the server.

(Inherited from Parameter)
IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState()

Инициирует отслеживание объектом Parameter изменений в состоянии его представления, благодаря чему их можно сохранить для этого объекта ViewState элемента управления и хранить их для всех запросов одной и той же страницы.Causes the Parameter object to track changes to its view state so they can be stored in the control's ViewState object and persisted across requests for the same page.

(Inherited from Parameter)

Применяется к

Дополнительно