PersonalizationAdministration.FindUserState Метод

Определение

Пространство имен:

System.Web.UI.WebControls.WebParts

Сборка:

System.Web.dll

Возвращает коллекцию данных состояния персонализации "на пользователя" на основе указанных параметров.

Перегрузки

FindUserState(String, String)	Возвращает коллекцию данных состояния персонализации "на пользователя" на основе имени пользователя и пути к странице.
FindUserState(String, String, Int32, Int32, Int32)	Возвращает коллекцию данных состояния персонализации "на пользователя" на основе указанных параметров.

FindUserState(String, String)

Возвращает коллекцию данных состояния персонализации "на пользователя" на основе имени пользователя и пути к странице.

public:
 static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindUserState(System::String ^ pathToMatch, System::String ^ usernameToMatch);

public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindUserState (string pathToMatch, string usernameToMatch);

static member FindUserState : string * string -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection

Public Shared Function FindUserState (pathToMatch As String, usernameToMatch As String) As PersonalizationStateInfoCollection

Параметры

pathToMatch

String

Путь к странице для сопоставления.

usernameToMatch

String

Имя пользователя для сопоставления, имеющее данные персонализации, связанные с данной страницей.

Возвращаемое значение

PersonalizationStateInfoCollection

Объект PersonalizationStateInfoCollection, содержащий сведения о состоянии персонализации "на пользователя".

Исключения

ArgumentException

Параметр pathToMatch или usernameToMatch перед или после усечения представляет собой пустую строку ("").

-или-

Поставщик, указанный в конфигурации в качестве поставщика персонализации, имеет неправильный тип.

-или-

Длина строки для любого параметра превышает 256 символов.

ConfigurationErrorsException

При попытке создания и инициализации нового экземпляра одного из настроенных поставщиков персонализации получено исключение конфигурации.

-или-

Не удалось найти поставщик персонализации по умолчанию (определяется в конфигурации).

Примеры

В следующем примере кода показано, как использовать метод FindUserState. Полный пример можно найти в PersonalizationAdministration разделе обзора класса.

Важно!

В этом примере имеется текстовое поле, принимающее вводимые пользователем данные, что является потенциальной угрозой безопасности. По умолчанию данные, вводимые пользователем на веб-страницах ASP.NET, проверяются на наличие скриптов и HTML-элементов. Дополнительные сведения см. в разделе Общие сведения об использовании сценариев.

protected void Button1_Click(object sender, EventArgs e)
{
    if (TextBox3.Text != null)
    {
        PersonalizationStateInfoCollection findresult;
      findresult = PersonalizationAdministration.FindUserState(null, TextBox3.Text);
      if (findresult.Count != 0)
      {
          Label4.Text = findresult.Count + "  user(s) found";
          Label4.Visible = true;
      }
      else
      {
          Label4.Text = "No users found.";
          Label4.Visible = true;
      }
    }
  else
  {
      Label4.Text = "You must enter a user name to find.";
  }

}

Комментарии

Этот метод возвращает коллекцию экземпляров UserPersonalizationStateInfo , в которых pathToMatch значение параметра соответствует пути к странице и usernameToMatch соответствует имени пользователя с данными персонализации, связанными с этой страницей. Коллекция содержит только UserPersonalizationStateInfo экземпляры .

Этот метод передает подстановочные знаки параметров базовому поставщику персонализации, поэтому способ обработки этих символов в хранилище данных зависит от того, как поставщик обрабатывает символы, такие как звездочка (*), символ процента (%) или символ подчеркивания (_).

Как правило, для хранилищ данных, совместимых с SQL, можно выполнить поиск с подстановочными знаками по частичному пути с подстановочным знаком, отображаемым в начале, конце или середине текста строки поиска в свойстве PathToMatch . Например, чтобы найти все пути, начинающиеся с "~/vdir", свойству PathToMatch будет присвоено значение "~/vdir%".

Аналогичным образом, при поиске с подстановочными знаками по частичному имени пользователя может отображаться подстановочный знак в любой точке текстовой UsernameToMatch строки свойства. Например, чтобы найти все имена пользователей, которые начинаются с "John", UsernameToMatch свойство будет выглядеть как "John%".

При использовании поставщика персонализации по умолчанию объекты, PersonalizationStateInfoпроизводные от них, возвращаются в алфавитном порядке и сортируются по сочетанию пути и имени пользователя в порядке возрастания. Порядок объектов в коллекции определяется поставщиком.

И pathToMatch , и usernameToMatch могут иметь значение null. Параметр usernameToMatch может содержать запятые (,), так как в некоторых хранилищах данных, таких как Microsoft SQL Server, запятые допускаются в качестве подстановочных знаков.

См. также раздел

• WebPartPersonalization
• элементы управления веб-частей ASP.NET
• Общие сведения о персонализации веб-частей
• Пошаговое руководство. Реализация персонализации веб-частей с помощью пользовательского элемента управления
• Персонализация веб-частей

FindUserState(String, String, Int32, Int32, Int32)

Возвращает коллекцию данных состояния персонализации "на пользователя" на основе указанных параметров.

