SiteMapProvider.IsAccessibleToUser Method

Retrieves a Boolean value indicating whether the specified SiteMapNode object can be viewed by the user in the specified context.

Namespace: System.Web
Assembly: System.Web (in system.web.dll)

public:
virtual bool IsAccessibleToUser (
	HttpContext^ context, 
	SiteMapNode^ node
)
public boolean IsAccessibleToUser (
	HttpContext context, 
	SiteMapNode node
)
public function IsAccessibleToUser (
	context : HttpContext, 
	node : SiteMapNode
) : boolean
Not applicable.

Parameters

context

The HttpContext that contains user information.

node

The SiteMapNode that is requested by the user.

Return Value

true if security trimming is enabled and node can be viewed by the user or security trimming is not enabled; otherwise, false.

Exception typeCondition

ArgumentNullException

context is a null reference (Nothing in Visual Basic).

- or -

node is a null reference (Nothing in Visual Basic).

The default behavior when security trimming is enabled is as described in the following table.

Condition

Return Value

The Roles exists on node and the current user is in at least one of the specified roles.

- or -

The current thread has an associated WindowsIdentity that has file access to the requested URL and the URL is located within the directory structure for the application.

- or -

The current user is authorized specifically for the requested URL in the authorization element for the current application and the URL is located within the directory structure for the application.

true

None of the preceding conditions is met.

false

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: