ToolZone ToolZone ToolZone ToolZone Class

Definition

Serves as the base class for a set of helper zones that appear only in certain associated page display modes.

public ref class ToolZone abstract : System::Web::UI::WebControls::WebParts::WebZone, System::Web::UI::IPostBackEventHandler
public abstract class ToolZone : System.Web.UI.WebControls.WebParts.WebZone, System.Web.UI.IPostBackEventHandler
type ToolZone = class
    inherit WebZone
    interface IPostBackEventHandler
Public MustInherit Class ToolZone
Inherits WebZone
Implements IPostBackEventHandler
Inheritance
Derived
Implements

Remarks

In the Web Parts control set, a zone is a region on a Web page that contains server controls, and provides modular layout with a consistent user interface (UI) for the contained controls.

There are two general types of zone controls that derive from the base WebZone class: WebPartZoneBase zones and ToolZone zones. The WebPartZoneBase zones contain server controls (which can be custom WebPart controls, or other server controls including ASP.NET controls and user controls). These controls form the primary UI of a Web page and are visible in all the possible display modes, unless they are hidden programmatically or by a user.

The ToolZone zones are special helper zones that appear only when a page is in certain display modes associated with the zone, and these zones also contain special server controls that enable users to modify the layout, appearance, properties, and content of Web pages from within a browser. Developers can inherit from the base ToolZone class, or any of the derived ToolZone zones, to create custom zones.

The Web Parts control set contains three types of ToolZone zones, described in the following table.

Tool zone type Description
EditorZone Contains controls used to edit WebPart and server control properties on a page.
CatalogZone Contains CatalogPart controls, which in turn contain WebPart controls that users can add to a page.
ConnectionsZone Does not contain declarative markup elements; this zone is self-contained. At run time, it renders a special UI that enables users to manage connections between WebPart controls.

The ToolZone base class provides methods and properties that are useful to derived zones. It contains RenderHeader and RenderFooter methods, which override the base methods from the WebZone class, and render buttons and other UI attributes for the header and footer of a zone. There are also several members for handling verbs, which are common UI actions that users can perform in the various zones. Members related to handling verbs include: RenderVerb, RenderVerbs, and HeaderCloseVerb.

The ToolZone contains two overloaded methods, which add WebPartDisplayMode objects to the AssociatedDisplayModes collection. This collection of associated display modes determines which display modes are related to a particular type of zone (in other words, it determines in which display modes a zone is visible). The union of all associated display modes for all the ToolZone zones on a given Web page determines which display modes (besides the normal browse mode) are possible or supported on the page. The collection of supported display modes for a page is contained in the SupportedDisplayModes property.

Note

At any given time, only one display mode can be active on a page. The currently active display mode is referenced in the DisplayMode property.

The ToolZone class also contains a number of style properties that contain style attributes for the various UI elements of a zone. Some ToolZone style properties include EditUIStyle, HeaderVerbStyle, InstructionTextStyle, and LabelStyle.

Notes to Inheritors

The Web Parts control set contains the specialized zones listed above in the Remarks section, and you can often derive from one of them to add custom behavior to a zone. However, for more programmatic control over the rendering of a zone, you should inherit directly from the ToolZone class. For example, you might want to create a custom zone for a specialized task, such as a search zone.

To create a custom zone, you can override any of the virtual ToolZone members to fully customize the rendering, or you can override only a specific member. Optionally, you can also create a custom display mode for your zone by inheriting from the WebPartDisplayMode class, but this is not required. In the constructor of your zone, you should add the various display modes in which you want your zone to be displayed to a WebPartDisplayModeCollection object, so that your zone is visible when the page is in those display modes.

Constructors

ToolZone(ICollection) ToolZone(ICollection) ToolZone(ICollection) ToolZone(ICollection)

Associates a collection of WebPartDisplayMode objects with a particular ToolZone zone, so that the zone can be displayed in the appropriate page display modes.

