ClientRolePrincipal.IsInRole(String) Metoda

Reference

Definice

Obor názvů:: System.Web.ClientServices

Sestavení:: System.Web.Extensions.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Získá hodnotu označ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 je uživatel v roli "manažer". Tento příklad vyžaduje pojmenovaný ButtonmanagerOnlyButton s počáteční Visible hodnotou falsevlastnosti .

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í. Můžete však přetypovat CurrentPrincipal hodnotu vlastnosti na ClientRolePrincipal odkaz pro explicitní volání této metody, jak je znázorněno v části Příklad.

Metoda IsInRole se 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ů jindy, můžete přidat kód pro opětovné ověření uživatelů, jejichž přihlašovací údaje vypršely. Pokud jsou k rolím přiřazeni všichni platné uživatelé, můžete voláním ClientRoleProvider.GetRolesForUser metody zjistit, jestli vypršela platnost přihlášení. Pokud se nevrátí žádné role, platnost přihlášení vypršela. Příklad této funkce najdete v GetRolesForUser metodě. Tato funkce je nezbytná pouze v případě, že jste vybrali možnost Vyžadovat, aby se uživatelé znovu přihlásili vždy, když v konfiguraci aplikace vyprší platnost souboru cookie serveru .

Platí pro

Sdílet prostřednictvím