PersonalizationProvider.FindState Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
En cas de substitution dans une classe dérivée, retourne une collection qui contient un nombre d'objets dérivés de PersonalizationStateInfo supérieur ou égal à zéro, selon des paramètres de portée et des paramètres spécifiques à la requête.
public:
abstract System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope, System::Web::UI::WebControls::WebParts::PersonalizationStateQuery ^ query, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public abstract System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindState (System.Web.UI.WebControls.WebParts.PersonalizationScope scope, System.Web.UI.WebControls.WebParts.PersonalizationStateQuery query, int pageIndex, int pageSize, out int totalRecords);
abstract member FindState : System.Web.UI.WebControls.WebParts.PersonalizationScope * System.Web.UI.WebControls.WebParts.PersonalizationStateQuery * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public MustOverride Function FindState (scope As PersonalizationScope, query As PersonalizationStateQuery, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection
Paramètres
- scope
- PersonalizationScope
PersonalizationScope doté des informations de personnalisation à rechercher. Cette valeur ne peut pas être null
.
PersonalizationStateQuery contenant une requête. Cette valeur peut être null
.
- pageIndex
- Int32
Emplacement où commence la requête.
- pageSize
- Int32
Nombre d'enregistrements à retourner.
- totalRecords
- Int32
Nombre total d'enregistrements disponibles.
Retours
PersonalizationStateInfoCollection qui contient un nombre d'objets dérivés de PersonalizationStateInfo supérieur ou égal à zéro.
Remarques
Cette méthode est la définition abstraite d’une méthode administrative pour interroger les données de personnalisation. Les implémentations dérivées doivent suivre la logique décrite ci-dessous.
L’ensemble d’éléments retournés est limité par les pageIndex
paramètres et pageSize
, où pageSize
définit le nombre d’enregistrements à retourner et pageIndex
les enregistrements à retourner. Par exemple, un pageIndex
de 0 et un pageSize
de 25 retourneraient les 25 premières occurrences, tandis que un pageIndex
de 1 et un pageSize
de 25 retourneraient les occurrences 26 à 50. Si vous souhaitez récupérer tous les enregistrements disponibles, définissez pageIndex
sur 0 et MaxValuepageSize
sur .
Les PersonalizationStateInfoobjets dérivés sont retournés dans l’ordre alphabétique et triés par une combinaison de leurs Path valeurs de propriété et Username , dans l’ordre croissant.
Cette méthode transmet des caractères génériques de requête au magasin de données sous-jacent. La prise en charge des caractères génériques dépend actuellement de la façon dont chaque fournisseur gère des caractères tels qu’un astérisque (*), un symbole de pourcentage (%) ou un trait de soulignement (_).
Normalement, pour les magasins de données compatibles SQL, vous pouvez effectuer une recherche générique sur un chemin d’accès partiel avec le caractère générique qui apparaît au début, à la fin ou au milieu du texte de la chaîne de recherche dans la PathToMatch propriété. Par exemple, pour rechercher tous les chemins qui commencent par « ~/vdir », la PathToMatch propriété est définie sur « ~/vdir% ».
De même, une recherche générique sur un nom d’utilisateur partiel peut faire apparaître le caractère générique à n’importe quel point de la chaîne de texte de la UsernameToMatch propriété. Par exemple, pour rechercher tous les noms d’utilisateur qui commencent par « John », le UsernameToMatch paramètre ressemblerait à « John% ».
Les contraintes de requête suivantes s’appliquent :
Si uniquement
scope
est fourni etquery
estnull
ou toutes les propriétés surquery
les valeurs retournéesnull
ou par défaut, tous les enregistrements correspondant au paramètre indiquéscope
sont retournés.Si la PathToMatch propriété n’est pas
null
, les enregistrements retournés sont également filtrés en fonction des chemins qui correspondent à la PathToMatch valeur.Si la UsernameToMatch propriété n’est pas
null
, les enregistrements retournés sont également filtrés en fonction des noms d’utilisateur qui correspondent à la valeur de la UsernameToMatch propriété.Si la UserInactiveSinceDate propriété n’est pas égale à MaxValue, les enregistrements retournés sont également filtrés pour renvoyer uniquement les enregistrements associés aux utilisateurs inactifs. La comparaison inclut les enregistrements où la LastActivityDate propriété est inférieure ou égale à la UserInactiveSinceDate propriété .
Notez que cette méthode ne valide pas les combinaisons de paramètres de requête. Par exemple, le code peut demander un ensemble d’enregistrements d’état de personnalisation associés à un nom d’utilisateur spécifique dans l’étendue partagée. Étant donné que les noms d’utilisateur ne sont pas associés aux informations partagées, la collection retournée est vide.
Les combinaisons de paramètres qui ont le potentiel de retourner une collection non vide sont les suivantes :
Shared étendue en combinaison avec la PathToMatch propriété .
User étendue en combinaison avec les valeurs de l’une ou de l’ensemble PathToMatchdes propriétés , UsernameToMatchet UserInactiveSinceDate .