Export (0) Print
Expand All

CatalogZone Class

Serves as the primary control in the Web Parts control set for hosting CatalogPart controls on a Web page.

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

public class CatalogZone : CatalogZoneBase
<asp:CatalogZone />

The CatalogZone type exposes the following members.

  NameDescription
Public methodCatalogZoneInitializes a new instance of the CatalogZone class.
Top

  NameDescription
Public propertyAccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected propertyAdapterGets the browser-specific adapter for the control. (Inherited from Control.)
Public propertyAddVerbGets a reference to a WebPartVerb object that enables end users to add controls from a catalog to a Web Parts page. (Inherited from CatalogZoneBase.)
Public propertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public propertyAssociatedDisplayModesGets the collection of WebPartDisplayMode objects that are associated with a particular ToolZone zone. (Inherited from ToolZone.)
Public propertyAttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public propertyBackColorGets or sets the background color of the Web server control. (Inherited from WebControl.)
Public propertyBackImageUrlGets or sets the URL to a background image for a zone. (Inherited from WebZone.)
Public propertyBindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public propertyBorderColorGets or sets the border color of the Web control. (Inherited from WebControl.)
Public propertyBorderStyleGets or sets the border style of the Web server control. (Inherited from WebControl.)
Public propertyBorderWidthGets or sets the border width of the Web server control. (Inherited from WebControl.)
Public propertyCatalogPartChromeGets a reference to the instance of the CatalogPartChrome class associated with the CatalogZoneBase zone. (Inherited from CatalogZoneBase.)
Public propertyCatalogPartsGets a collection of all the CatalogPart controls contained in a CatalogZoneBase zone. (Inherited from CatalogZoneBase.)
Protected propertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public propertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public propertyClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected propertyClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Public propertyCloseVerbGets a reference to a WebPartVerb object that enables end users to close the catalog user interface (UI) and return the page to normal browse mode. (Inherited from CatalogZoneBase.)
Protected propertyContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public propertyControlsGets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl.)
Public propertyControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyControlStyleCreatedGets 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.)
Public propertyCssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public propertyDataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public propertyDataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Protected propertyDesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Protected propertyDisplayGets a value that indicates whether a ToolZone control is currently displayed. (Inherited from ToolZone.)
Public propertyEditUIStyleGets the style attributes for the editable controls contained in a ToolZone control. (Inherited from ToolZone.)
Public propertyEmptyZoneTextGets or sets a message that appears when a zone contains no controls. (Inherited from CatalogZoneBase.)
Public propertyEmptyZoneTextStyleGets the style attributes for the placeholder text in an empty zone. (Inherited from WebZone.)
Public propertyEnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public propertyEnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public propertyEnableViewStateGets 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.)
Public propertyErrorStyleGets the style attributes for rendering the error message that is displayed if a WebPart control cannot be loaded or created. (Inherited from WebZone.)
Protected propertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public propertyFontGets the font properties associated with the Web server control. (Inherited from WebControl.)
Public propertyFooterStyleGets the style attributes for the contents of a zone's footer area. (Inherited from WebZone.)
Public propertyForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public propertyHasAttributesGets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected propertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Protected propertyHasFooterGets a value indicating whether a zone has a footer area. (Inherited from WebZone.)
Protected propertyHasHeaderGets a value indicating whether a zone has a header area. (Inherited from WebZone.)
Public propertyHeaderCloseVerbGets a reference to the WebPartVerb object in the header of a ToolZone control that is used to close the control. (Inherited from ToolZone.)
Public propertyHeaderStyleGets the style attributes for the contents of a zone's header area. (Inherited from WebZone.)
Public propertyHeaderTextGets or sets the text for the header area of a zone. (Inherited from CatalogZoneBase.)
Public propertyHeaderVerbStyleGets the style attributes for all header verbs displayed in a ToolZone control. (Inherited from ToolZone.)
Public propertyHeightGets or sets the height of the Web server control. (Inherited from WebControl.)
Public propertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected propertyIdSeparatorInfrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Public propertyInstructionTextGets or sets the text in a zone that provides directions for end users. (Inherited from CatalogZoneBase.)
Public propertyInstructionTextStyleGets the style attributes for the instruction text that appears at the top of a ToolZone control. (Inherited from ToolZone.)
Protected propertyIsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected propertyIsEnabledGets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected propertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected propertyIsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public propertyLabelStyleGets 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.)
Protected propertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public propertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value. (Inherited from Control.)
Public propertyPaddingGets or sets the cell padding attributes on the table that contains the WebPart controls in a zone. (Inherited from WebZone.)
Public propertyPageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public propertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public propertyPartChromePaddingGets or sets the distance between the contents of a WebPart control and the border of the control. (Inherited from WebZone.)
Public propertyPartChromeStyleGets style characteristics that apply to the borders of Web Parts controls contained by a zone. (Inherited from WebZone.)
Public propertyPartChromeTypeGets or sets the type of border that frames Web Parts controls contained by a zone. (Inherited from WebZone.)
Public propertyPartLinkStyleGets an object that contains style attributes for the CatalogPart controls that are not currently selected in the zone. (Inherited from CatalogZoneBase.)
Public propertyPartStyleGets style characteristics that apply to the border and contents of each Web Parts control contained by a zone. (Inherited from WebZone.)
Public propertyPartTitleStyleGets style attributes for the title bar content for each Web Parts control contained by a zone. (Inherited from WebZone.)
Protected propertyRenderClientScriptGets a value that indicates whether to render client script on a Web Parts page. (Inherited from WebZone.)
Public propertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public propertySelectedCatalogPartIDGets or sets a string as an identifier for the currently selected CatalogPart control in a zone. (Inherited from CatalogZoneBase.)
Public propertySelectedPartLinkStyleGets an object that contains style attributes for the CatalogPart control that is currently selected in the zone. (Inherited from CatalogZoneBase.)
Public propertySelectTargetZoneTextGets or sets the text alongside the control in the catalog user interface (UI) that allows users to choose which zone to add their selected controls to. (Inherited from CatalogZoneBase.)
Public propertyShowCatalogIconsGets or sets a value that indicates whether server controls in the catalog display their associated icons in the catalog. (Inherited from CatalogZoneBase.)
Public propertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public propertySkinIDGets or sets the skin to apply to the control. (Inherited from WebControl.)
Public propertyStyleGets 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.)
Public propertySupportsDisabledAttributeGets 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.)
Public propertyTabIndexGets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected propertyTagKeyGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebZone.)
Protected propertyTagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public propertyTemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public propertyToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public propertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public propertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.)
Public propertyVerbButtonTypeGets or sets what kind of button is used to represent verbs in a zone. (Inherited from WebZone.)
Public propertyVerbStyleGets the style attributes for the user interface (UI) verbs associated with Web Parts controls in a zone. (Inherited from WebZone.)
Protected propertyViewStateGets 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.)
Protected propertyViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public propertyViewStateModeGets or sets the view-state mode of this control. (Inherited from Control.)
Public propertyVisibleGets or sets a value that indicates whether a server control is rendered as a user interface (UI) element on the page. (Inherited from ToolZone.)
Protected propertyWebPartManagerGets a reference to the WebPartManager control associated with a WebZone control instance on a Web Parts page. (Inherited from WebZone.)
Public propertyWidthGets or sets the width of the Web server control. (Inherited from WebControl.)
Public propertyZoneTemplateGets or sets a template to contain child controls within a CatalogZone control in page persistence format.
Top

  NameDescription
