SiteMapNode.IsAccessibleToUser(HttpContext) Method

  • Reference

Definition

Namespace:
System.Web
Assembly:
System.Web.dll

Gets a value indicating whether the specified site map node can be viewed by the user in the specified context.

public:
 virtual bool IsAccessibleToUser(System::Web::HttpContext ^ context);
public virtual bool IsAccessibleToUser (System.Web.HttpContext context);
abstract member IsAccessibleToUser : System.Web.HttpContext -> bool
override this.IsAccessibleToUser : System.Web.HttpContext -> bool
Public Overridable Function IsAccessibleToUser (context As HttpContext) As Boolean

Parameters

context
HttpContext

The HttpContext that contains user information.

Returns

Boolean

true if any one of the following conditions is met: the security trimming is enabled and the current user is a member of at least one of the roles allowing access to view the site map node; the current user is authorized specifically for the requested node's URL in the authorization element for the current application and the URL is located within the directory structure for the application; the current thread has an associated WindowsIdentity that has file access to the requested node's URL and the URL is located within the directory structure for the application; or security trimming is not enabled and therefore any user is allowed to view the site map node; otherwise, false.

Exceptions

ArgumentNullException

The specified context is null.

Remarks

The IsAccessibleToUser method calls the IsAccessibleToUser method of the provider that the node is associated with, passing the specified context.

Applies to

See also