UnauthorizedWebPart Class

.NET Framework (current version)

Used to create a placeholder object whenever the WebPartManager control's IsAuthorized method returns false for a WebPart control. This class cannot be inherited.

Namespace: System.Web.UI.WebControls.WebParts
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

System::Object
System.Web.UI::Control
System.Web.UI.WebControls::WebControl
System.Web.UI.WebControls::Panel
System.Web.UI.WebControls.WebParts::Part
System.Web.UI.WebControls.WebParts::WebPart
System.Web.UI.WebControls.WebParts::ProxyWebPart
System.Web.UI.WebControls.WebParts::UnauthorizedWebPart

Syntax

C++

public ref class UnauthorizedWebPart sealed : ProxyWebPart

Constructors

	Name	Description
	UnauthorizedWebPart(String^, String^, String^, String^)	Initializes a new instance of an UnauthorizedWebPart control, called when a dynamic WebPart control (or server or user control) fails authorization.
	UnauthorizedWebPart(WebPart^)	Initializes a new instance of an UnauthorizedWebPart control, called when a static WebPart control (or server or user control) fails authorization.

Properties

	Name	Description
	AccessKey	Gets or sets the access key that allows you to quickly navigate to the Web server control.(Inherited from WebControl.)
	AllowClose	Gets or sets a value indicating whether an end user can close a WebPart control on a Web page.(Inherited from WebPart.)
	AllowConnect	Gets or sets a value that indicates whether the WebPart control allows other controls to form connections with it.(Inherited from WebPart.)
	AllowEdit	Gets or sets a value indicating whether an end user can modify a WebPart control through the user interface (UI) provided by one or more EditorPart controls.(Inherited from WebPart.)
	AllowHide	Gets or sets a value indicating whether end users are allowed to hide a WebPart control.(Inherited from WebPart.)
	AllowMinimize	Gets or sets a value indicating whether end users can minimize a WebPart control.(Inherited from WebPart.)
	AllowZoneChange	Gets or sets a value indicating whether a user can move a WebPart control between WebPartZoneBase zones.(Inherited from WebPart.)
	AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.)
	Attributes	Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.(Inherited from WebControl.)
	AuthorizationFilter	Gets or sets an arbitrary string to determine whether a WebPart control is authorized to be added to a page. (Inherited from WebPart.)
	BackColor	Gets or sets the background color of the Web server control.(Inherited from WebControl.)
	BackImageUrl	Gets or sets the URL of the background image for the panel control.(Inherited from Panel.)
	BindingContainer	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the control that contains this control's data binding.(Inherited from Control.)
	BorderColor	Gets or sets the border color of the Web control.(Inherited from WebControl.)
	BorderStyle	Gets or sets the border style of the Web server control.(Inherited from WebControl.)
	BorderWidth	Gets or sets the border width of the Web server control.(Inherited from WebControl.)
	CatalogIconImageUrl	Gets or sets the URL to an image that represents a Web Parts control in a catalog of controls. (Inherited from WebPart.)
	ChromeState	Gets or sets whether a part control is in a minimized or normal state.(Inherited from WebPart.)
	ChromeType	Gets or sets the type of border that frames a Web Parts control.(Inherited from WebPart.)
	ClientID	Gets the control ID for HTML markup that is generated by ASP.NET.(Inherited from Control.)
	ClientIDMode	Gets or sets the algorithm that is used to generate the value of the ClientID property.(Inherited from Control.)
	ConnectErrorMessage	Gets an error message to display to users if errors occur during the connection process.(Inherited from WebPart.)
	Context	Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.)
	Controls	This API supports the product infrastructure and is not intended to be used directly from your code. Gets a ControlCollection object that contains the child controls for a specified server control in the user interface hierarchy.(Inherited from Part.)
	ControlStyle	Gets the style of the Web server control. This property is used primarily by control developers.(Inherited from WebControl.)
	ControlStyleCreated	Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.(Inherited from WebControl.)
	CssClass	Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.(Inherited from WebControl.)
	DataItemContainer	Gets a reference to the naming container if the naming container implements IDataItemContainer.(Inherited from Control.)
	DataKeysContainer	Gets a reference to the naming container if the naming container implements IDataKeysControl.(Inherited from Control.)
	DefaultButton	Gets or sets the identifier for the default button that is contained in the Panel control.(Inherited from Panel.)
	Description	Gets or sets a brief phrase that summarizes what the part control does, for use in ToolTips and catalogs of part controls.(Inherited from WebPart.)
	DesignMode	Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.)
	Direction	Gets or sets the horizontal direction that content flows within the control.(Inherited from WebPart.)
	DisplayTitle	Gets a string that contains the full title text actually displayed in the title bar of a WebPart control instance.(Inherited from WebPart.)
	Enabled	Gets or sets a value indicating whether the Web server control is enabled.(Inherited from WebControl.)
	EnableTheming	Gets or sets a value indicating whether themes apply to this control.(Inherited from WebControl.)
	EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.(Inherited from Control.)
	ExportMode	Gets or sets whether all, some, or none of a WebPart control's properties can be exported. (Inherited from WebPart.)
	Font	Gets the font properties associated with the Web server control.(Inherited from WebControl.)
	ForeColor	Gets or sets the foreground color (typically the color of the text) of the Web server control.(Inherited from WebControl.)
	GenericWebPartID	Gets the value of the ID property from the generic Web Parts control replaced by a proxy Web Parts control.(Inherited from ProxyWebPart.)
	GroupingText	Gets or sets the caption for the group of controls that is contained in the panel control.(Inherited from Panel.)
	HasAttributes	Gets a value indicating whether the control has attributes set.(Inherited from WebControl.)
	HasSharedData	Gets a value that indicates whether a WebPart control has any shared personalization data associated with it.(Inherited from WebPart.)
	HasUserData	Gets a value that indicates whether a WebPart control has any user personalization data associated with it.(Inherited from WebPart.)
	Height	Gets or sets the height of a zone.(Inherited from WebPart.)
	HelpMode	Gets or sets the type of user interface (UI) used to display Help content for a WebPart control.(Inherited from WebPart.)
	HelpUrl	Gets or sets the URL to a Help file for a WebPart control.(Inherited from WebPart.)
	Hidden	Gets or sets a value indicating whether a WebPart control is displayed on a Web page.(Inherited from WebPart.)
	HorizontalAlign	Gets or sets the horizontal alignment of the contents within the panel.(Inherited from Panel.)
	ID	Gets or sets the programmatic identifier assigned to the Web Parts control.(Inherited from ProxyWebPart.)
	ImportErrorMessage	Gets or sets an error message that is used if errors occur when a WebPart control is imported.(Inherited from WebPart.)
	IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state.(Inherited from Control.)
	IsClosed	Gets a value that indicates whether a WebPart control is currently closed on a Web Parts page.(Inherited from WebPart.)
	IsEnabled	Gets a value indicating whether the control is enabled.(Inherited from WebControl.)
	IsShared	Gets a value that indicates whether a WebPart control is shared, meaning that it is visible to all users of a Web Parts page.(Inherited from WebPart.)
	IsStandalone	Gets a value that indicates whether a WebPart control is standalone, meaning that it is not contained within a WebPartZoneBase zone.(Inherited from WebPart.)
	IsStatic	Gets a value that indicates whether a WebPart control is a static control, which means the control is declared in the markup of a Web Parts page and not added to the page programmatically.(Inherited from WebPart.)
	IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control.(Inherited from Control.)
	NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control::ID property value.(Inherited from Control.)
	OriginalID	Gets the ID of the Web Parts control replaced by the proxy Web Parts control.(Inherited from ProxyWebPart.)
	OriginalPath	Gets the path to the user control being replaced.(Inherited from ProxyWebPart.)
	OriginalTypeName	Gets the Type of the Web Parts control replaced by the proxy Web Parts control.(Inherited from ProxyWebPart.)
	Page	Gets a reference to the Page instance that contains the server control.(Inherited from Control.)
	Parent	Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.)
	RenderingCompatibility	Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.(Inherited from Control.)
	ScrollBars	Gets or sets the visibility and position of scroll bars in a Panel control.(Inherited from Panel.)
	Site	Gets information about the container that hosts the current control when rendered on a design surface.(Inherited from Control.)
	SkinID	Gets or sets the skin to apply to the control.(Inherited from WebControl.)
	Style	Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.(Inherited from WebControl.)
	Subtitle	Gets a string that is concatenated with the Title property value to form a complete title for a WebPart control. (Inherited from WebPart.)
	SupportsDisabledAttribute	Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.(Inherited from Panel.)
	TabIndex	Gets or sets the tab index of the Web server control.(Inherited from WebControl.)
	TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control.)
	TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control.(Inherited from Control.)
	Title	Gets or sets the title of a part control.(Inherited from WebPart.)
	TitleIconImageUrl	Gets or sets the URL to an image used to represent a Web Parts control in the control's title bar.(Inherited from WebPart.)
	TitleUrl	Gets or sets a URL to supplemental information about a WebPart control. (Inherited from WebPart.)
	ToolTip	Gets or sets the text displayed when the mouse pointer hovers over the Web server control.(Inherited from WebControl.)
	UniqueID	Gets the unique, hierarchically qualified identifier for the server control.(Inherited from Control.)
	ValidateRequestMode	Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.(Inherited from Control.)
	Verbs	Gets a collection of custom verbs associated with a WebPart control.(Inherited from WebPart.)
	ViewStateMode	Gets or sets the view-state mode of this control.(Inherited from Control.)
	Visible	Gets or sets a value that indicates whether a server control is rendered as UI on the page.(Inherited from Control.)
	WebBrowsableObject	Gets a reference to the WebPart control to enable it to be edited by custom EditorPart controls.(Inherited from WebPart.)
	Width	Gets or sets the width of the Web server control.(Inherited from WebPart.)
	Wrap	Gets or sets a value indicating whether the content wraps within the panel.(Inherited from Panel.)
	Zone	Gets the WebPartZoneBase zone that currently contains a WebPart control.(Inherited from WebPart.)
	ZoneIndex	Gets the index position of a WebPart control within its zone.(Inherited from WebPart.)