ToolZone(WebPartDisplayMode) ToolZone(WebPartDisplayMode) ToolZone(WebPartDisplayMode) ToolZone(WebPartDisplayMode)

Associates a single WebPartDisplayMode object with a particular ToolZone zone, so that the zone can be displayed in the appropriate page display mode.

Properties

AccessKey AccessKey AccessKey AccessKey

Gets or sets the access key that allows you to quickly navigate to the Web server control.

(Inherited from WebControl)
Adapter Adapter Adapter Adapter

Gets the browser-specific adapter for the control.

(Inherited from Control)
AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory AppRelativeTemplateSourceDirectory

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.

(Inherited from Control)
AssociatedDisplayModes AssociatedDisplayModes AssociatedDisplayModes AssociatedDisplayModes

Gets the collection of WebPartDisplayMode objects that are associated with a particular ToolZone zone.

Attributes Attributes Attributes Attributes

Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.

(Inherited from WebControl)
BackColor BackColor BackColor BackColor

Gets or sets the background color of the Web server control.

(Inherited from WebControl)
BackImageUrl BackImageUrl BackImageUrl BackImageUrl

Gets or sets the URL to a background image for a zone.

(Inherited from WebZone)
BindingContainer BindingContainer BindingContainer BindingContainer

Gets the control that contains this control's data binding.

(Inherited from Control)
BorderColor BorderColor BorderColor BorderColor

Gets or sets the border color of the Web control.

(Inherited from WebControl)
BorderStyle BorderStyle BorderStyle BorderStyle

Gets or sets the border style of the Web server control.

(Inherited from WebControl)
BorderWidth BorderWidth BorderWidth BorderWidth

Gets or sets the border width of the Web server control.

(Inherited from WebControl)
ChildControlsCreated ChildControlsCreated ChildControlsCreated ChildControlsCreated

Gets a value that indicates whether the server control's child controls have been created.

(Inherited from Control)
ClientID ClientID ClientID ClientID

Gets the control ID for HTML markup that is generated by ASP.NET.

(Inherited from Control)
ClientIDMode ClientIDMode ClientIDMode ClientIDMode

Gets or sets the algorithm that is used to generate the value of the ClientID property.

(Inherited from Control)
ClientIDSeparator ClientIDSeparator ClientIDSeparator ClientIDSeparator

Gets a character value representing the separator character used in the ClientID property.

(Inherited from Control)
Context Context Context Context

Gets the HttpContext object associated with the server control for the current Web request.

(Inherited from Control)
Controls Controls Controls Controls

Gets a ControlCollection object that represents the child controls in a CompositeControl.

(Inherited from CompositeControl)
ControlStyle ControlStyle ControlStyle ControlStyle

Gets the style of the Web server control. This property is used primarily by control developers.

(Inherited from WebControl)
ControlStyleCreated ControlStyleCreated ControlStyleCreated 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 CssClass CssClass CssClass

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.

(Inherited from WebControl)
DataItemContainer DataItemContainer DataItemContainer DataItemContainer

Gets a reference to the naming container if the naming container implements IDataItemContainer.

(Inherited from Control)
DataKeysContainer DataKeysContainer DataKeysContainer DataKeysContainer

Gets a reference to the naming container if the naming container implements IDataKeysControl.

(Inherited from Control)
DesignMode DesignMode DesignMode DesignMode

Gets a value indicating whether a control is being used on a design surface.

(Inherited from Control)
Display Display Display Display

Gets a value that indicates whether a ToolZone control is currently displayed.

EditUIStyle EditUIStyle EditUIStyle EditUIStyle

Gets the style attributes for the editable controls contained in a ToolZone control.

EmptyZoneText EmptyZoneText EmptyZoneText EmptyZoneText

Gets or sets a message that appears when a zone contains no controls.

(Inherited from WebZone)
EmptyZoneTextStyle EmptyZoneTextStyle EmptyZoneTextStyle EmptyZoneTextStyle

Gets the style attributes for the placeholder text in an empty zone.

(Inherited from WebZone)
Enabled Enabled Enabled Enabled