Protected methodAddAttributesToRenderAdds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodAddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected methodAddParsedSubObjectNotifies 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.)
Public methodApplyStyleCopies 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.)
Public methodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected methodBeginRenderTracingBegins design-time tracing of rendering data. (Inherited from Control.)
Protected methodBuildProfileTreeInfrastructure. 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.)
Protected methodClearCachedClientIDInfrastructure. Sets the cached ClientID value to null. (Inherited from Control.)
Protected methodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected methodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearEffectiveClientIDModeInfrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Protected methodCloseSwitches the Web page from catalog display mode to normal browse mode. (Inherited from CatalogZoneBase.)
Public methodCopyBaseAttributesCopies 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.)
Protected methodCreateCatalogPartChromeCreates an instance of a CatalogPartChrome object used to render the peripheral user interface (UI) elements for CatalogPart controls in a zone. (Inherited from CatalogZoneBase.)
Protected methodCreateCatalogPartsCreates an instance of each CatalogPart type that is declared in the zone. (Overrides CatalogZoneBase.CreateCatalogParts().)
Protected methodCreateChildControlsInfrastructure. Creates the set of child controls associated with a CatalogZoneBase zone. (Inherited from CatalogZoneBase.)
Protected methodCreateControlCollectionCreates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected methodCreateControlStyleCreates 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.)
Public methodDataBind()Binds a data source to the CompositeControl and all its child controls. (Inherited from CompositeControl.)
Protected methodDataBind(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.)
Protected methodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from Control.)
Public methodDisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected methodEndRenderTracingEnds design-time tracing of rendering data. (Inherited from Control.)
Protected methodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected methodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected methodFindControl(String, Int32)Infrastructure. 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.)
Public methodFocusSets input focus to a control. (Inherited from Control.)
Protected methodGetDesignModeStateInfrastructure. Gets design-time data for a control. (Inherited from Control.)
Public methodGetEffectiveChromeTypeReturns 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.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public methodHasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected methodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected methodInvalidateCatalogPartsDestroys the collection of CatalogPart controls associated with a CatalogZoneBase zone. (Inherited from CatalogZoneBase.)
Protected methodIsLiteralContentInfrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected methodLoadControlStateLoads the state from a previous page request for control properties that should persist across postbacks even when view state is disabled on the control. (Inherited from CatalogZoneBase.)
Protected methodLoadPostDataInfrastructure. Processes the state of the check boxes that correspond to the WebPart controls in the catalog, when the page is posted back to the server. (Inherited from CatalogZoneBase.)
Protected methodLoadViewStateLoads previously saved state information for a zone. (Inherited from CatalogZoneBase.)
Protected methodMapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMergeStyleCopies 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.)
Protected methodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
Protected methodOnDataBindingRaises the DataBinding event. (Inherited from Control.)
Protected methodOnDisplayModeChangedProvides a base method declaration that derived ToolZone controls can override to handle the details of changing page display modes for a specialized zone. (Inherited from ToolZone.)
Protected methodOnInitRegisters the page object so that the page requires control state. (Inherited from CatalogZoneBase.)
Protected methodOnLoadRaises the Load event. (Inherited from Control.)
Protected methodOnPreRenderRaises the PreRender event and registers the page object so that it requires postbacks. (Inherited from CatalogZoneBase.)
Protected methodOnSelectedWebPartChangedProvides 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. (Inherited from ToolZone.)
Protected methodOnUnloadRaises the Unload event. (Inherited from Control.)
Protected methodOpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected methodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected methodRaisePostBackEventCarries out the actions associated with one of the zone verbs, or raises an event that posts back to the server. (Inherited from CatalogZoneBase.)
Protected methodRecreateChildControlsRecreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl.)
Protected methodRemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected methodRenderRenders the zone to the specified HtmlTextWriter object. (Inherited from CatalogZoneBase.)
Public methodRenderBeginTagRenders the opening HTML tag of the zone control to the specified HtmlTextWriter object. (Inherited from WebZone.)
Protected methodRenderBodyOverrides the base method to render the body area of a zone derived from the CatalogZoneBase class. (Inherited from CatalogZoneBase.)
Protected methodRenderCatalogPartLinksRenders the links to the individual CatalogPart controls in a CatalogZoneBase zone. (Inherited from CatalogZoneBase.)
Protected methodRenderChildrenOutputs 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.)
Protected methodRenderContentsRenders the entire contents of a zone control between the beginning and ending tags to the specified HtmlTextWriter object. (Inherited from WebZone.)
Public methodRenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Public methodRenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodRenderFooterRenders the footer area for a CatalogZoneBase zone. (Inherited from CatalogZoneBase.)
Protected methodRenderHeaderOverrides the base method to provide specialized rendering for the header area required by ToolZone controls. (Inherited from ToolZone.)
Protected methodRenderVerbRenders an individual verb with a ToolZone control. (Inherited from ToolZone.)
Protected methodRenderVerbsRenders the verbs in the footer area of a CatalogZoneBase zone. (Inherited from CatalogZoneBase.)
Protected methodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public methodResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public methodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected methodSaveControlStateSaves any changes in a CatalogZoneBase control's state that occur after the Web page is posted back to the server. (Inherited from CatalogZoneBase.)
Protected methodSaveViewStateSaves any view-state changes that have occurred after a page was posted back to the server. (Inherited from CatalogZoneBase.)
Protected methodSetDesignModeStateSets design-time data for a control. (Inherited from Control.)
Public methodSetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public methodSetTraceData(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.)
Public methodSetTraceData(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.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTrackViewStateTracks changes to a zone control's view state. (Inherited from CatalogZoneBase.)
Top

  NameDescription
Public eventDataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
Public eventDisposedOccurs 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.)
Public eventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public eventLoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public eventPreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public eventUnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Top

  NameDescription
