PersonalizationAdministration.FindSharedState Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает коллекцию общих данных состояния персонализации на основе указанных параметров.
Перегрузки
FindSharedState(String) |
Возвращает коллекцию общих данных состояния персонализации на основе указанного пути. |
FindSharedState(String, Int32, Int32, Int32) |
Возвращает коллекцию общих данных состояния персонализации на основе указанных параметров. |
FindSharedState(String)
Возвращает коллекцию общих данных состояния персонализации на основе указанного пути.
public:
static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindSharedState(System::String ^ pathToMatch);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindSharedState (string pathToMatch);
static member FindSharedState : string -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function FindSharedState (pathToMatch As String) As PersonalizationStateInfoCollection
Параметры
- pathToMatch
- String
Путь к странице для сопоставления.
Возвращаемое значение
Объект PersonalizationStateInfoCollection, содержащий общие сведения о состоянии персонализации.
Исключения
Параметр pathToMatch
перед или после усечения представляет собой пустую строку ("").
-или-
Поставщик, указанный в конфигурации в качестве поставщика персонализации, имеет неправильный тип.
-или-
Длина строки для любого параметра превышает 256 символов.
При попытке создания и инициализации нового экземпляра одного из настроенных поставщиков персонализации получено исключение конфигурации.
-или-
Не удалось найти поставщик персонализации по умолчанию (определяется в конфигурации).
Комментарии
Этот метод возвращает коллекцию экземпляров UserPersonalizationStateInfo , значение которых pathToMatch
соответствует пути к странице с общими данными о состоянии персонализации. Коллекция содержит только SharedPersonalizationStateInfo экземпляры .
Этот метод передает подстановочные знаки параметров базовому поставщику персонализации, поэтому способ обработки этих символов в хранилище данных зависит от того, как поставщик обрабатывает символы, такие как звездочка (*), символ процента (%) или символ подчеркивания (_).
Как правило, для хранилищ данных, совместимых с SQL, можно выполнить поиск с подстановочными знаками по частичному пути с подстановочным знаком, отображаемым в начале, конце или середине текста строки поиска в свойстве PathToMatch . Например, чтобы найти все пути, начинающиеся с "~/vdir", свойству PathToMatch будет присвоено значение "~/vdir%".
При использовании поставщика персонализации по умолчанию объекты, PersonalizationStateInfoпроизводные от них, возвращаются в алфавитном порядке и сортируются по сочетанию пути и имени пользователя в порядке возрастания. Порядок объектов в коллекции определяется поставщиком.
Параметр pathToMatch
может иметь значение null
. Если задано значение null
, параметр игнорируется при выполнении запросов.
См. также раздел
- WebPartPersonalization
- элементы управления веб-частей ASP.NET
- Общие сведения о персонализации веб-частей
- Пошаговое руководство. Реализация персонализации веб-частей с помощью пользовательского элемента управления
- Персонализация веб-частей
Применяется к
FindSharedState(String, Int32, Int32, Int32)
Возвращает коллекцию общих данных состояния персонализации на основе указанных параметров.
public:
static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindSharedState(System::String ^ pathToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindSharedState (string pathToMatch, int pageIndex, int pageSize, out int totalRecords);
static member FindSharedState : string * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function FindSharedState (pathToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection
Параметры
- pathToMatch
- String
Путь к странице для сопоставления.
- pageIndex
- Int32
Отсчет индекса возвращаемой страницы результатов начинается с нуля.
- pageSize
- Int32
Число возвращаемых записей.
- totalRecords
- Int32
Общее число доступных записей.
Возвращаемое значение
Объект PersonalizationStateInfoCollection, содержащий общие сведения о состоянии персонализации.
Исключения
Параметр pathToMatch
перед или после усечения представляет собой пустую строку ("").
-или-
Значение параметра pageIndex
меньше нуля.
-или-
pageSize
меньше или равно нулю.
-или-
Сочетание pageIndex
и pageSize
превышает Значение Int32.MaxValue.
-или-
Поставщик, указанный в конфигурации в качестве поставщика персонализации, имеет неправильный тип.
-или-
Длина строки для любого параметра превышает 256 символов.
При попытке создания и инициализации нового экземпляра одного из настроенных поставщиков персонализации получено исключение конфигурации.
-или-
Не удалось найти поставщик персонализации по умолчанию (определяется в конфигурации).
Комментарии
Этот метод возвращает коллекцию экземпляров UserPersonalizationStateInfo , значение которых pathToMatch
соответствует пути к странице с общими данными о состоянии персонализации. Коллекция содержит только SharedPersonalizationStateInfo экземпляры .
Этот метод передает подстановочные знаки параметров базовому поставщику персонализации, поэтому способ обработки этих символов в хранилище данных зависит от того, как поставщик обрабатывает символы, такие как звездочка (*), символ процента (%) или символ подчеркивания (_).
Как правило, для хранилищ данных, совместимых с SQL, можно выполнить поиск с подстановочными знаками по частичному пути с подстановочным знаком, отображаемым в начале, конце или середине текста строки поиска в свойстве PathToMatch . Например, чтобы найти все пути, начинающиеся с "~/vdir", свойству PathToMatch будет присвоено значение "~/vdir%".
При использовании поставщика персонализации по умолчанию объекты, PersonalizationStateInfoпроизводные от них, возвращаются в алфавитном порядке и сортируются по сочетанию пути и имени пользователя в порядке возрастания. Порядок объектов в коллекции определяется поставщиком.
Параметр pathToMatch
может иметь значение null
. Если задано значение null
, параметр игнорируется при выполнении запросов.
Возвращаемые данные ограничиваются pageIndex
и pageSize
, где pageIndex
управляет возвращаемыми записями и pageSize
количеством возвращаемых записей. Например, если pageIndex
задано значение 0, а pageSize
для — значение 25, возвращаемые данные будут первыми 25 записями. Если pageIndex
задано значение 1, а pageSize
для — значение 25, то возвращаемыми данными будут записи от 26 до 50. Параметр totalRecords
возвращает общее количество доступных записей.
См. также раздел
- WebPartPersonalization
- элементы управления веб-частей ASP.NET
- Общие сведения о персонализации веб-частей
- Пошаговое руководство. Реализация персонализации веб-частей с помощью пользовательского элемента управления
- Персонализация веб-частей