EditorZoneBase 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.
Serves as the base class for all zone controls that act as containers for EditorPart controls.
public ref class EditorZoneBase abstract : System::Web::UI::WebControls::WebParts::ToolZonepublic abstract class EditorZoneBase : System.Web.UI.WebControls.WebParts.ToolZonetype EditorZoneBase = class
inherit ToolZonePublic MustInherit Class EditorZoneBase
Inherits ToolZone- Inheritance
- Derived
Examples
The following code example demonstrates several declarative and programmatic uses of the EditorZoneBase class. Because the class is abstract, the code examples use the derived EditorZone class that ships with the Web Parts control set, demonstrating the properties and methods that it inherits from the EditorZoneBase class.
The code example has four parts:
A user control that enables you to change display modes on the Web page.
A Web page that contains an EditorZone control.
A custom EditorZone class that demonstrates some of the EditorZoneBase class members.
A description of how the example works in a browser.
The source code for the user control comes from another topic. For this code example to work, you need to obtain the .ascx file for the user control from the Walkthrough: Changing Display Modes on a Web Parts Page topic, and place the file in the same folder as the .aspx page in this code example.
The second part of the code example is a Web page that contains a declarative reference to an EditorZone control. Near the top of the page is a Register directive for the user control. The user control tag is declared in the page with a <uc1:DisplayModeMenu> element. Notice that below the <asp:WebPartZone> element is an <asp:EditorZone> element that contains EditorPart controls, and has a variety of tags and properties set to determine its appearance and behavior. Most of the code in the page demonstrates the various programmatic uses of the EditorZoneBase properties and methods.
<%@ Page Language="C#" %>
<%@ register tagprefix="uc1"
tagname="DisplayModeMenuCS"
src="displaymodecs.ascx" %>
<%@ 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">
// <snippet3>
// <snippet4>
void Button1_Click(object sender, EventArgs e)
{
if (EditorZone1.ApplyVerb.Enabled)
EditorZone1.ApplyVerb.Enabled = false;
else
EditorZone1.ApplyVerb.Enabled = true;
}
// </snippet4>
// <snippet5>
void Button2_Click(object sender, EventArgs e)
{
if (EditorZone1.CancelVerb.Enabled)
EditorZone1.CancelVerb.Enabled = false;
else
EditorZone1.CancelVerb.Enabled = true;
}
// </snippet5>
// <snippet6>
void Button3_Click(object sender, EventArgs e)
{
Label1.Text = "<br />";
foreach (EditorPart part in EditorZone1.EditorParts)
{
Label1.Text += part.ID + "<br />";
}
}
// </snippet6>
// <snippet7>
void Button4_Click(object sender, EventArgs e)
{
if (EditorZone1.OKVerb.Enabled)
EditorZone1.OKVerb.Enabled = false;
else
EditorZone1.OKVerb.Enabled = true;
}
// </snippet7>
// </snippet3>
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>EditorZoneBase Examples</title>
</head>
<body>
<form id="form1" runat="server">
<asp:WebPartManager ID="WebPartManager1" runat="server" />
<uc1:DisplayModeMenuCS runat="server" id="displaymodemenu1" />
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:BulletedList
ID="BulletedList1"
Runat="server"
DisplayMode="HyperLink"
Title="Favorite Links" >
<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:Calendar ID="Calendar1" Runat="server"
Title="My Calendar" />
</ZoneTemplate>
</asp:WebPartZone>
<aspSample:MyEditorZone ID="EditorZone1" runat="server">
<ApplyVerb Text="Apply Changes" />
<CancelVerb Text="Cancel Changes" />
<OKVerb Text="Finished" />
<ZoneTemplate>
<asp:AppearanceEditorPart ID="AppearanceEditorPart1"
runat="server" />
<asp:LayoutEditorPart ID="LayoutEditorPart1"
runat="server" />
</ZoneTemplate>
</aspSample:MyEditorZone>
<hr />
<asp:Button ID="Button1" runat="server" Width="200"
Text="Toggle ApplyVerb Enabled" OnClick="Button1_Click" />
<br />
<asp:Button ID="Button2" runat="server" Width="200"
Text="Toggle CancelVerb Enabled" OnClick="Button2_Click" />
<br />
<asp:Button ID="Button3" runat="server" Width="200"
Text="Display EditorParts Collection" OnClick="Button3_Click" />
<asp:Label ID="Label1" runat="server" />
<br />
<asp:Button ID="Button4" runat="server" Width="200"
Text="Toggle OKVerb Enabled" OnClick="Button4_Click" />
</form>
</body>
</html>
<%@ Page Language="vb" %>
<%@ register tagprefix="uc1"
tagname="DisplayModeMenuVB"
src="displaymodevb.ascx" %>
<%@ register tagprefix="aspSample"
Namespace="Samples.AspNet.VB.Controls" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
' <snippet3>
' <snippet4>
Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)
If EditorZone1.ApplyVerb.Enabled Then
EditorZone1.ApplyVerb.Enabled = False
Else
EditorZone1.ApplyVerb.Enabled = True
End If
End Sub
' </snippet4>
' <snippet5>
Sub Button2_Click(ByVal sender As Object, ByVal e As EventArgs)
If EditorZone1.CancelVerb.Enabled Then
EditorZone1.CancelVerb.Enabled = False
Else
EditorZone1.CancelVerb.Enabled = True
End If
End Sub
' </snippet5>
' <snippet6>
Sub Button3_Click(ByVal sender As Object, ByVal e As EventArgs)
Label1.Text = "<br />"
Dim part As EditorPart
For Each part In EditorZone1.EditorParts
Label1.Text += part.ID + "<br />"
Next part
End Sub
' </snippet6>
' <snippet7>
Sub Button4_Click(ByVal sender As Object, ByVal e As EventArgs)
If EditorZone1.OKVerb.Enabled Then
EditorZone1.OKVerb.Enabled = False
Else
EditorZone1.OKVerb.Enabled = True
End If
End Sub
' </snippet7>
' </snippet3>
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>EditorZoneBase Examples</title>
</head>
<body>
<form id="form1" runat="server">
<asp:WebPartManager ID="WebPartManager1" runat="server" />
<uc1:DisplayModeMenuVB runat="server" id="displaymodemenu1" />
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:BulletedList
ID="BulletedList1"
Runat="server"
DisplayMode="HyperLink"
Title="Favorite Links" >
<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:Calendar ID="Calendar1" Runat="server"
Title="My Calendar" />
</ZoneTemplate>
</asp:WebPartZone>
<aspSample:MyEditorZone ID="EditorZone1" runat="server">
<ApplyVerb Text="Apply Changes" />
<CancelVerb Text="Cancel Changes" />
<OKVerb Text="Finished" />
<ZoneTemplate>
<asp:AppearanceEditorPart ID="AppearanceEditorPart1"
runat="server" />
<asp:LayoutEditorPart ID="LayoutEditorPart1"
runat="server" />
</ZoneTemplate>
</aspSample:MyEditorZone>
<hr />
<asp:Button ID="Button1" runat="server" Width="200"
Text="Toggle ApplyVerb Enabled" OnClick="Button1_Click" />
<br />
<asp:Button ID="Button2" runat="server" Width="200"
Text="Toggle CancelVerb Enabled" OnClick="Button2_Click" />
<br />
<asp:Button ID="Button3" runat="server" Width="200"
Text="Display EditorParts Collection" OnClick="Button3_Click" />
<asp:Label ID="Label1" runat="server" />
<br />
<asp:Button ID="Button4" runat="server" Width="200"
Text="Toggle OKVerb Enabled" OnClick="Button4_Click" />
</form>
</body>
</html>
The third part of the code example is a custom EditorZone class that shows how to work with a number of the EditorZoneBase class members. The custom class derives from EditorZone so that it can be used with a zone template in the declarative markup of the Web page. For the code example to run, you must compile this source code. You can compile it explicitly and put the resulting assembly in your Web site's Bin folder or the global assembly cache. Alternatively, you can put the source code in your site's App_Code folder, where it will be dynamically compiled at run time. This code example uses dynamic compilation; thus, you will notice that the Register directive near the top of the Web page does not reference an assembly file. For a walkthrough that demonstrates both methods of compiling, see Walkthrough: Developing and Using a Custom Web Server Control.
using System;
using System.Collections;
using System.ComponentModel;
using System.Drawing;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
namespace Samples.AspNet.CS.Controls
{
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class MyEditorZone : EditorZone
{
public MyEditorZone()
{
}
protected override void OnDisplayModeChanged(object sender,
WebPartDisplayModeEventArgs e)
{
this.BackColor = Color.LightGray;
base.OnDisplayModeChanged(sender, e);
}
protected override void OnSelectedWebPartChanged(object sender,
WebPartEventArgs e)
{
if (e.WebPart != null)
e.WebPart.Zone.SelectedPartChromeStyle.BackColor =
Color.LightGreen;
base.OnSelectedWebPartChanged(sender, e);
}
protected override void RenderBody(HtmlTextWriter writer)
{
writer.WriteLine("<hr />");
base.RenderBody(writer);
}
protected override void RenderVerbs(HtmlTextWriter writer)
{
WebPartVerb[] verbs = new WebPartVerb[] { OKVerb,
CancelVerb, ApplyVerb };
foreach (WebPartVerb verb in verbs)
{
if (verb != null)
verb.Text += " Verb";
}
base.RenderVerbs(writer);
}
}
}
Imports System.Collections
Imports System.ComponentModel
Imports System.Drawing
Imports System.Security.Permissions
Imports System.Web
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 MyEditorZone
Inherits EditorZone
Public Sub New()
End Sub
Protected Overrides Sub OnDisplayModeChanged(ByVal sender _
As Object, ByVal e As WebPartDisplayModeEventArgs)
Me.BackColor = Color.LightGray
MyBase.OnDisplayModeChanged(sender, e)
End Sub
Protected Overrides Sub OnSelectedWebPartChanged(ByVal sender _
As Object, ByVal e As WebPartEventArgs)
If Not (e.WebPart Is Nothing) Then
e.WebPart.Zone.SelectedPartChromeStyle.BackColor = _
Color.LightGreen
End If
MyBase.OnSelectedWebPartChanged(sender, e)
End Sub
Protected Overrides Sub RenderBody(ByVal writer As _
HtmlTextWriter)
writer.WriteLine("<hr />")
MyBase.RenderBody(writer)
End Sub
Protected Overrides Sub RenderVerbs(ByVal writer As _
HtmlTextWriter)
Dim verbs() As WebPartVerb = {OKVerb, CancelVerb, ApplyVerb}
Dim verb As WebPartVerb
For Each verb In verbs
If Not (verb Is Nothing) Then
verb.Text += " Verb"
End If
Next verb
MyBase.RenderVerbs(writer)
End Sub
End Class
End Namespace
When you load the page in a browser, you can select Edit Mode from the drop-down list to switch to edit mode. You can click the verbs menu (the downward arrow) in the title bar of one of the two controls, and click Edit to edit the control. When the editing UI is visible, you can see the effects of the various declarative and programmatic uses of the EditorZoneBase class members.
Remarks
The EditorZoneBase class is a specialized zone class that inherits from the ToolZone class and provides a base set of behaviors for derived zones that contain EditorPart controls. There are several other types of ToolZone classes; for more information, see the overview topic for the ToolZone class. Like other tool zones, EditorZoneBase zones are not visible when a page is in normal browse mode; they are visible only when a page is in edit display mode. Also like the other tool zones, EditorZoneBase zones can only contain the special type of controls they were designed to contain (in this case, EditorPart controls).
The EditorZoneBase zones provide a special UI for the editing controls they contain. Many of these UI elements are common to all zones in the Web Parts control set. For a detailed discussion of the common UI elements in Web Parts zones, see the class overview topic for the WebZone class.
Because the EditorZoneBase class is abstract, you cannot use it directly on a Web page. Instead, you must use a control that inherits from the EditorZoneBase class and implements its behavior. You can either use the derived zone that is provided in the Web Parts control set, the EditorZone control, or you can derive your own custom EditorZoneBase control.
The EditorZoneBase class provides a common user interface (UI) to contain special controls that enable end users to edit the properties, layout, appearance, and other attributes of WebPart controls. Some properties that apply to the UI refer to verbs, such as the ApplyVerb, CancelVerb, and OKVerb properties. Verbs are common actions carried out by users on a page, and are represented in the UI by buttons, links, menu items, or other elements. For example, when users edit properties on a control they can click an apply verb to save the changes.
Several other properties affect text that is displayed at various points in the editing UI. These include the EmptyZoneText, ErrorText, HeaderText, and InstructionText properties.
Two important properties provide references to related controls. The EditorParts property is a collection of the EditorPart controls contained in the zone. The WebPartToEdit property is an object reference to a control contained in a WebPartZone--which might be a WebPart control or any other ASP.NET server control, user control, or custom control currently being edited.
Finally, the EditorPartChrome property references an instance of an EditorPartChrome object that is associated with the zone, and that contains style characteristics of the peripheral UI elements (known as chrome) such as title and border styles for EditorPart controls in the zone.
A number of the methods of the EditorZoneBase class are specialized to handle the editing of other controls. The Close method changes the page from the edit display mode back to a normal browsing view. The CreateEditorPartChrome method is for creating the chrome (peripheral UI elements such as a border, verbs, icons, and a title) that surrounds each EditorPart control in the zone. The CreateEditorParts method is an abstract method; derived classes override it to create instances of all the EditorPart controls contained in the zone. The InvalidateEditorParts method can be called by a derived class if the collection of EditorPart controls in the zone changes for some programmatic reason, which flags the Web Parts control set to recreate and update the collection of EditorPart controls. The OnDisplayModeChanged method is used to set the collection of EditorPart controls to null when the display mode changes from edit mode back to browse mode. Finally, the OnSelectedWebPartChanged method is used for handling the event when a WebPart control is either entering or leaving edit mode. For example, this method is a convenient place to synchronize the property values of a WebPart control with the editable values in the associated EditorPart controls.
Notes to Implementers
If you want to develop a custom zone for hosting EditorPart controls, you must determine whether you want to provide zone template support. A zone template is created by types that implement the ITemplate interface, and is necessary if you want to enable page developers using your custom zone to reference EditorPart controls within your zone in the declarative markup of a Web page. If you need zone template support, you should inherit from the EditorZone class.
In contrast, if your custom zone and its EditorPart controls are going to be self-contained, and they will be created programmatically without any options for page developers to specify controls declaratively in a zone template, then you can inherit directly from the EditorZoneBase class. If you do this, it is critical that you implement the CreateEditorParts() method so that your custom zone will work.
Constructors
| EditorZoneBase() |
Initializes the class for use by an inherited class instance. This constructor can only be called by an inherited class. |
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) |
| ApplyVerb |
Gets a reference to a WebPartVerb object that enables end users to apply editing changes to a control in edit mode. |
| AppRelativeTemplateSourceDirectory |
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control) |
| AssociatedDisplayModes |
Gets the collection of WebPartDisplayMode objects that are associated with a particular ToolZone zone. (Inherited from ToolZone) |
| Attributes |
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl) |
| BackColor |
Gets or sets the background color of the Web server control. (Inherited from WebControl) |
| BackImageUrl |
Gets or sets the URL to a background image for a zone. (Inherited from WebZone) |
| 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) |
| CancelVerb |
Gets a reference to a WebPartVerb object that enables end users to cancel editing changes to a control in edit mode. |
| ChildControlsCreated |
Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control) |
| 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) |
| Context |
Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control) |
| Controls |
Gets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl) |
| 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) |
| DesignMode |
Gets a value indicating whether a control is being used on a design surface. (Inherited from Control) |
| Display |
Gets a value that indicates whether a ToolZone control is currently displayed. |
| EditorPartChrome |
Gets a reference to the instance of the EditorPartChrome class associated with the EditorZoneBase zone. |
| EditorParts |
Gets a collection of all the EditorPart controls contained in an EditorZoneBase zone. |
| EditUIStyle |
Gets the style attributes for the editable controls contained in a ToolZone control. (Inherited from ToolZone) |
| EmptyZoneText |
Gets or sets a message that appears when a zone contains no controls. |
| EmptyZoneTextStyle |
Gets the style attributes for the placeholder text in an empty zone. (Inherited from WebZone) |
| 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) |
| ErrorStyle |
Gets the style attributes for rendering the error message that is displayed if a WebPart control cannot be loaded or created. (Inherited from WebZone) |
| ErrorText |
Gets or sets the text of a zone-level error message to display at the top of the editing user interface (UI). |
| Events |
Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control) |
| Font |
Gets the font properties associated with the Web server control. (Inherited from WebControl) |
| FooterStyle |
Gets the style attributes for the contents of a zone's footer area. (Inherited from WebZone) |
| ForeColor |
Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl) |
| 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) |
| HasFooter |
Gets a value indicating whether a zone has a footer area. (Inherited from WebZone) |
| HasHeader |
Gets a value indicating whether a zone has a header area. (Inherited from WebZone) |
| HeaderCloseVerb |
Gets a reference to the WebPartVerb object in the header of a ToolZone control that is used to close the control. (Inherited from ToolZone) |
| HeaderStyle |
Gets the style attributes for the contents of a zone's header area. (Inherited from WebZone) |
| HeaderText |
Gets or sets the text for the header area of a zone. |
| HeaderVerbStyle |
Gets the style attributes for all header verbs displayed in a ToolZone control. (Inherited from ToolZone) |
| Height |
Gets or sets the height of the Web server control. (Inherited from WebControl) |
| ID |
Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control) |
| IdSeparator |
Gets the character used to separate control identifiers. (Inherited from Control) |
| InstructionText |
Gets or sets the text in a ToolZone control that provides directions for end users. |
| InstructionTextStyle |
Gets the style attributes for the instruction text that appears at the top of a ToolZone control. (Inherited from ToolZone) |
| IsChildControlStateCleared |
Gets a value indicating whether controls contained within this control have control state. (Inherited from Control) |
| IsEnabled |
Gets a value indicating whether the control is enabled. (Inherited from WebControl) |
| 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) |
| LabelStyle |
Gets the style attributes for the contents of the labels that appear alongside the editing controls within a ToolZone control. The derived ToolZone controls, such as CatalogZone and EditorZone, apply the styles to the labels. (Inherited from ToolZone) |
| 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) |
| OKVerb |
Gets a reference to a WebPartVerb object that applies editing changes to a control in edit mode, and hides the editing user interface (UI). |
| Padding |
Gets or sets the cell padding attributes on the table that contains the WebPart controls in a zone. (Inherited from WebZone) |
| 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) |
| PartChromePadding |
Gets or sets the distance between the contents of a WebPart control and the border of the control. (Inherited from WebZone) |
| PartChromeStyle |
Gets style characteristics that apply to the borders of Web Parts controls contained by a zone. (Inherited from WebZone) |
| PartChromeType |
Gets or sets the type of border that frames Web Parts controls contained by a zone. (Inherited from WebZone) |
| PartStyle |
Gets style characteristics that apply to the border and contents of each Web Parts control contained by a zone. (Inherited from WebZone) |
| PartTitleStyle |
Gets style attributes for the title bar content for each Web Parts control contained by a zone. (Inherited from WebZone) |
| RenderClientScript |
Gets a value that indicates whether to render client script on a Web Parts page. (Inherited from WebZone) |
| RenderingCompatibility |
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control) |
| 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) |
| 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 WebZone) |
| 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) |
| 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) |
| VerbButtonType |
Gets or sets what kind of button is used to represent verbs in a zone. (Inherited from WebZone) |
| VerbStyle |
Gets the style attributes for the user interface (UI) verbs associated with Web Parts controls in a zone. (Inherited from WebZone) |
| 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 a user interface (UI) element on the page. (Inherited from ToolZone) |
| WebPartManager |
Gets a reference to the WebPartManager control associated with a WebZone control instance on a Web Parts page. (Inherited from WebZone) |
| WebPartToEdit |
Gets a reference to the WebPart control that is currently being edited. |
| Width |
Gets or sets the width of the Web server control. (Inherited from WebControl) |
Methods
| AddAttributesToRender(HtmlTextWriter) |
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl) |
| 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) |
| Close() |
Called when a user clicks a close verb in the header of a zone, this method ends the process of editing WebPart controls, and returns a Web Parts page's display mode to browse mode. |
| 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() |
Creates the set of child controls associated with an EditorZoneBase zone. |
| CreateControlCollection() |
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control) |
| CreateControlStyle() |
Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl) |
| CreateEditorPartChrome() |
Gets a reference to a new EditorPartChrome object used to render the peripheral user interface (UI) elements around an EditorZoneBase zone. |
| CreateEditorParts() |
Provides a base method declaration that derived zones can override to handle the details of creating the EditorPart controls contained in a zone. |
| DataBind() |
Binds a data source to the CompositeControl and all its child controls. (Inherited from CompositeControl) |
| 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) |
Searches the current naming container for a server control with the specified |
| FindControl(String, Int32) |
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) |
| GetEffectiveChromeType(Part) |
Returns the actual or effective current PartChromeType value of a WebPart control, given the PartChromeType property of the zone and the current display mode of the Web Parts page. (Inherited from WebZone) |
| 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) |
| InvalidateEditorParts() |
Sets the collection of EditorPart controls associated with an EditorZoneBase zone to |
| IsLiteralContent() |
Determines if the server control holds only literal content. (Inherited from Control) |
| LoadControlState(Object) |
Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control) |
| LoadViewState(Object) |
Loads previously saved state information for a zone. |
| 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) |
| OnDataBinding(EventArgs) |
Raises the DataBinding event. (Inherited from Control) |
| OnDisplayModeChanged(Object, WebPartDisplayModeEventArgs) |
Raises the DisplayModeChanged event and destroys all EditorPart and child controls in the zone in preparation for a Web page to enter or exit the edit display mode. |
| OnInit(EventArgs) |
Creates specialized event handlers used by the WebPartManager control on a Web page. (Inherited from ToolZone) |
| OnLoad(EventArgs) |
Raises the Load event. (Inherited from Control) |
| OnPreRender(EventArgs) |
Raises the PreRender event, and calls the PerformPreRender() method for the chrome elements of the EditorPart controls. |
| OnSelectedWebPartChanged(Object, WebPartEventArgs) |
Raises the SelectedWebPartChanged event and sets the EditorParts collection to |
| 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) |
| RaisePostBackEvent(String) |
Carries out the actions associated with one of the zone verbs, or raises an event that posts back to the server. |
| RecreateChildControls() |
Recreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl) |
| RemovedControl(Control) |
Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control) |
| Render(HtmlTextWriter) |
Renders the zone to the specified HtmlTextWriter object. |
| RenderBeginTag(HtmlTextWriter) |
Renders the opening HTML tag of the zone control to the specified HtmlTextWriter object. (Inherited from WebZone) |
| RenderBody(HtmlTextWriter) |
Overrides the base method to render the body area of a zone derived from the EditorZoneBase class. |
| 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 entire contents of a zone control between the beginning and ending tags to the specified HtmlTextWriter object. (Inherited from WebZone) |
| 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) |
| RenderControl(HtmlTextWriter, ControlAdapter) |
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control) |
| RenderEndTag(HtmlTextWriter) |
Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl) |
| RenderFooter(HtmlTextWriter) |
Overrides the base method to render verbs in the footer of a ToolZone control. (Inherited from ToolZone) |
| RenderHeader(HtmlTextWriter) |
Overrides the base method to provide specialized rendering for the header area required by ToolZone controls. (Inherited from ToolZone) |
| RenderVerb(HtmlTextWriter, WebPartVerb) |
Renders an individual verb with a ToolZone control. (Inherited from ToolZone) |
| RenderVerbs(HtmlTextWriter) |
Renders the verbs that apply at the zone level. |
| 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 Control) |
| SaveViewState() |
Saves any view-state changes that have occurred after a page was posted back to the server. |
| SetDesignModeState(IDictionary) |
Sets design-time data for a control. (Inherited from Control) |
| 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) |
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) |
| TrackViewState() |
Tracks changes to a zone control's view state. |
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() |
Enables a designer to recreate the composite control's collection of child controls in the design-time environment. (Inherited from CompositeControl) |
| 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) |
| IPostBackEventHandler.RaisePostBackEvent(String) |
Implements the RaisePostBackEvent(String) method. (Inherited from ToolZone) |
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) |
Sets 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. |
| TryGetMetaTable(INamingContainer, MetaTable) |
Determines whether table metadata is available. |
| EnableDynamicData(INamingContainer, Type) |
Enables Dynamic Data behavior for the specified data control. |
| 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. |
Applies to
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for