Gets or sets a value indicating whether the Web server control is enabled.

(Inherited from WebControl)
EnableTheming EnableTheming EnableTheming EnableTheming

Gets or sets a value indicating whether themes apply to this control.

(Inherited from WebControl)
EnableViewState EnableViewState EnableViewState 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 ErrorStyle ErrorStyle 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)
Events Events Events Events

Gets a list of event handler delegates for the control. This property is read-only.

(Inherited from Control)
Font Font Font Font

Gets the font properties associated with the Web server control.

(Inherited from WebControl)
FooterStyle FooterStyle FooterStyle FooterStyle

Gets the style attributes for the contents of a zone's footer area.

(Inherited from WebZone)
ForeColor ForeColor ForeColor ForeColor

Gets or sets the foreground color (typically the color of the text) of the Web server control.

(Inherited from WebControl)
HasAttributes HasAttributes HasAttributes HasAttributes

Gets a value indicating whether the control has attributes set.

(Inherited from WebControl)
HasChildViewState HasChildViewState HasChildViewState HasChildViewState

Gets a value indicating whether the current server control's child controls have any saved view-state settings.

(Inherited from Control)
HasFooter HasFooter HasFooter HasFooter

Gets a value indicating whether a zone has a footer area.

(Inherited from WebZone)
HasHeader HasHeader HasHeader HasHeader

Gets a value indicating whether a zone has a header area.

(Inherited from WebZone)
HeaderCloseVerb HeaderCloseVerb HeaderCloseVerb HeaderCloseVerb

Gets a reference to the WebPartVerb object in the header of a ToolZone control that is used to close the control.

HeaderStyle HeaderStyle HeaderStyle HeaderStyle

Gets the style attributes for the contents of a zone's header area.

(Inherited from WebZone)
HeaderText HeaderText HeaderText HeaderText

Gets or sets the text for the header area of a zone.

(Inherited from WebZone)
HeaderVerbStyle HeaderVerbStyle HeaderVerbStyle HeaderVerbStyle

Gets the style attributes for all header verbs displayed in a ToolZone control.

Height Height Height Height

Gets or sets the height of the Web server control.

(Inherited from WebControl)
IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder IControlBuilderAccessor.ControlBuilder

For a description of this member, see ControlBuilder.

(Inherited from Control)
IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData IControlDesignerAccessor.UserData

For a description of this member, see UserData.

(Inherited from Control)
ID ID ID ID

Gets or sets the programmatic identifier assigned to the server control.

(Inherited from Control)
IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings IDataBindingsAccessor.DataBindings

For a description of this member, see DataBindings.

(Inherited from Control)
IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings IDataBindingsAccessor.HasDataBindings

For a description of this member, see HasDataBindings.

(Inherited from Control)
IdSeparator IdSeparator IdSeparator IdSeparator

Gets the character used to separate control identifiers.

(Inherited from Control)
IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions IExpressionsAccessor.Expressions

For a description of this member, see Expressions.

(Inherited from Control)
IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions IExpressionsAccessor.HasExpressions

For a description of this member, see HasExpressions.

(Inherited from Control)
InstructionText InstructionText InstructionText InstructionText

Gets or sets the text in a ToolZone control that provides directions for end users.

InstructionTextStyle InstructionTextStyle InstructionTextStyle InstructionTextStyle

Gets the style attributes for the instruction text that appears at the top of a ToolZone control.

IsChildControlStateCleared IsChildControlStateCleared IsChildControlStateCleared IsChildControlStateCleared

Gets a value indicating whether controls contained within this control have control state.

(Inherited from Control)
IsEnabled IsEnabled IsEnabled IsEnabled

Gets a value indicating whether the control is enabled.

(Inherited from WebControl)
IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

Gets a value that indicates whether the server control is saving changes to its view state.

(Inherited from Control)
IsViewStateEnabled IsViewStateEnabled IsViewStateEnabled IsViewStateEnabled

Gets a value indicating whether view state is enabled for this control.

