System.Web.UI.WebControls.WebParts.WebPart.AuthorizationFilter Property

Gets or sets an arbitrary string to determine whether a System.Web.UI.WebControls.WebParts.WebPart control is authorized to be added to a page.

Syntax

public virtual string AuthorizationFilter { set; get; }

Value

Documentation for this section has not yet been entered.

Remarks

The Web Parts control set does not implement any default behavior for the WebPart.AuthorizationFilter property. However, the property is provided so that you can assign an arbitrary string value to a custom System.Web.UI.WebControls.WebParts.WebPart control; this property can be checked by the System.Web.UI.WebControls.WebParts.WebPartManager control during its WebPartManager.AuthorizeWebPart event to determine whether the control can be added to the page.

In some cases, the WebPart.AuthorizationFilter property might be used with the ASP.NET role manager feature, so that if a user is in a certain role, and if the string value of the WebPart.AuthorizationFilter property meets certain conditions set by the developer, then the control can be added. This approach allows developers to create custom views of a page based on a combination of roles and other authorization criteria that they specify.

This property cannot be set by themes or style sheet themes. For more information, see System.Web.UI.ThemeableAttribute and ASP.NET Themes Overview.

The personalization scope of this property is set to PersonalizationScope.Shared and can be modified only by authorized users. For more information, see System.Web.UI.WebControls.WebParts.PersonalizableAttribute and Web Parts Personalization Overview.

Requirements

Namespace: System.Web.UI.WebControls.WebParts
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0