IsGrantedExtensions.CanReadByRole(SecurityStrategy, IPermissionPolicyRole, Type, String) Method

Checks whether the specified role allows reading objects of the specified type or these objects’ members.

Namespace: DevExpress.ExpressApp.Security

Assembly: DevExpress.ExpressApp.Security.v24.1.dll

NuGet Package: DevExpress.ExpressApp.Security

Declaration

C#

public static bool CanReadByRole(
    this SecurityStrategy security,
    IPermissionPolicyRole targetRole,
    Type type,
    string memberName = null
)

VB.NET

<ExtensionAttribute>
Public Shared Function CanReadByRole(
    security As SecurityStrategy,
    targetRole As IPermissionPolicyRole,
    type As Type,
    memberName As String = Nothing
) As Boolean

Parameters

Name	Type	Description
security	SecurityStrategy	A SecurityStrategy object that specifies an application’s Security Strategy.
targetRole	IPermissionPolicyRole	An IPermissionPolicyRole object that is a role this method checks.
type	Type	A Type of objects this method checks.

Optional Parameters

Name	Type	Default	Description
memberName	String	null	A String that is a name of an objects’ member this method checks. This parameter is optional.

Returns

Type	Description
Boolean	true, if the specified role allows reading objects of the specified type or these objects’ members; otherwise, false.

Remarks

The following example shows how to use this method.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Security;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl.PermissionPolicy;
using System;
// ...
public class CheckReadPermissionController : ObjectViewController<ListView, Contact> {
    SecurityStrategy securityStrategy;
    protected override void OnActivated() {
        base.OnActivated();
        securityStrategy = Application.GetSecurityStrategy();
        View.CurrentObjectChanged += View_CurrentObjectChanged;
    }
    private void View_CurrentObjectChanged(object sender, EventArgs e) {
        foreach (IPermissionPolicyRole role in ObjectSpace.GetObjects<PermissionPolicyRole>()) {
            if (!securityStrategy.CanReadByRole(role, typeof(Department), nameof(Department.Office))) {
                // ...
            }
        }
    }
}