Methods

	Name	Description
	AddedControl(Control^, Int32)	Called after a child control is added to the Controls collection of the Control object.(Inherited from Control.)
	ApplyStyle(Style^)	Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.(Inherited from WebControl.)
	ApplyStyleSheetSkin(Page^)	Applies the style properties defined in the page style sheet to the control.(Inherited from Control.)
	CopyBaseAttributes(WebControl^)	Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.(Inherited from WebControl.)
	CreateChildControls()	Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.(Inherited from Control.)
	CreateEditorParts()	Returns a collection of custom EditorPart controls that can be used to edit a WebPart control when it is in edit mode.(Inherited from WebPart.)
	DataBind()	Binds a data source to the invoked server control and all its child controls.(Inherited from Part.)
	Dispose()	Enables a server control to perform final clean up before it is released from memory.(Inherited from Control.)
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	FindControl(String^)	Searches the current naming container for a server control with the specified id parameter.(Inherited from Control.)
	Focus()	Sets input focus to a control.(Inherited from Control.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetRouteUrl(Object^)	Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)
	GetRouteUrl(RouteValueDictionary^)	Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)
	GetRouteUrl(String^, Object^)	Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)
	GetRouteUrl(String^, RouteValueDictionary^)	Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetUniqueIDRelativeTo(Control^)	Returns the prefixed portion of the UniqueID property of the specified control.(Inherited from Control.)
	HasControls()	Determines if the server control contains any child controls.(Inherited from Control.)
	LoadControlState(Object^)	Overrides LoadControlState to prevent loading previously saved state for a ProxyWebPart object.(Inherited from ProxyWebPart.)
	MapPathSecure(String^)	Retrieves the physical path that a virtual path, either absolute or relative, maps to.(Inherited from Control.)
	MergeStyle(Style^)	Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.(Inherited from WebControl.)
	OnClosing(EventArgs^)	Enables derived classes to provide custom handling when a WebPart control is closed on a Web Parts page.(Inherited from WebPart.)
	OnConnectModeChanged(EventArgs^)	Enables derived classes to provide custom handling when a WebPart control is beginning or ending the process of connecting to other controls.(Inherited from WebPart.)
	OnDeleting(EventArgs^)	Enables derived classes to provide custom handling when a WebPart control is permanently removed from a Web Parts page.(Inherited from WebPart.)
	OnEditModeChanged(EventArgs^)	Enables derived classes to provide custom handling when a WebPart control is entering or leaving edit mode.(Inherited from WebPart.)
	OnInit(EventArgs^)	Raises the Init event.(Inherited from Control.)
	OnLoad(EventArgs^)	Raises the Load event.(Inherited from Control.)
	OnPreRender(EventArgs^)	Raises the PreRender event.(Inherited from Control.)
	OnUnload(EventArgs^)	Raises the Unload event.(Inherited from Control.)
	OpenFile(String^)	Gets a Stream used to read a file.(Inherited from Control.)
	RemovedControl(Control^)	Called after a child control is removed from the Controls collection of the Control object.(Inherited from Control.)
	Render(HtmlTextWriter^)	Renders the control to the specified HTML writer.(Inherited from WebControl.)
	RenderBeginTag(HtmlTextWriter^)	Renders the HTML opening tag of the Panel control to the specified writer.(Inherited from Panel.)
	RenderChildren(HtmlTextWriter^)	Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.(Inherited from Control.)
	RenderContents(HtmlTextWriter^)	Renders the contents of the control to the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)
	RenderControl(HtmlTextWriter^)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.(Inherited from Control.)
	RenderEndTag(HtmlTextWriter^)	Renders the HTML closing tag of the Panel control into the specified writer.(Inherited from Panel.)
	ResolveClientUrl(String^)	Gets a URL that can be used by the browser.(Inherited from Control.)
	ResolveUrl(String^)	Converts a URL into one that is usable on the requesting client.(Inherited from Control.)
	SaveControlState()	Saves any server control state changes that have occurred since the time the page was posted back to the server.(Inherited from ProxyWebPart.)
	SetRenderMethodDelegate(RenderMethod^)	This API supports the product infrastructure and is not intended to be used directly from your code. Assigns an event handler delegate to render the server control and its content into its parent control.(Inherited from Control.)
	SetTraceData(Object^, Object^)	Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.(Inherited from Control.)
	SetTraceData(Object^, Object^, Object^)	Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.(Inherited from Control.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Events

	Name	Description
	DataBinding	Occurs when the server control binds to a data source.(Inherited from Control.)
	Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.(Inherited from Control.)
	Init	Occurs when the server control is initialized, which is the first step in its lifecycle.(Inherited from Control.)
	Load	Occurs when the server control is loaded into the Page object.(Inherited from Control.)
	PreRender	Occurs after the Control object is loaded but prior to rendering.(Inherited from Control.)
	Unload	Occurs when the server control is unloaded from memory.(Inherited from Control.)

Explicit Interface Implementations

	Name	Description
	IAttributeAccessor::GetAttribute(String^)	This API supports the product infrastructure and is not intended to be used directly from your code. Gets an attribute of the Web control with the specified name.(Inherited from WebControl.)
	IAttributeAccessor::SetAttribute(String^, String^)	Sets an attribute of the Web control to the specified name and value.(Inherited from WebControl.)
	IControlDesignerAccessor::GetDesignModeState()	For a description of this member, see IControlDesignerAccessor::GetDesignModeState.(Inherited from Control.)
	IControlDesignerAccessor::SetDesignModeState(IDictionary^)	For a description of this member, see IControlDesignerAccessor::SetDesignModeState. (Inherited from Control.)
	IControlDesignerAccessor::SetOwnerControl(Control^)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IControlDesignerAccessor::SetOwnerControl. (Inherited from Control.)
	IParserAccessor::AddParsedSubObject(Object^)	For a description of this member, see IParserAccessor::AddParsedSubObject. (Inherited from Control.)
	ICompositeControlDesignerAccessor::RecreateChildControls()	Allows the developer of a designer for a composite part control to recreate the control's child controls on the design surface.(Inherited from Part.)
	IControlBuilderAccessor::ControlBuilder	For a description of this member, see IControlBuilderAccessor::ControlBuilder. (Inherited from Control.)
	IControlDesignerAccessor::UserData	For a description of this member, see IControlDesignerAccessor::UserData. (Inherited from Control.)
	IDataBindingsAccessor::DataBindings	For a description of this member, see IDataBindingsAccessor::DataBindings. (Inherited from Control.)
	IDataBindingsAccessor::HasDataBindings	For a description of this member, see IDataBindingsAccessor::HasDataBindings. (Inherited from Control.)
	IExpressionsAccessor::Expressions	For a description of this member, see IExpressionsAccessor::Expressions. (Inherited from Control.)
	IExpressionsAccessor::HasExpressions	For a description of this member, see IExpressionsAccessor::HasExpressions. (Inherited from Control.)

Extension Methods

	Name	Description
	EnableDynamicData(Type^)	Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)
	EnableDynamicData(Type^, IDictionary<String^, Object^>^)	Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)
	EnableDynamicData(Type^, Object^)	Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)
	FindDataSourceControl()	Returns the data source that is associated with the data control for the specified control.(Defined by DynamicDataExtensions.)
	FindFieldTemplate(String^)	Returns the field template for the specified column in the specified control's naming container.(Defined by DynamicDataExtensions.)
	FindMetaTable()	Returns the metatable object for the containing data control.(Defined by DynamicDataExtensions.)
	GetDefaultValues()	Overloaded. Gets the collection of the default values for the specified data control.(Defined by DynamicDataExtensions.)
	GetMetaTable()	Overloaded. Gets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)
	SetMetaTable(MetaTable^)	Overloaded. Sets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)
	SetMetaTable(MetaTable^, IDictionary<String^, Object^>^)	Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)
	SetMetaTable(MetaTable^, Object^)	Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)
	TryGetMetaTable(MetaTable^%)	Overloaded. Determines whether table metadata is available.(Defined by DynamicDataExtensions.)