Public Extension MethodFindDataSourceControlReturns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension MethodFindFieldTemplateReturns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension MethodFindMetaTableReturns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAttributeAccessor.GetAttributeInfrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodIAttributeAccessor.SetAttributeSets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodICompositeControlDesignerAccessor.RecreateChildControlsEnables a designer to recreate the composite control's collection of child controls in the design-time environment. (Inherited from CompositeControl.)
Explicit interface implemetationPrivate propertyIControlBuilderAccessor.ControlBuilderFor a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.GetDesignModeStateFor a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.SetDesignModeStateFor a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.SetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlDesignerAccessor.UserDataFor a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor.DataBindingsFor a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor.HasDataBindingsFor a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor.ExpressionsFor a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor.HasExpressionsFor a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)
Explicit interface implemetationPrivate methodIParserAccessor.AddParsedSubObjectFor a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)
Explicit interface implemetationPrivate methodIPostBackDataHandler.LoadPostDataImplements the IPostBackDataHandler.LoadPostData method by calling the LoadPostData method of the CatalogZoneBase class. (Inherited from CatalogZoneBase.)
Explicit interface implemetationPrivate methodIPostBackDataHandler.RaisePostDataChangedEventFor a description of this member, see RaisePostDataChangedEvent. (Inherited from CatalogZoneBase.)
Explicit interface implemetationPrivate methodIPostBackEventHandler.RaisePostBackEventInfrastructure. Implements the RaisePostBackEvent method. (Inherited from ToolZone.)
Top

