Sdílet prostřednictvím

ClientRolePrincipal.IsInRole(String) Metoda

  • Reference

Definice

Obor názvů:
System.Web.ClientServices
Sestavení:
System.Web.Extensions.dll

Získá hodnotu určující, zda uživatel reprezentovaný ClientRolePrincipal je v zadané roli.

public:
 virtual bool IsInRole(System::String ^ role);
public bool IsInRole (string role);
abstract member IsInRole : string -> bool
override this.IsInRole : string -> bool
Public Function IsInRole (role As String) As Boolean

Parametry

role
String

Role, která se má zkontrolovat.

Návraty

Boolean

true, pokud je uživatel v zadané roli; false, pokud uživatel není v zadané roli nebo není ověřený.

Implementuje

IsInRole(String)

Příklady

Následující příklad kódu ukazuje, jak použít tuto metodu k zobrazení tlačítka pouze v případě, že uživatel je v roli "správce". Tento příklad vyžaduje Button pojmenovanou managerOnlyButton s počáteční hodnotou vlastnosti Visiblefalse.

private void DisplayButtonForManagerRole()
{
    try
    {
        ClientRolePrincipal rolePrincipal =
            System.Threading.Thread.CurrentPrincipal 
            as ClientRolePrincipal;

        if (rolePrincipal != null && rolePrincipal.IsInRole("manager"))
        {
            managerOnlyButton.Visible = true;
        }
    }
    catch (System.Net.WebException)
    {
        MessageBox.Show("Unable to access the roles service.",
            "Warning", MessageBoxButtons.OK, MessageBoxIcon.Warning);
    }
}

Private Sub DisplayButtonForManagerRole()

    Try

        Dim rolePrincipal As ClientRolePrincipal = TryCast( _
            System.Threading.Thread.CurrentPrincipal, ClientRolePrincipal)

        If rolePrincipal IsNot Nothing And _
            rolePrincipal.IsInRole("manager") Then

            managerOnlyButton.Visible = True

        End If

    Catch ex As System.Net.WebException

        MessageBox.Show("Unable to access the role service.", _
            "Warning", MessageBoxButtons.OK, MessageBoxIcon.Warning)

    End Try

End Sub

Poznámky

Za normálních okolností budete volat IsInRole metodu IPrincipal vrácenou staticThread.CurrentPrincipal vlastnost. Hodnotu vlastnosti CurrentPrincipal však můžete přetypovat na ClientRolePrincipal odkaz na volání této metody explicitně, jak je znázorněno v části Příklad.

Metoda IsInRole vždy vrátí false, pokud vypršela platnost přihlášení uživatele. K tomu nedojde, pokud vaše aplikace volá metodu IsInRole jednou krátce po ověření. Pokud vaše aplikace musí načítat role uživatelů v jiných časech, můžete chtít přidat kód pro opětovné ověření uživatelů, jejichž platnost vypršela. Pokud jsou všichni platná uživatelé přiřazeni k rolím, můžete zjistit, jestli vypršela platnost přihlášení voláním metody ClientRoleProvider.GetRolesForUser. Pokud se nevrátí žádné role, platnost přihlášení vypršela. Příklad této funkce najdete v GetRolesForUser metodě. Tato funkce je nutná pouze v případě, že jste vybrali Vyžadovat, aby se uživatelé znovu přihlásili, kdykoli vyprší platnost souboru cookie serveru v konfiguraci vaší aplikace.

Platí pro

Viz také