(Inherited from Control)
LabelStyle LabelStyle LabelStyle 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.

LoadViewStateByID LoadViewStateByID LoadViewStateByID LoadViewStateByID

Gets a value indicating whether the control participates in loading its view state by ID instead of index.

(Inherited from Control)
NamingContainer NamingContainer NamingContainer 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)
Padding Padding Padding Padding

Gets or sets the cell padding attributes on the table that contains the WebPart controls in a zone.

(Inherited from WebZone)
Page Page Page Page

Gets a reference to the Page instance that contains the server control.

(Inherited from Control)
Parent Parent Parent Parent

Gets a reference to the server control's parent control in the page control hierarchy.

(Inherited from Control)
PartChromePadding PartChromePadding PartChromePadding PartChromePadding

Gets or sets the distance between the contents of a WebPart control and the border of the control.

(Inherited from WebZone)
PartChromeStyle PartChromeStyle PartChromeStyle PartChromeStyle

Gets style characteristics that apply to the borders of Web Parts controls contained by a zone.

(Inherited from WebZone)
PartChromeType PartChromeType PartChromeType PartChromeType

Gets or sets the type of border that frames Web Parts controls contained by a zone.

(Inherited from WebZone)
PartStyle PartStyle PartStyle PartStyle

Gets style characteristics that apply to the border and contents of each Web Parts control contained by a zone.

(Inherited from WebZone)
PartTitleStyle PartTitleStyle PartTitleStyle PartTitleStyle

Gets style attributes for the title bar content for each Web Parts control contained by a zone.

(Inherited from WebZone)
RenderClientScript RenderClientScript RenderClientScript RenderClientScript

Gets a value that indicates whether to render client script on a Web Parts page.

(Inherited from WebZone)
RenderingCompatibility RenderingCompatibility RenderingCompatibility RenderingCompatibility

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.

(Inherited from Control)
Site Site Site Site

Gets information about the container that hosts the current control when rendered on a design surface.

(Inherited from Control)
SkinID SkinID SkinID SkinID

Gets or sets the skin to apply to the control.

(Inherited from WebControl)
Style Style Style 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 SupportsDisabledAttribute SupportsDisabledAttribute SupportsDisabledAttribute

Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.

(Inherited from CompositeControl)
TabIndex TabIndex TabIndex TabIndex

Gets or sets the tab index of the Web server control.

(Inherited from WebControl)
TagKey TagKey TagKey TagKey

Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.

(Inherited from WebZone)
TagName TagName TagName TagName

Gets the name of the control tag. This property is used primarily by control developers.

(Inherited from WebControl)
TemplateControl TemplateControl TemplateControl TemplateControl

Gets or sets a reference to the template that contains this control.

(Inherited from Control)
TemplateSourceDirectory TemplateSourceDirectory TemplateSourceDirectory TemplateSourceDirectory

Gets the virtual directory of the Page or UserControl that contains the current server control.

(Inherited from Control)
ToolTip ToolTip ToolTip ToolTip

Gets or sets the text displayed when the mouse pointer hovers over the Web server control.

(Inherited from WebControl)
UniqueID UniqueID UniqueID UniqueID

Gets the unique, hierarchically qualified identifier for the server control.

(Inherited from Control)
ValidateRequestMode ValidateRequestMode ValidateRequestMode 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 VerbButtonType VerbButtonType VerbButtonType

Gets or sets what kind of button is used to represent verbs in a zone.

(Inherited from WebZone)
VerbStyle VerbStyle VerbStyle VerbStyle

Gets the style attributes for the user interface (UI) verbs associated with Web Parts controls in a zone.

(Inherited from WebZone)
ViewState ViewState ViewState 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 ViewStateIgnoresCase ViewStateIgnoresCase ViewStateIgnoresCase

Gets a value that indicates whether the StateBag object is case-insensitive.

(Inherited from Control)
ViewStateMode ViewStateMode ViewStateMode ViewStateMode

Gets or sets the view-state mode of this control.

