UnauthorizedWebPart Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Used to create a placeholder object whenever the WebPartManager control's IsAuthorized method returns false for a WebPart control. This class cannot be inherited.
public ref class UnauthorizedWebPart sealed : System::Web::UI::WebControls::WebParts::ProxyWebPartpublic sealed class UnauthorizedWebPart : System.Web.UI.WebControls.WebParts.ProxyWebParttype UnauthorizedWebPart = class
inherit ProxyWebPartPublic NotInheritable Class UnauthorizedWebPart
Inherits ProxyWebPart- Inheritance
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.
using System;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;
namespace Samples.AspNet.CS.Controls
{
public class MyManagerAuthorize : WebPartManager
{
public override bool IsAuthorized(Type type, string path, string authorizationFilter, bool isShared)
{
if (!String.IsNullOrEmpty(authorizationFilter))
{
if (authorizationFilter == "admin")
return true;
else
return false;
}
else
{
return true;
}
}
}
}
Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Namespace Samples.AspNet.VB.Controls
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class MyManagerAuthorize
Inherits WebPartManager
Public Overrides Function IsAuthorized(ByVal type As Type, _
ByVal path As String, ByVal authorizationFilter As String, _
ByVal isShared As Boolean) As Boolean
If Not String.IsNullOrEmpty(authorizationFilter) Then
If authorizationFilter = "admin" Then
Return True
Else
Return False
End If
Else
Return True
End If
End Function
End Class
End Namespace
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.
<%@ Page Language="C#" %>
<%@ Register TagPrefix="aspSample"
Namespace="Samples.AspNet.CS.Controls" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
protected void Page_Load(object sender, EventArgs e)
{
foreach (WebPart part in mgr1.WebParts)
{
if (mgr1.IsAuthorized(part))
part.ExportMode = WebPartExportMode.All;
}
}
protected void Button1_Click(object sender, EventArgs e)
{
Label2.Text = String.Empty;
foreach (WebPart part in mgr1.WebParts)
Label2.Text += part.ID + "<br />";
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Untitled Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<aspSample:MyManagerAuthorize ID="mgr1" runat="server" />
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:BulletedList
ID="BulletedList1"
Runat="server"
DisplayMode="HyperLink"
Title="Favorite Links"
AuthorizationFilter="admin">
<asp:ListItem Value="http://msdn.microsoft.com">
MSDN
</asp:ListItem>
<asp:ListItem Value="http://www.asp.net">
ASP.NET
</asp:ListItem>
<asp:ListItem Value="http://www.msn.com">
MSN
</asp:ListItem>
</asp:BulletedList>
<asp:Label ID="Label1" runat="server"
Text="Hello World"
AuthorizationFilter="user" />
<asp:Calendar ID="Calendar1" runat="server"></asp:Calendar>
</ZoneTemplate>
</asp:WebPartZone>
<hr />
<asp:Button ID="Button1" runat="server"
Text="List WebPart Controls" OnClick="Button1_Click" />
<br />
<asp:Label ID="Label2" runat="server"
Text="" />
</div>
</form>
</body>
</html>
<%@ Page Language="vb" %>
<%@ Register Namespace="Samples.AspNet.VB.Controls"
TagPrefix="aspSample"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Protected Sub Page_Load(ByVal sender As Object, _
ByVal e As System.EventArgs)
Dim part As WebPart
For Each part In mgr1.WebParts
If mgr1.IsAuthorized(part) Then
part.ExportMode = WebPartExportMode.All
End If
Next
End Sub
Protected Sub Button1_Click(ByVal sender As Object, _
ByVal e As System.EventArgs)
Label2.Text = String.Empty
Dim part As WebPart
For Each part In mgr1.WebParts
Label2.Text += part.ID & "<br />"
Next
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>Untitled Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<aspSample:MyManagerAuthorize ID="mgr1" runat="server" />
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:BulletedList
ID="BulletedList1"
Runat="server"
DisplayMode="HyperLink"
Title="Favorite Links"
AuthorizationFilter="admin">
<asp:ListItem Value="http://msdn.microsoft.com">
MSDN
</asp:ListItem>
<asp:ListItem Value="http://www.asp.net">
ASP.NET
</asp:ListItem>
<asp:ListItem Value="http://www.msn.com">
MSN
</asp:ListItem>
</asp:BulletedList>
<asp:Label ID="Label1" runat="server"
Text="Hello World"
AuthorizationFilter="user" />
<asp:Calendar ID="Calendar1" runat="server"></asp:Calendar>
</ZoneTemplate>
</asp:WebPartZone>
<hr />
<asp:Button ID="Button1" runat="server"
Text="List WebPart Controls" OnClick="Button1_Click" />
<br />
<asp:Label ID="Label2" runat="server"
Text="" />
</div>
</form>
</body>
</html>
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 enableExport="true">
...
</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.
Remarks
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.
Constructors
| 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
| AccessKey |
Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl) |
| Adapter |
Gets the browser-specific adapter for the control. (Inherited from Control) |
| 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 |
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) |
| ChildControlsCreated |
Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control) |
| 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) |
| ClientIDSeparator |
Gets a character value representing the separator character used in 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 |
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) |
| Events |
Gets a list of event handler delegates for the control. This property is read-only. (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) |
| HasChildViewState |
Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control) |
| 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) |
| IdSeparator |
Gets the character used to separate control identifiers. (Inherited from Control) |
| 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) |
| IsTrackingViewState |
Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control) |
| IsViewStateEnabled |
Gets a value indicating whether view state is enabled for this control. (Inherited from Control) |
| LoadViewStateByID |
Gets a value indicating whether the control participates in loading its view state by ID instead of index. (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 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 |
| TabIndex |
Gets or sets the tab index of the Web server control. (Inherited from WebControl) |
| TagKey |
Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl) |
| TagName |
Gets the name of the control tag. This property is used primarily by control developers. (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) |
| ViewState |
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control) |
| ViewStateIgnoresCase |
Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control) |
| 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) |
| WebPartManager |
Gets a reference to the WebPartManager control associated with a WebPart control instance. (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
| AddAttributesToRender(HtmlTextWriter) |
Adds information about the background image, alignment, wrap, and direction to the list of attributes to render. (Inherited from Panel) |
| AddedControl(Control, Int32) |
Called after a child control is added to the Controls collection of the Control object. (Inherited from Control) |
| AddParsedSubObject(Object) |
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection 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) |
| BeginRenderTracing(TextWriter, Object) |
Begins design-time tracing of rendering data. (Inherited from Control) |
| BuildProfileTree(String, Boolean) |
Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control) |
| ClearCachedClientID() |
Sets the cached ClientID value to |
| ClearChildControlState() |
Deletes the control-state information for the server control's child controls. (Inherited from Control) |
| ClearChildState() |
Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control) |
| ClearChildViewState() |
Deletes the view-state information for all the server control's child controls. (Inherited from Control) |
| ClearEffectiveClientIDMode() |
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (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) |
| CreateControlCollection() |
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control) |
| CreateControlStyle() |
Creates a style object that is used internally by the Panel control to implement all style related properties. (Inherited from Panel) |
| 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) |
| DataBind(Boolean) |
Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control) |
| DataBindChildren() |
Binds a data source to the server control's child controls. (Inherited from Control) |
| Dispose() |
Enables a server control to perform final clean up before it is released from memory. (Inherited from Control) |
| EndRenderTracing(TextWriter, Object) |
Ends design-time tracing of rendering data. (Inherited from Control) |
| EnsureChildControls() |
Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control) |
| EnsureID() |
Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control) |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| FindControl(String, Int32) |
Searches the current naming container for a server control with the specified |
| FindControl(String) |
Searches the current naming container for a server control with the specified |
| Focus() |
Sets input focus to a control. (Inherited from Control) |
| GetDesignModeState() |
Gets design-time data for 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) |
| HasEvents() |
Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control) |
| IsLiteralContent() |
Determines if the server control holds only literal content. (Inherited from Control) |
| LoadControlState(Object) |
Overrides LoadControlState(Object) to prevent loading previously saved state for a ProxyWebPart object. (Inherited from ProxyWebPart) |
| LoadViewState(Object) |
Overrides LoadViewState(Object) to prevent loading previously saved view 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) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| 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) |
| OnBubbleEvent(Object, EventArgs) |
Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control) |
| 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) |
| OnDataBinding(EventArgs) |
Raises the DataBinding event. (Inherited from Control) |
| 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) |
| RaiseBubbleEvent(Object, EventArgs) |
Assigns any sources of the event and its information to the control's parent. (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, ControlAdapter) |
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control) |
| 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) |
| ResolveAdapter() |
Gets the control adapter responsible for rendering the specified control. (Inherited from Control) |
| 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) |
| SaveViewState() |
Saves any state that was modified after the TrackViewState() method was invoked. (Inherited from ProxyWebPart) |
| SetDesignModeState(IDictionary) |
Sets design-time data for a control. (Inherited from Control) |
| SetPersonalizationDirty() |
Sets a flag indicating that personalization data has changed for the current WebPart control instance. (Inherited from WebPart) |
| SetRenderMethodDelegate(RenderMethod) |
Assigns an event handler delegate to render the server control and its content into its parent control. (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) |
| 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) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| TrackViewState() |
Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebPart) |
Events
| 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
| IAttributeAccessor.GetAttribute(String) |
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) |
| 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 ControlBuilder. (Inherited from Control) |
| IControlDesignerAccessor.GetDesignModeState() |
For a description of this member, see GetDesignModeState(). (Inherited from Control) |
| IControlDesignerAccessor.SetDesignModeState(IDictionary) |
For a description of this member, see SetDesignModeState(IDictionary). (Inherited from Control) |
| IControlDesignerAccessor.SetOwnerControl(Control) |
For a description of this member, see SetOwnerControl(Control). (Inherited from Control) |
| IControlDesignerAccessor.UserData |
For a description of this member, see UserData. (Inherited from Control) |
| IDataBindingsAccessor.DataBindings |
For a description of this member, see DataBindings. (Inherited from Control) |
| IDataBindingsAccessor.HasDataBindings |
For a description of this member, see HasDataBindings. (Inherited from Control) |
| IExpressionsAccessor.Expressions |
For a description of this member, see Expressions. (Inherited from Control) |
| IExpressionsAccessor.HasExpressions |
For a description of this member, see HasExpressions. (Inherited from Control) |
| IParserAccessor.AddParsedSubObject(Object) |
For a description of this member, see AddParsedSubObject(Object). (Inherited from Control) |
Extension Methods
| FindDataSourceControl(Control) |
Returns the data source that is associated with the data control for the specified control. |
| FindFieldTemplate(Control, String) |
Returns the field template for the specified column in the specified control's naming container. |
| FindMetaTable(Control) |
Returns the metatable object for the containing data control. |
| GetDefaultValues(INamingContainer) |
Gets the collection of the default values for the specified data control. |
| GetMetaTable(INamingContainer) |
Gets the table metadata for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) |
Sets the table metadata and default value mapping for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable, Object) |
Sets the table metadata and default value mapping for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable) |
Sets the table metadata for the specified data control. |
| TryGetMetaTable(INamingContainer, MetaTable) |
Determines whether table metadata is available. |
| EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) |
Enables Dynamic Data behavior for the specified data control. |
| EnableDynamicData(INamingContainer, Type, Object) |
Enables Dynamic Data behavior for the specified data control. |
| EnableDynamicData(INamingContainer, Type) |
Enables Dynamic Data behavior for the specified data control. |