Within the Web Parts control set, a zone is a region on a Web page that contains Web Parts controls. A Web Parts zone is created by a zone control, which is a type of CompositeControl designed to contain other 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 base WebZone class, and Web Parts Control Set Overview.

A key feature of Web Parts controls is that they allow 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 the ability to add WebPart controls or other server controls to a Web Parts page. The CatalogZone control provides a list or catalog of controls that users can add to a page.

The CatalogZone control is one of the fundamental controls in the Web Parts control set. It derives from the CatalogZoneBase class, and most of its behavior is inherited from that class. The CatalogZone class essentially adds to the base class a zone template, which is an implementation of the ITemplate interface. The zone template enables developers to declaratively add CatalogPart controls to a zone in the page persistence format.

Important noteImportant

A CatalogZone zone can contain only CatalogPart controls, and conversely, CatalogPart controls can reside only in zones that derive from the CatalogZoneBase class, such as CatalogZone.

A CatalogZone control becomes visible only when a user switches a Web page to catalog display mode (CatalogDisplayMode). A catalog can contain several types of CatalogPart controls. Each CatalogPart control is a type of container that contains the server controls users can add to the page. The CatalogPart controls differ according to where the server controls they contain are coming from. The following table summarizes the CatalogPart controls provided with the Web Parts control set and, for each control, what kind of server controls it contains.

Control

Description

PageCatalogPart

Maintains references to controls that have been closed on a page. These controls can be reopened (added back to the page) by users.

DeclarativeCatalogPart

Contains references to controls that are declared in a Web Parts catalog in the markup of a Web page. These controls can be added to a Web page by users.

ImportCatalogPart

Provides the UI for a user to upload a definition file (an XML file with a .WebPart extension and a specified format that contains state information) for a control to a catalog, so that the control can be added to a Web page.