(Inherited from Control)
Visible Visible Visible Visible

Gets or sets a value that indicates whether a server control is rendered as a user interface (UI) element on the page.

WebPartManager WebPartManager WebPartManager WebPartManager

Gets a reference to the WebPartManager control associated with a WebZone control instance on a Web Parts page.

(Inherited from WebZone)
Width Width Width Width

Gets or sets the width of the Web server control.

(Inherited from WebControl)

Methods

AddAttributesToRender(HtmlTextWriter) AddAttributesToRender(HtmlTextWriter) AddAttributesToRender(HtmlTextWriter) 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) AddedControl(Control, Int32) AddedControl(Control, Int32) AddedControl(Control, Int32)

Called after a child control is added to the Controls collection of the Control object.

(Inherited from Control)
AddParsedSubObject(Object) AddParsedSubObject(Object) AddParsedSubObject(Object) 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) ApplyStyle(Style) ApplyStyle(Style) 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) ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page) ApplyStyleSheetSkin(Page)

Applies the style properties defined in the page style sheet to the control.

(Inherited from Control)
BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object) BeginRenderTracing(TextWriter, Object)

Begins design-time tracing of rendering data.

(Inherited from Control)
BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean) BuildProfileTree(String, Boolean) 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() ClearCachedClientID() ClearCachedClientID() ClearCachedClientID()

Sets the cached ClientID value to null.

(Inherited from Control)
ClearChildControlState() ClearChildControlState() ClearChildControlState() ClearChildControlState()

Deletes the control-state information for the server control's child controls.

(Inherited from Control)
ClearChildState() ClearChildState() ClearChildState() ClearChildState()

Deletes the view-state and control-state information for all the server control's child controls.

(Inherited from Control)
ClearChildViewState() ClearChildViewState() ClearChildViewState() ClearChildViewState()

Deletes the view-state information for all the server control's child controls.

(Inherited from Control)
ClearEffectiveClientIDMode() ClearEffectiveClientIDMode() ClearEffectiveClientIDMode() ClearEffectiveClientIDMode()

Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.

(Inherited from Control)
Close() Close() Close() Close()

Provides a base method declaration that derived ToolZone controls can override to handle the details of closing a specialized zone.

CopyBaseAttributes(WebControl) CopyBaseAttributes(WebControl) CopyBaseAttributes(WebControl) 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() CreateChildControls() CreateChildControls() 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() CreateControlCollection() CreateControlCollection() CreateControlCollection()

Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

(Inherited from Control)
CreateControlStyle() CreateControlStyle() CreateControlStyle() 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)
DataBind() DataBind() DataBind() DataBind()

Binds a data source to the CompositeControl and all its child controls.

(Inherited from CompositeControl)
DataBind(Boolean) DataBind(Boolean) DataBind(Boolean) 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() DataBindChildren() DataBindChildren() DataBindChildren()

Binds a data source to the server control's child controls.

(Inherited from Control)
Dispose() Dispose() Dispose() Dispose()

Enables a server control to perform final clean up before it is released from memory.

(Inherited from Control)
EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object) EndRenderTracing(TextWriter, Object)

Ends design-time tracing of rendering data.

(Inherited from Control)
EnsureChildControls() EnsureChildControls() EnsureChildControls() EnsureChildControls()

Determines whether the server control contains child controls. If it does not, it creates child controls.

(Inherited from Control)
EnsureID() EnsureID() EnsureID() EnsureID()

Creates an identifier for controls that do not have an identifier assigned.

(Inherited from Control)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindControl(String) FindControl(String) FindControl(String) FindControl(String)

Searches the current naming container for a server control with the specified id parameter.

(Inherited from Control)
FindControl(String, Int32) FindControl(String, Int32) FindControl(String, Int32) FindControl(String, Int32)

Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.

(Inherited from Control)
Focus() Focus() Focus() Focus()

Sets input focus to a control.

(Inherited from Control)
GetDesignModeState() GetDesignModeState() GetDesignModeState() GetDesignModeState()