The Web Parts control set provides an authorization mechanism for determining whether individual WebPart controls can be added to a page. Developers can optionally assign an arbitrary string to the AuthorizationFilter property on a WebPart control. When the WebPartManager control is adding controls to a page, it checks this filter value against criteria set by the developer, by using the IsAuthorized method, and returns false if a control is not authorized.

Note
This mechanism also works with server controls and user controls that are placed in WebPartZoneBase zones, because these controls are wrapped with a GenericWebPart object at run time, and this object inherits the AuthorizationFilter property.

When a WebPart control is not authorized, the WebPartManager control inserts an UnauthorizedWebPart control into the control tree of the page in place of the unauthorized control. An UnauthorizedWebPart control in the control tree reserves the position of the unauthorized control in the page, and prevents any personalization data that a user might have previously applied to the WebPart control from being lost.

The UnauthorizedWebPart control is never displayed on a page in which it is inserted, nor does it appear in the source code for the rendered page. Developers can verify its presence in the page control tree by checking the WebParts property of the WebPartManager control.

Examples

The following code example demonstrates the use of the UnauthorizedWebPart control.

The first part of the code example is a custom WebPartManager control that overrides the IsAuthorized(WebPart^) method to create custom authorization criteria. Any WebPart control that has its AuthorizationFilter property set to a specific value, or any control that has no value assigned to the property, will be authorized, and controls not meeting these criteria will not be authorized.