Because the CatalogZone class adds only a zone template to the behavior of its base class, it has few members. The CatalogZone constructor is a default constructor; with it, you can initialize a new instance of the CatalogZone class. The ZoneTemplate property gets or sets a reference to the ITemplate object that contains the controls for the zone. The CreateCatalogParts method is critical. It overrides the base method to create the collection of all CatalogPart controls contained within the zone template.

NoteNote

The buttons in the CatalogZone 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 CatalogZone 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

You can create custom CatalogZone classes if you want more control over the rendering and behavior of the catalog UI. If you do not need to provide users of your control with the ability to add CatalogPart controls declaratively, then you can inherit directly from the CatalogZoneBase class. If you do want to enable controls to be added declaratively, the simples approach is to inherit from the CatalogZone class, because it provides the essential zone template.

If you inherit from the CatalogZone class, you can override the CreateCatalogParts method and use the method to add custom CatalogPart controls to a CatalogPartCollection, if you want greater programmatic control over adding custom CatalogPart controls to your zone.

TopicLocation
How to: Enable Users to Import Web Parts Control SettingsBuilding ASP .NET Web Applications
How to: Enable Users to Import Web Parts Control SettingsBuilding ASP .NET Web Applications
How to: Provide Optional Web Parts ControlsBuilding ASP .NET Web Applications
How to: Export Web Parts Control SettingsBuilding ASP .NET Web Applications
How to: Export Web Parts Control SettingsBuilding ASP .NET Web Applications
How to: Provide Optional Web Parts ControlsBuilding ASP .NET Web Applications

The following code example demonstrates declarative and programmatic use of the CatalogZone control. The code example has four parts:

  • A user control that enables you to change display modes on the Web page.

  • A file with the source code for a custom CatalogZone control, and a custom WebPart control that is imported by the catalog and added to the Web page.

  • A Web page that declares the user control, and the custom CatalogZone control.

  • An explanation of how to run the example.

The first part of this code example is the user control that enables users to change display modes on a Web page. For 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, modeName);
        DisplayModeDropdown.Items.Add(item);
      }
    }

    // If shared scope is allowed for this user, display the scope-switching
    // UI and select the appropriate radio button for the current user scope.
    if (_manager.Personalization.CanEnterSharedScope)
    {
      Panel2.Visible = true;
      if (_manager.Personalization.Scope == PersonalizationScope.User)
        RadioButton1.Checked = true;
      else
        RadioButton2.Checked = true;
    }

  }

  // 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;
  }

  // Set the selected item equal to the current display mode.
  void Page_PreRender(object sender, EventArgs e)
  {
    ListItemCollection items = DisplayModeDropdown.Items;
    int selectedIndex = 
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name));
    DisplayModeDropdown.SelectedIndex = selectedIndex;
  }

  // Reset all of a user's personalization data for the page.
  protected void LinkButton1_Click(object sender, EventArgs e)
  {
    _manager.Personalization.ResetPersonalizationState();
  }

  // If not in User personalization scope, toggle into it.
  protected void RadioButton1_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.Scope == PersonalizationScope.Shared)
      _manager.Personalization.ToggleScope();
  }

  // If not in Shared scope, and if user is allowed, toggle the scope.
  protected void RadioButton2_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.CanEnterSharedScope && 
        _manager.Personalization.Scope == PersonalizationScope.User)
      _manager.Personalization.ToggleScope();
  }
</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text="&nbsp;Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