Gets design-time data for a control.

(Inherited from Control)
GetEffectiveChromeType(Part) GetEffectiveChromeType(Part) GetEffectiveChromeType(Part) 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() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetRouteUrl(Object) GetRouteUrl(Object) GetRouteUrl(Object) GetRouteUrl(Object)

Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary) GetRouteUrl(RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(String, Object) GetRouteUrl(String, Object) GetRouteUrl(String, Object) GetRouteUrl(String, Object)

Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary) GetRouteUrl(String, RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control) GetUniqueIDRelativeTo(Control)

Returns the prefixed portion of the UniqueID property of the specified control.

(Inherited from Control)
HasControls() HasControls() HasControls() HasControls()

Determines if the server control contains any child controls.

(Inherited from Control)
HasEvents() HasEvents() HasEvents() HasEvents()

Returns a value indicating whether events are registered for the control or any child controls.

(Inherited from Control)
IsLiteralContent() IsLiteralContent() IsLiteralContent() IsLiteralContent()

Determines if the server control holds only literal content.

(Inherited from Control)
LoadControlState(Object) LoadControlState(Object) LoadControlState(Object) LoadControlState(Object)

Restores control-state information from a previous page request that was saved by the SaveControlState() method.

(Inherited from Control)
LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

Loads view state.

MapPathSecure(String) MapPathSecure(String) MapPathSecure(String) MapPathSecure(String)

Retrieves the physical path that a virtual path, either absolute or relative, maps to.

(Inherited from Control)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MergeStyle(Style) MergeStyle(Style) MergeStyle(Style) 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) OnBubbleEvent(Object, EventArgs) OnBubbleEvent(Object, EventArgs) 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) OnDataBinding(EventArgs) OnDataBinding(EventArgs) OnDataBinding(EventArgs)

Raises the DataBinding event.

(Inherited from Control)
OnDisplayModeChanged(Object, WebPartDisplayModeEventArgs) OnDisplayModeChanged(Object, WebPartDisplayModeEventArgs) OnDisplayModeChanged(Object, WebPartDisplayModeEventArgs) OnDisplayModeChanged(Object, WebPartDisplayModeEventArgs)

Provides a base method declaration that derived ToolZone controls can override to handle the details of changing page display modes for a specialized zone.

OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs) OnInit(EventArgs)

Creates specialized event handlers used by the WebPartManager control on a Web page.

OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs) OnLoad(EventArgs)

Raises the Load event.

(Inherited from Control)
OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs) OnPreRender(EventArgs)

Raises the PreRender event.

(Inherited from WebZone)
OnSelectedWebPartChanged(Object, WebPartEventArgs) OnSelectedWebPartChanged(Object, WebPartEventArgs) OnSelectedWebPartChanged(Object, WebPartEventArgs) OnSelectedWebPartChanged(Object, WebPartEventArgs)

Provides a base method declaration that derived ToolZone controls can override to handle the event of changing which Web Parts control is selected within a specialized zone.

OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs) OnUnload(EventArgs)

Raises the Unload event.

(Inherited from Control)
OpenFile(String) OpenFile(String) OpenFile(String) OpenFile(String)

Gets a Stream used to read a file.

(Inherited from Control)
RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs) RaiseBubbleEvent(Object, EventArgs)

Assigns any sources of the event and its information to the control's parent.

(Inherited from Control)
RaisePostBackEvent(String) RaisePostBackEvent(String) RaisePostBackEvent(String) RaisePostBackEvent(String)

Calls the Close() method for a ToolZone control when the control posts back to the server.

RecreateChildControls() RecreateChildControls() RecreateChildControls() RecreateChildControls()

Recreates the child controls in a control derived from CompositeControl.

(Inherited from CompositeControl)
RemovedControl(Control) RemovedControl(Control) RemovedControl(Control) RemovedControl(Control)

Called after a child control is removed from the Controls collection of the Control object.

(Inherited from Control)
Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter) Render(HtmlTextWriter)