C++

No code example is currently available or this language may not be supported.

The second part of the code example is the Web page that hosts the custom WebPartManager control. There are three static server controls declared within the <asp:webpartzone> element. Although these controls are not actually WebPart controls, they will be wrapped with a GenericWebPart object at run time, so you can treat them as WebPart controls and thus assign values to their AuthorizationFilter properties. Notice that the BulletedList control has its filter set to the value that should enable it to be authorized, according to the criteria in the custom WebPartManager control. The Label control has a filter value that should cause it not to be authorized. The Calendar control does not assign a value to the property, so by default it should be authorized.

C++

No code example is currently available or this language may not be supported.

The third part of the code example is a setting you must add in the Web.config file to enable exporting Web Parts description files. Ensure that you have a Web.config file in the same directory as the Web page for this code example. Within the <system.web> section, make sure there is a <webParts> element with an enableExport attribute set to true, as in the following markup.

...

</webParts>

Load the page in a browser, and notice that the BulletedList and Calendar controls are rendered as expected, but the Label control is not rendered because it was not authorized. Clicking the List WebPart Controls button causes the WebPartManager control to list the IDs of all controls in its WebParts collection. Note that the ID for the Label control is listed, proving that an UnauthorizedWebPart control was added to the page control tree to hold its place, even though the label is not rendered in the page.

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.