The second part of the code example contains the code for the custom CatalogZone and WebPart controls. The code for the CatalogZone control demonstrates how to inherit from the CatalogZone class and customize its properties by setting some default property values in the constructor. The source code also demonstrates how to create a custom WebPart class named TextDisplayWebPart. This is the control associated with the .WebPart description file that you will import as part of this code example. After you import the description file by using the ImportCatalogPart control on the Web page, you'll be able to add the TextDisplayWebPart control to the page, fully pre-configured as specified in the description file.

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, so if you want to run the example this way, name the source code file and add it to an App_Code subfolder of your Web application's root directory. 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
{
  // Create a customized CatalogZone control by setting  
  // some properties in the constructor.
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class MyCatalogZone : CatalogZone
  {
    public MyCatalogZone()
    {
      this.HeaderText = "My Company Catalog";
      this.HeaderCloseVerb.Text = "Close Catalog";
      this.CloseVerb.Text = "Close Catalog";
    }
  }


  // Create a custom WebPart control to add to a WebPartZone.
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class TextDisplayWebPart : WebPart
  {
    private String _contentText = null;
    TextBox input;
    Label DisplayContent;
    Literal lineBreak;

    [Personalizable(), WebBrowsable]
    public String ContentText
    {
      get { return _contentText; }
      set { _contentText = value; }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      DisplayContent.BackColor = Color.LightBlue;
      DisplayContent.Text = this.ContentText;
      this.Controls.Add(DisplayContent);

      lineBreak = new Literal();
      lineBreak.Text = @"<br />";
      Controls.Add(lineBreak);

      input = new TextBox();
      this.Controls.Add(input);
      Button update = new Button();
      update.Text = "Set Label Content";
      update.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(update);

    }

    private void submit_Click(object sender, EventArgs e)
    {
      // Update the label string. 
      if (input.Text != String.Empty)
      {
        _contentText = input.Text + @"<br />";
        input.Text = String.Empty;
        DisplayContent.Text = this.ContentText;
      }
    }
  }

}

The third part of the code example is the Web page that contains the controls. It contains a Register directive for the user control, and another for the source file with the custom controls. Note that in the second directive, it does not name the assembly, because the example does not use an assembly, it uses dynamic compilation with the source code placed in the App_Code subfolder. The Web page declares a WebPartZone control, and within its child <zonetemplate> element, it declares a BulletedList control. While this is a standard ASP.NET control, it will have full Web Parts functionality at run time, because the WebPartManager control wraps any server control placed in a WebPartZone with a GenericWebPart object, so that other server controls can participate in Web Parts applications. Also declared in this zone is the custom WebPart control named TextDisplayWebPart. Notice that this control has an attribute of ExportMode="All" declared on it. This enables you to export a .WebPart description file that contains the property values of the control, which can be imported by other users to add the pre-configured control to other Web pages.

NoteNote

To enable users of a Web Parts application to export a description file for WebPart controls, you must also enable the export feature in the Web application by adding an enableExport="true" attribute to the <webParts> element (which is a child of the <system.web> element) in the Web.config file. Export is disabled by default, so if you not yet enabled export for your application, edit the Web.config file and do it now.

The Web page also declares the custom CatalogZone control and, within it, a <zonetemplate> element that contains an ImportCatalogPart control. The user will use this control at run time to import the .WebPart description file for the custom WebPart control.

<%@ Page Language="C#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" 
  Src="DisplayModeMenuCS.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">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" />
    <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>
        <aspsample:textdisplaywebpart id="wp1" runat="server" 
           Title="My Text Display WebPart" />
      </ZoneTemplate>
    </asp:WebPartZone>
    <aspSample:MyCatalogZone ID="CatalogZone1" runat="server">
      <ZoneTemplate>
        <asp:ImportCatalogPart id="ImportCatalogPart1" 
          runat="server" />
      </ZoneTemplate>
    </aspSample:MyCatalogZone>
  </form>
</body>
</html>

Now run the code example. Load the Web page in a browser. The first step is to export a .WebPart description file for the TextDisplayWebPart control. Click the verbs menu on the custom control (represented by the downward arrow in the title bar), and click Export. Follow the instructions to save a description file for the control. Open the .WebPart description file in an editor, and edit the value of the title property text. Find the <property> element that has the attribute name="Title", and edit the title text that is contained between the opening and closing <property> tags. Now close the Web page, and edit the page source in an editor. Delete the <aspSample:TextDisplayWebPart> control declaration element, then save and close the file.

Load the Web page again in a browser. The TextDisplayWebPart control should not appear, because you removed it. Use the Display Mode drop-down list control and select Catalog to switch the page to catalog mode. Notice that the custom CatalogZone control appears, along with the ImportCatalogPart control. Click the Browse button to locate the .WebPart description file that you exported for the TextDisplayWebPart control. You can click Upload, select the check box next to the imported control, and click Add to add it to the page. Click Close Catalog to return the page to normal browse mode. The imported control should now appear in the page, and the title that appears in the title bar of the control should be the title text you added to the .WebPart description file.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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