Writes the CompositeControl content to the specified HtmlTextWriter object, for display on the client.

(Inherited from CompositeControl)
RenderBeginTag(HtmlTextWriter) RenderBeginTag(HtmlTextWriter) RenderBeginTag(HtmlTextWriter) RenderBeginTag(HtmlTextWriter)

Renders the opening HTML tag of the zone control to the specified HtmlTextWriter object.

(Inherited from WebZone)
RenderBody(HtmlTextWriter) RenderBody(HtmlTextWriter) RenderBody(HtmlTextWriter) RenderBody(HtmlTextWriter)

Overrides rendering for the body of a zone control.

(Inherited from WebZone)
RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) RenderChildren(HtmlTextWriter) 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) RenderContents(HtmlTextWriter) RenderContents(HtmlTextWriter) 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) RenderControl(HtmlTextWriter) RenderControl(HtmlTextWriter) 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) RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter) RenderControl(HtmlTextWriter, ControlAdapter)

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.

(Inherited from Control)
RenderEndTag(HtmlTextWriter) RenderEndTag(HtmlTextWriter) RenderEndTag(HtmlTextWriter) 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) RenderFooter(HtmlTextWriter) RenderFooter(HtmlTextWriter) RenderFooter(HtmlTextWriter)

Overrides the base method to render verbs in the footer of a ToolZone control.

RenderHeader(HtmlTextWriter) RenderHeader(HtmlTextWriter) RenderHeader(HtmlTextWriter) RenderHeader(HtmlTextWriter)

Overrides the base method to provide specialized rendering for the header area required by ToolZone controls.

RenderVerb(HtmlTextWriter, WebPartVerb) RenderVerb(HtmlTextWriter, WebPartVerb) RenderVerb(HtmlTextWriter, WebPartVerb) RenderVerb(HtmlTextWriter, WebPartVerb)

Renders an individual verb with a ToolZone control.

RenderVerbs(HtmlTextWriter) RenderVerbs(HtmlTextWriter) RenderVerbs(HtmlTextWriter) RenderVerbs(HtmlTextWriter)

Provides a base method declaration that derived ToolZone controls can override to customize the rendering of the verbs within a specialized zone.

ResolveAdapter() ResolveAdapter() ResolveAdapter() ResolveAdapter()

Gets the control adapter responsible for rendering the specified control.

(Inherited from Control)
ResolveClientUrl(String) ResolveClientUrl(String) ResolveClientUrl(String) ResolveClientUrl(String)

Gets a URL that can be used by the browser.

(Inherited from Control)
ResolveUrl(String) ResolveUrl(String) ResolveUrl(String) ResolveUrl(String)

Converts a URL into one that is usable on the requesting client.

(Inherited from Control)
SaveControlState() SaveControlState() SaveControlState() 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() SaveViewState() SaveViewState() SaveViewState()

Saves any view-state changes that have occurred after a page was posted back to the server.

SetDesignModeState(IDictionary) SetDesignModeState(IDictionary) SetDesignModeState(IDictionary) SetDesignModeState(IDictionary)

Sets design-time data for a control.

(Inherited from Control)
SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod) SetRenderMethodDelegate(RenderMethod) 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) SetTraceData(Object, Object) SetTraceData(Object, Object) 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) SetTraceData(Object, Object, Object) SetTraceData(Object, Object, Object) 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() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

Tracks changes to a zone control's view state.

Explicit Interface Implementations

IAttributeAccessor.GetAttribute(String) IAttributeAccessor.GetAttribute(String) IAttributeAccessor.GetAttribute(String) IAttributeAccessor.GetAttribute(String)

Gets an attribute of the Web control with the specified name.

(Inherited from WebControl)
IAttributeAccessor.SetAttribute(String, String) IAttributeAccessor.SetAttribute(String, String) IAttributeAccessor.SetAttribute(String, String) IAttributeAccessor.SetAttribute(String, String)

Sets an attribute of the Web control to the specified name and value.

