PersonalizationAdministration.FindUserState Méthode

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

Paramètres

Retours

Qui PersonalizationStateInfoCollection contient des informations d’état de personnalisation par utilisateur.

Exceptions

Exemples

L’exemple de code suivant montre comment utiliser la FindUserState méthode. L’exemple complet se trouve dans la rubrique vue d’ensemble de la PersonalizationAdministration classe.

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.";
  }

}

Remarques

Cette méthode retourne une collection d’instances où la valeur du pathToMatch paramètre correspond au chemin d’accès d’une page et usernameToMatch correspond à un nom d’utilisateur qui a des données de UserPersonalizationStateInfo personnalisation associées à cette page. La collection contient uniquement UserPersonalizationStateInfo des instances.

Cette méthode transmet des caractères génériques de paramètre au fournisseur de personnalisation sous-jacent. La façon dont le magasin de données gère ces caractères dépend de la façon dont le fournisseur gère les caractères tels qu’un astérisque (*), un symbole de pourcentage (%) ou un trait de soulignement (_).

Normalement, pour les magasins de données conformes à SQL, vous pouvez effectuer une recherche de caractères génériques sur un chemin d’accès partiel avec le caractère générique apparaissant au début, à la fin ou au milieu du texte de chaîne de recherche dans la PathToMatch propriété. Par exemple, pour rechercher tous les chemins d’accès commençant par « ~/vdir », la PathToMatch propriété est définie sur « ~/vdir%».

De même, une recherche de caractères génériques sur un nom d’utilisateur partiel peut avoir le caractère générique apparaître à n’importe quel point dans la chaîne de texte de la UsernameToMatch propriété. Par exemple, pour rechercher tous les noms d’utilisateur commençant par « John », la UsernameToMatch propriété ressemblerait à « John%».

À l’aide du fournisseur de personnalisation par défaut, les PersonalizationStateInfoobjets dérivés sont retournés par ordre alphabétique et triés par une combinaison de chemin d’accès et de nom d’utilisateur dans l’ordre croissant. L’ordre des objets de la collection est déterminé par le fournisseur.

Les deux pathToMatch et usernameToMatch peuvent être null. Le usernameToMatch paramètre peut avoir des virgules (,) car certains magasins de données, tels que ceux exécutant Microsoft SQL Server, autorisent les virgules comme caractères génériques.

Voir aussi

• WebPartPersonalization
• contrôles de composants WebPart ASP.NET
• Vue d’ensemble de la personnalisation des composants WebPart
• Procédure pas à pas : implémentation de la personnalisation des composants WebPart avec un contrôle utilisateur
• Personnalisation des composants WebPart

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

Paramètres

Retours

Qui PersonalizationStateInfoCollection contient des informations d’état de personnalisation par utilisateur.

Exceptions

Exemples

L’exemple de code suivant montre comment utiliser la FindUserState méthode. L’exemple complet se trouve dans la rubrique vue d’ensemble de la PersonalizationAdministration classe.

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.";
  }

}

Remarques

Cette méthode retourne une collection d’instances où la valeur du pathToMatch paramètre correspond au chemin d’accès d’une page et usernameToMatch correspond à un nom d’utilisateur qui a des données de UserPersonalizationStateInfo personnalisation associées à cette page. La collection contient uniquement UserPersonalizationStateInfo des instances.

Cette méthode transmet des caractères génériques de paramètre au fournisseur de personnalisation sous-jacent. Par conséquent, la façon dont le magasin de données gère ces caractères dépend de la façon dont le fournisseur gère les caractères en tant qu’astérisque (*), un symbole de pourcentage (%) ou un trait de soulignement (_).

Normalement, pour les magasins de données conformes à SQL, vous pouvez effectuer une recherche de caractères génériques sur un chemin d’accès partiel avec le caractère générique apparaissant au début, à la fin ou au milieu du texte de chaîne de recherche dans la PathToMatch propriété. Par exemple, pour rechercher tous les chemins d’accès commençant par « ~/vdir », la PathToMatch propriété est définie sur « ~/vdir%».

De même, une recherche de caractères génériques sur un nom d’utilisateur partiel peut avoir le caractère générique apparaître à n’importe quel point dans la chaîne de texte de la UsernameToMatch propriété. Par exemple, pour rechercher tous les noms d’utilisateur commençant par « John », la UsernameToMatch propriété ressemblerait à « John%».

À l’aide du fournisseur de personnalisation par défaut, les PersonalizationStateInfoobjets dérivés sont retournés par ordre alphabétique et triés par une combinaison de chemin d’accès et de nom d’utilisateur dans l’ordre croissant. L’ordre des objets de la collection est déterminé par le fournisseur.

Les deux pathToMatch et usernameToMatch peuvent être null. Le usernameToMatch paramètre peut avoir des virgules (,) car certains magasins de données, tels que ceux exécutant Microsoft SQL Server, autorisent les virgules comme caractères génériques.

Les données retournées sont limitées pageIndex par et pageSize, où pageIndex les contrôles des enregistrements à renvoyer et pageSize contrôlent le nombre d’enregistrements à retourner. Par exemple, si pageIndex elle a été définie sur 0 et pageSize a été définie sur 25, les données retournées sont les 25 premières entrées. Si pageIndex elle a été définie sur 1 et pageSize a été définie sur 25, les données retournées sont les entrées 26 à 50. Le totalRecords paramètre retourne le nombre total d’enregistrements disponibles.

Voir aussi

• WebPartPersonalization
• contrôles de composants WebPart ASP.NET
• Vue d’ensemble de la personnalisation des composants WebPart
• Procédure pas à pas : implémentation de la personnalisation des composants WebPart avec un contrôle utilisateur
• Personnalisation des composants WebPart