EditorZone 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 primary control in the Web Parts control set for hosting EditorPart controls on a Web page.
public ref class EditorZone : System::Web::UI::WebControls::WebParts::EditorZoneBasepublic class EditorZone : System.Web.UI.WebControls.WebParts.EditorZoneBasetype EditorZone = class
inherit EditorZoneBasePublic Class EditorZone
Inherits EditorZoneBase- Inheritance
Examples
The following code example demonstrates several declarative and programmatic uses of the EditorZone class. The example creates a custom editor zone that inherits from the EditorZone class, and uses it in a Web Parts page.
The code example has three parts:
A user control that enables you to change display modes on the Web page.
A Web page that references the custom EditorZone control.
An explanation of how the example works.
The first part of this code example is the user control that enables users to change display modes on a Web page. For more details about display modes and a description of the source code in this control, see Walkthrough: Changing Display Modes on a Web Parts Page.
<%@ control language="C#" classname="DisplayModeMenuCS"%>
<script runat="server">
// Use a field to reference the current WebPartManager.
WebPartManager _manager;
void Page_Init(object sender, EventArgs e)
{
Page.InitComplete += new EventHandler(InitComplete);
}
void InitComplete(object sender, System.EventArgs e)
{
_manager = WebPartManager.GetCurrentWebPartManager(Page);
String browseModeName = WebPartManager.BrowseDisplayMode.Name;
// Fill the dropdown with the names of supported display modes.
foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)
{
String modeName = mode.Name;
// Make sure a mode is enabled before adding it.
if (mode.IsEnabled(_manager))
{
ListItem item = new ListItem(modeName + " Mode", modeName);
DisplayModeDropdown.Items.Add(item);
}
}
}
// Change the page to the selected display mode.
void DisplayModeDropdown_SelectedIndexChanged(object sender,
EventArgs e)
{
String selectedMode = DisplayModeDropdown.SelectedValue;
WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];
if (mode != null)
_manager.DisplayMode = mode;
}
void Page_PreRender(object sender, EventArgs e)
{
DisplayModeDropdown.SelectedValue = _manager.DisplayMode.Name;
}
</script>
<div>
<asp:DropDownList ID="DisplayModeDropdown"
runat="server"
AutoPostBack="true"
OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
</div>
<%@ control language="vb" classname="DisplayModeMenuVB"%>
<script runat="server">
' Use a field to reference the current WebPartManager.
Dim _manager As WebPartManager
Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
AddHandler Page.InitComplete, AddressOf InitComplete
End Sub
Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs)
_manager = WebPartManager.GetCurrentWebPartManager(Page)
Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name
' Fill the dropdown with the names of supported display modes.
Dim mode As WebPartDisplayMode
For Each mode In _manager.SupportedDisplayModes
Dim modeName As String = mode.Name
' Make sure a mode is enabled before adding it.
If mode.IsEnabled(_manager) Then
Dim item As New ListItem(modeName + " Mode", modeName)
DisplayModeDropdown.Items.Add(item)
End If
Next mode
End Sub
' Change the page to the selected display mode.
Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs)
Dim selectedMode As String = DisplayModeDropdown.SelectedValue
Dim mode As WebPartDisplayMode = _manager.SupportedDisplayModes(selectedMode)
If Not (mode Is Nothing) Then
_manager.DisplayMode = mode
End If
End Sub
Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs)
DisplayModeDropdown.SelectedValue = _manager.DisplayMode.Name
End Sub
</script>
<div>
<asp:DropDownList ID="DisplayModeDropdown"
runat="server"
AutoPostBack="true"
OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
</div>
The second part of the code example is a Web page. 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: prefix for the element. Notice that below the <asp:WebPartZone> element is an <asp:EditorZone> element that contains several EditorPart controls, with some tags and properties set to determine its appearance and behavior. There are also a number of methods that access various members of the EditorZone control programmatically.
<%@ Page Language="C#" %>
<%@ register tagprefix="uc1"
tagname="DisplayModeMenuCS"
src="displaymodecs.ascx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
// <snippet3>
void Button1_Click(object sender, EventArgs e)
{
if (EditorZone1.ApplyVerb.Enabled == true)
EditorZone1.ApplyVerb.Enabled = false;
else
EditorZone1.ApplyVerb.Enabled = true;
}
void Button2_Click(object sender, EventArgs e)
{
EditorZone1.BorderWidth = 2;
EditorZone1.BorderColor = System.Drawing.Color.DarkBlue;
}
void Button3_Click(object sender, EventArgs e)
{
Label1.Text = "<br />";
foreach (EditorPart part in EditorZone1.EditorParts)
{
Label1.Text += part.ID + "<br />";
}
}
void Button4_Click(object sender, EventArgs e)
{
EditorZone1.InstructionText = "My custom instruction text.";
}
// </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="mgr" 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>
<asp:EditorZone ID="EditorZone1" runat="server" >
<VerbStyle Font-Italic="true" />
<EditUIStyle BackColor="lightgray" />
<PartChromeStyle BorderWidth="1" />
<LabelStyle Font-Bold="true" />
<CancelVerb Text="Cancel Changes" />
<ZoneTemplate>
<asp:AppearanceEditorPart ID="AppearanceEditorPart1"
runat="server" />
<asp:LayoutEditorPart ID="LayoutEditorPart1"
runat="server" />
</ZoneTemplate>
</asp:EditorZone>
<hr />
<asp:Button ID="Button1" runat="server" Width="200"
Text="Enable or Disable Apply" OnClick="Button1_Click" />
<br />
<asp:Button ID="Button2" runat="server" Width="200"
Text="Set Zone BorderColor" OnClick="Button2_Click" />
<br />
<asp:Button ID="Button3" runat="server" Width="200"
Text="Display EditorPart Collection" OnClick="Button3_Click" />
<asp:Label ID="Label1" runat="server" />
<br />
<asp:Button ID="Button4" runat="server" Width="200"
Text="Set Instruction Text" OnClick="Button4_Click" />
</form>
</body>
</html>
<%@ Page Language="vb" %>
<%@ register tagprefix="uc1"
tagname="DisplayModeMenuVB"
src="displaymodevb.ascx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
' <snippet3>
Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)
If EditorZone1.ApplyVerb.Enabled = True Then
EditorZone1.ApplyVerb.Enabled = False
Else
EditorZone1.ApplyVerb.Enabled = True
End If
End Sub
Sub Button2_Click(ByVal sender As Object, ByVal e As EventArgs)
EditorZone1.BorderWidth = 2
EditorZone1.BorderColor = System.Drawing.Color.DarkBlue
End Sub
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
Sub Button4_Click(ByVal sender As Object, ByVal e As EventArgs)
EditorZone1.InstructionText = "My custom instruction text."
End Sub
' </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="mgr" 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>
<asp:EditorZone ID="EditorZone1" runat="server" >
<VerbStyle Font-Italic="true" />
<EditUIStyle BackColor="lightgray" />
<PartChromeStyle BorderWidth="1" />
<LabelStyle Font-Bold="true" />
<CancelVerb Text="Cancel Changes" />
<ZoneTemplate>
<asp:AppearanceEditorPart ID="AppearanceEditorPart1"
runat="server" />
<asp:LayoutEditorPart ID="LayoutEditorPart1"
runat="server" />
</ZoneTemplate>
</asp:EditorZone>
<hr />
<asp:Button ID="Button1" runat="server" Width="200"
Text="Enable or Disable Apply" OnClick="Button1_Click" />
<br />
<asp:Button ID="Button2" runat="server" Width="200"
Text="Set Zone BorderColor" OnClick="Button2_Click" />
<br />
<asp:Button ID="Button3" runat="server" Width="200"
Text="Display EditorPart Collection" OnClick="Button3_Click" />
<asp:Label ID="Label1" runat="server" />
<br />
<asp:Button ID="Button4" runat="server" Width="200"
Text="Set Instruction Text" OnClick="Button4_Click" />
</form>
</body>
</html>
When you load the page in a browser, you can select Edit Mode in the drop-down list to switch to edit mode. To display the editing UI, 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. With the editing UI visible, you can see the effects of the declarative and programmatic uses of the EditorZone class members.
Remarks
Within the Web Parts control set, a zone is a composite control that covers a defined region on a Web page and contains server controls. The primary functions of a zone are to lay out the controls it contains, and to provide a common user interface (UI) for those controls. For general information about zones and how they are used in Web Parts applications, see the reference documentation for the base WebZone class, and Web Parts Control Set Overview.
The EditorZone control is one of the fundamental controls in the Web Parts control set. A key feature of Web Parts is the ability of end users to modify (or personalize) Web pages according to their preferences, and save their personalized settings for future browser sessions. One aspect of modifying Web Parts pages includes editing; users can edit the appearance, layout, behavior, and other properties of the visible WebPart controls. Several controls in the Web Parts control set provide the editing features, including the EditorZone control.
An EditorZone control becomes visible when a Web Parts page enters edit mode, and it makes available various EditorPart controls that can be used to personalize WebPart controls. The EditorZone control is very similar to its parent, the EditorZoneBase class, with one key difference: The EditorZone control provides a zone template, referenced in its ZoneTemplate property. The zone template adds the ability to declare content in the page persistence format. Page developers can place an EditorZone control in the declarative markup of a Web page, add a child <zonetemplate> element, and within the <zonetemplate> element, add declarative references to EditorPart controls.
The EditorZone control also has a method, CreateEditorParts, which overrides a base method in the EditorZoneBase class. This method is necessary so that an EditorZone control can create the zone template to contain any EditorPart controls that are added to the zone declaratively.
Note
The buttons in the EditorZone UI require client-side scripting in order to work correctly. If scripting is disabled in the browser, the user will not be able to perform actions through the EditorZone UI.
Accessibility
The markup rendered by default for this control might not conform to accessibility standards such as the Web Content Accessibility Guidelines 1.0 (WCAG) priority 1 guidelines. For details about accessibility support for this control, see ASP.NET Controls and Accessibility.
Notes to Inheritors
If you want to create a custom EditorZone zone to gain greater control over the rendering of the editing UI, you can inherit directly from the EditorZoneBase class, as long as you do not need to provide zone template support for page developers to add EditorPart controls to your zone declaratively. In such a case, you would add all EditorPart controls to a zone programmatically. If you want to provide zone template support, you should inherit from the EditorZone class.
Constructors
| EditorZone() |
Initializes a new instance of the EditorZone 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| EditorPartChrome |
Gets a reference to the instance of the EditorPartChrome class associated with the EditorZoneBase zone. (Inherited from EditorZoneBase) |
| EditorParts |
Gets a collection of all the EditorPart controls contained in an EditorZoneBase zone. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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). (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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). (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| Width |
Gets or sets the width of the Web server control. (Inherited from WebControl) |
| ZoneTemplate |
Provides a template to contain child controls within an EditorZone control in page persistence format. |
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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| CreateEditorParts() |
Creates all the EditorPart controls declared within a zone template in page persistence format. |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
| 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. (Inherited from EditorZoneBase) |
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