(Inherited from WebControl)
ICompositeControlDesignerAccessor.RecreateChildControls() ICompositeControlDesignerAccessor.RecreateChildControls() ICompositeControlDesignerAccessor.RecreateChildControls() ICompositeControlDesignerAccessor.RecreateChildControls()

Enables a designer to recreate the composite control's collection of child controls in the design-time environment.

(Inherited from CompositeControl)
IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState() IControlDesignerAccessor.GetDesignModeState()

For a description of this member, see GetDesignModeState().

(Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary) IControlDesignerAccessor.SetDesignModeState(IDictionary)

For a description of this member, see SetDesignModeState(IDictionary).

(Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control) IControlDesignerAccessor.SetOwnerControl(Control)

For a description of this member, see SetOwnerControl(Control).

(Inherited from Control)
IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object) IParserAccessor.AddParsedSubObject(Object)

For a description of this member, see AddParsedSubObject(Object).

(Inherited from Control)
IPostBackEventHandler.RaisePostBackEvent(String) IPostBackEventHandler.RaisePostBackEvent(String) IPostBackEventHandler.RaisePostBackEvent(String) IPostBackEventHandler.RaisePostBackEvent(String)

Implements the RaisePostBackEvent(String) method.

Events

DataBinding DataBinding DataBinding DataBinding

Occurs when the server control binds to a data source.

(Inherited from Control)
Disposed Disposed Disposed 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 Init Init Init

Occurs when the server control is initialized, which is the first step in its lifecycle.

(Inherited from Control)
Load Load Load Load

Occurs when the server control is loaded into the Page object.

(Inherited from Control)
PreRender PreRender PreRender PreRender

Occurs after the Control object is loaded but prior to rendering.

(Inherited from Control)
Unload Unload Unload Unload

Occurs when the server control is unloaded from memory.

(Inherited from Control)

Extension Methods

FindDataSourceControl(Control) FindDataSourceControl(Control) FindDataSourceControl(Control) FindDataSourceControl(Control)

Returns the data source that is associated with the data control for the specified control.

FindFieldTemplate(Control, String) FindFieldTemplate(Control, String) FindFieldTemplate(Control, String) FindFieldTemplate(Control, String)

Returns the field template for the specified column in the specified control's naming container.

FindMetaTable(Control) FindMetaTable(Control) FindMetaTable(Control) FindMetaTable(Control)

Returns the metatable object for the containing data control.

GetDefaultValues(INamingContainer) GetDefaultValues(INamingContainer) GetDefaultValues(INamingContainer) GetDefaultValues(INamingContainer)

Gets the collection of the default values for the specified data control.

GetMetaTable(INamingContainer) GetMetaTable(INamingContainer) GetMetaTable(INamingContainer) GetMetaTable(INamingContainer)

Gets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable) SetMetaTable(INamingContainer, MetaTable) SetMetaTable(INamingContainer, MetaTable) SetMetaTable(INamingContainer, MetaTable)

Sets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>)

Sets the table metadata and default value mapping for the specified data control.

SetMetaTable(INamingContainer, MetaTable, Object) SetMetaTable(INamingContainer, MetaTable, Object) SetMetaTable(INamingContainer, MetaTable, Object) SetMetaTable(INamingContainer, MetaTable, Object)

Sets the table metadata and default value mapping for the specified data control.

TryGetMetaTable(INamingContainer, MetaTable) TryGetMetaTable(INamingContainer, MetaTable) TryGetMetaTable(INamingContainer, MetaTable) TryGetMetaTable(INamingContainer, MetaTable)

Determines whether table metadata is available.

EnableDynamicData(INamingContainer, Type) EnableDynamicData(INamingContainer, Type) EnableDynamicData(INamingContainer, Type) EnableDynamicData(INamingContainer, Type)

Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>)

Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, Object) EnableDynamicData(INamingContainer, Type, Object) EnableDynamicData(INamingContainer, Type, Object) EnableDynamicData(INamingContainer, Type, Object)

Enables Dynamic Data behavior for the specified data control.

Applies to

See also