public:
 static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindUserState(System::String ^ pathToMatch, System::String ^ usernameToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);

public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindUserState (string pathToMatch, string usernameToMatch, int pageIndex, int pageSize, out int totalRecords);

static member FindUserState : string * string * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection

Public Shared Function FindUserState (pathToMatch As String, usernameToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection

Параметры

pathToMatch

String

Путь к странице для сопоставления.

usernameToMatch

String

Имя пользователя для сопоставления, имеющее данные персонализации, связанные с данной страницей.

pageIndex

Int32

Отсчет индекса возвращаемой страницы результатов начинается с нуля.

pageSize

Int32

Число возвращаемых записей.

totalRecords

Int32

Общее число доступных записей.

Возвращаемое значение

PersonalizationStateInfoCollection

Объект PersonalizationStateInfoCollection, содержащий сведения о состоянии персонализации "на пользователя".

Исключения

ArgumentException

Параметр pathToMatch или usernameToMatch перед или после усечения представляет собой пустую строку ("").

-или-

Значение параметра pageIndex меньше нуля.

-или-

pageSize меньше или равно нулю.

-или-

Сочетание pageIndex и pageSize превышает Значение Int32.MaxValue.

-или-

Поставщик, указанный в конфигурации в качестве поставщика персонализации, имеет неправильный тип.

-или-

Длина строки для любого параметра превышает 256 символов.

ConfigurationErrorsException

При попытке создания и инициализации нового экземпляра одного из настроенных поставщиков персонализации получено исключение конфигурации.

-или-

Не удалось найти поставщик персонализации по умолчанию (определяется в конфигурации).

Примеры

В следующем примере кода показано, как использовать метод FindUserState. Полный пример можно найти в PersonalizationAdministration разделе обзора класса.

Важно!

В этом примере имеется текстовое поле, принимающее вводимые пользователем данные, что является потенциальной угрозой безопасности. По умолчанию данные, вводимые пользователем на веб-страницах ASP.NET, проверяются на наличие скриптов и HTML-элементов. Дополнительные сведения см. в разделе Общие сведения об использовании сценариев.

protected void Button1_Click(object sender, EventArgs e)
{
    if (TextBox3.Text != null)
    {
        PersonalizationStateInfoCollection findresult;
      findresult = PersonalizationAdministration.FindUserState(null, TextBox3.Text);
      if (findresult.Count != 0)
      {
          Label4.Text = findresult.Count + "  user(s) found";
          Label4.Visible = true;
      }
      else
      {
          Label4.Text = "No users found.";
          Label4.Visible = true;
      }
    }
  else
  {
      Label4.Text = "You must enter a user name to find.";
  }

}

Комментарии

Этот метод возвращает коллекцию экземпляров UserPersonalizationStateInfo , где pathToMatch значение параметра соответствует пути к странице и usernameToMatch соответствует имени пользователя с данными персонализации, связанными с этой страницей. Коллекция содержит только UserPersonalizationStateInfo экземпляры .

Этот метод передает подстановочные знаки параметров базовому поставщику персонализации, поэтому способ обработки этих символов в хранилище данных зависит от того, как поставщик обрабатывает символы в виде звездочки (*), символа процента (%) или символа подчеркивания (_).

Как правило, для хранилищ данных, совместимых с SQL, можно выполнить поиск с подстановочными знаками по частичному пути с подстановочным знаком, отображаемым в начале, конце или середине текста строки поиска в свойстве PathToMatch . Например, чтобы найти все пути, начинающиеся с "~/vdir", свойству PathToMatch будет присвоено значение "~/vdir%".

Аналогичным образом, при поиске с подстановочными знаками по частичному имени пользователя может отображаться подстановочный знак в любой точке текстовой UsernameToMatch строки свойства. Например, чтобы найти все имена пользователей, которые начинаются с "John", UsernameToMatch свойство будет выглядеть как "John%".

При использовании поставщика персонализации по умолчанию объекты, PersonalizationStateInfoпроизводные от них, возвращаются в алфавитном порядке и сортируются по сочетанию пути и имени пользователя в порядке возрастания. Порядок объектов в коллекции определяется поставщиком.

И pathToMatch , и usernameToMatch могут иметь значение null. Параметр usernameToMatch может содержать запятые (,), так как в некоторых хранилищах данных, таких как Microsoft SQL Server, запятые допускаются в качестве подстановочных знаков.

Возвращаемые данные ограничиваются pageIndex и pageSize, где pageIndex управляет возвращаемыми записями и pageSize количеством возвращаемых записей. Например, если pageIndex задано значение 0, а pageSize для — значение 25, возвращаемые данные будут первыми 25 записями. Если pageIndex задано значение 1, а pageSize для — значение 25, то возвращаемыми данными будут записи от 26 до 50. Параметр totalRecords возвращает общее количество доступных записей.

См. также раздел

• WebPartPersonalization
• элементы управления веб-частей ASP.NET
• Общие сведения о персонализации веб-частей
• Пошаговое руководство. Реализация персонализации веб-частей с помощью пользовательского элемента управления
• Персонализация веб-частей