Export (0) Print
Expand All

CatalogZoneBase Class

Serves as the base class for all zone controls that act as catalogs. Catalogs contain lists of WebPart controls that users can add to a Web page.

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

public ref class CatalogZoneBase abstract : public ToolZone, 
	IPostBackDataHandler
<asp:CatalogZoneBase />

The CatalogZoneBase type exposes the following members.

  NameDescription
Protected methodCatalogZoneBaseInitializes the class for use by an inherited class instance. This constructor can only be called by an inherited 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.
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.
Public propertyCatalogPartsGets a collection of all the CatalogPart controls contained in a CatalogZoneBase zone.
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.
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. (Overrides WebZone::EmptyZoneText.)
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. (Overrides WebZone::HeaderText.)
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. (Overrides ToolZone::InstructionText.)
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.
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.
Public propertySelectedPartLinkStyleGets an object that contains style attributes for the CatalogPart control that is currently selected in the zone.
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.
Public propertyShowCatalogIconsGets or sets a value that indicates whether server controls in the catalog display their associated icons in the catalog.
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.)
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 nullptr. (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. (Overrides ToolZone::Close().)
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.
Protected methodCreateCatalogPartsProvides a base method declaration that derived zones can override to handle the details of creating the CatalogPart controls contained in a zone.
Protected methodCreateChildControlsInfrastructure. Creates the set of child controls associated with a CatalogZoneBase zone. (Overrides Control::CreateChildControls().)
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.
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. (Overrides Control::LoadControlState(Object).)
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.
Protected methodLoadViewStateLoads previously saved state information for a zone. (Overrides ToolZone::LoadViewState(Object).)
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. (Overrides ToolZone::OnInit(EventArgs).)
Protected methodOnLoadRaises the Load event. (Inherited from Control.)
Protected methodOnPreRenderRaises the PreRender event and registers the page object so that it requires postbacks. (Overrides WebZone::OnPreRender(EventArgs).)
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. (Overrides ToolZone::RaisePostBackEvent(String).)
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. (Overrides CompositeControl::Render(HtmlTextWriter).)
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. (Overrides WebZone::RenderBody(HtmlTextWriter).)
Protected methodRenderCatalogPartLinksRenders the links to the individual CatalogPart controls in a CatalogZoneBase zone.
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. (Overrides ToolZone::RenderFooter(HtmlTextWriter).)
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. (Overrides ToolZone::RenderVerbs(HtmlTextWriter).)
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. (Overrides Control::SaveControlState().)
Protected methodSaveViewStateSaves any view-state changes that have occurred after a page was posted back to the server. (Overrides ToolZone::SaveViewState().)
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. (Overrides ToolZone::TrackViewState().)
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.
Explicit interface implemetationPrivate methodIPostBackDataHandler::RaisePostDataChangedEventFor a description of this member, see RaisePostDataChangedEvent.
Explicit interface implemetationPrivate methodIPostBackEventHandler::RaisePostBackEventInfrastructure. Implements the RaisePostBackEvent method. (Inherited from ToolZone.)
Top

The CatalogZoneBase class is a base class that inherits from the ToolZone class. It provides a base set of behaviors for derived zones.

The CatalogZoneBase class provides a unique user interface (UI) that enables users to add WebPart controls and other server controls to Web pages. Controls that derive from the CatalogZoneBase class, such as CatalogZone, are the controls actually placed on Web pages. They act as containers for other controls, known as CatalogPart controls, that create lists of server controls for users to add to a page. Zones that derive from the CatalogZoneBase class can appear only when the page is in catalog display mode.

NoteNote

A CatalogZoneBase zone can contain only CatalogPart controls, and conversely, CatalogPart controls can reside only in CatalogZoneBase zones.

The mechanism for adding server controls to a catalog is the following set of three controls that derive from the base CatalogPart class.

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 to a catalog so that the control can be added to a Web page. Definition files are XML file with a .WebPart file name extension that import settings for a control. The control must be present on the server before the definition file can be imported.

The CatalogZoneBase class has a number of properties that are useful for displaying catalogs of WebPart controls. The AddVerb property references the verb that adds a selected control from the catalog to the page, while the CloseVerb property references a verb that closes the catalog and returns the page's display mode to browse mode. The CatalogParts property references the collection of all CatalogPart controls in the zone. Several text-oriented properties, such as EmptyZoneText, HeaderText, and InstructionText, override base properties to provide default text appropriate for catalogs. The SelectTargetZoneText property contains the text alongside the drop-down list control that allows users to choose which zone a control will be added to.

Several other properties are included in the CatalogZoneBase class. The SelectedCatalogPartID property is a unique string identifier for the currently selected CatalogPart control. The ShowCatalogIcons property indicates whether to show the icons that can be associated with controls by setting the CatalogIconImageUrl property on a WebPart control.

The PartLinkStyle property contains style attributes for the links to the CatalogPart controls that are not currently selected in the zone. In contrast, the SelectedPartLinkStyle property contains style attributes for a link to the CatalogPart control that the user has currently selected in the zone.

In addition to the properties, there are also some methods in the CatalogZoneBase class, in addition to the standard event-handling and rendering methods inherited from other base controls, which are uniquely designed for the purpose of handling catalogs of controls. The CreateCatalogPartChrome method creates the chrome (peripheral UI elements such as a border, verbs, icons, and a title) that surrounds each CatalogPart control in the zone, and also handles the rendering for the controls. The CreateCatalogParts method is an abstract method; derived classes override it to create instances of all the CatalogPart controls contained in the zone. The InvalidateCatalogParts method can be called by a derived class if the collection of CatalogPart controls in the zone changes for some programmatic reason, and the derived class needs to recreate the collection. The LoadPostData method loads the previously existing state for the check boxes next to the WebPart controls in the catalog, whenever the page is posted back to the server; conversely, the SaveControlState method saves the state of the check boxes. Finally, the RenderCatalogPartLinks method provides all the rendering for the links to each CatalogPart control contained in the zone.

Notes to Inheritors

If you want to develop a custom zone for hosting CatalogPart controls, you must determine whether you want to provide zone template support. A zone template is created by types that implement the ITemplate interface, and is necessary if you want to enable page developers using your custom zone to reference CatalogPart controls within your zone in the declarative markup of a Web page. If you need zone template support, you should inherit from the CatalogZone class. In contrast, if your custom zone and its CatalogPart controls are going to be self-contained, and they will be created programmatically without any options for page developers to specify controls declaratively in a zone template, then you can inherit directly from the CatalogZoneBase class. If you inherit from the CatalogZoneBase class, you must override the CreateCatalogParts method, and add the WebPart or other server controls you want in your catalog to a CatalogPartCollection object.

The following code example demonstrates several declarative and programmatic uses of the CatalogZoneBase class. Because the class is abstract, the code examples use the derived CatalogZone class that ships with the Web Parts control set, demonstrating the properties and methods that it inherits from the CatalogZoneBase class.

The code example has four parts:

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

  • A Web page that contains a reference to a CatalogZone control, and some code that demonstrates usage of some key CatalogZoneBase class members.

  • A custom WebPart control that is added to the custom CatalogZone control.

  • A description of how the example works in a browser.

The first part of this code example is the user control that enables you to change display modes on the 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.

No code example is currently available or this language may not be supported.

The second part of the code example is a Web page that contains a declarative reference to a CatalogZone control. Near the top of the page are two Register directives--one for the user control, and one for the custom WebPart control. Notice that below the <asp:WebPartZone> element is an <asp: CatalogZone> element that contains declarative references to the custom WebPart control, and to an ASP.NET Calendar control. The zone also has a variety of tags and properties set to determine its appearance and behavior. Between the <script> tags in the page is a variety of event-handling code, most of which demonstrates the various programmatic uses of the CatalogZoneBase members.

No code example is currently available or this language may not be supported.

The third part of the code example is the custom WebPart control named TextDisplayWebPart. It is declared within the zone, and an end user can add it from the catalog to the page. For the code example to run, you must compile this source code. You can compile it explicitly and put the resulting assembly in your Web site's Bin folder or the global assembly cache. Alternatively, you can put the source code in your site's App_Code folder, where it will be dynamically compiled at run time. For a demonstration of both methods of compiling, see Walkthrough: Developing and Using a Custom Web Server Control.

No code example is currently available or this language may not be supported.

Note that for the code example to work, there is a setting you must add in the Web.config file to enable exporting Web Parts description files. Ensure that you have a Web.config file in the same directory as the Web page for this code example. Within the <system.web> section, make sure there is a <webParts> element with an enableExport attribute set to true, as in the following markup.

<webParts enableExport="true">

...

</webParts>

When you load the page in a browser, you can select Catalog from the drop-down list box to switch to catalog display mode. When the catalog is visible, you can see the two server controls that can be added from the catalog to the page, and you can also note in the UI the effects of the declarative and programmatic uses of the CatalogZoneBase class members.

.NET Framework

Supported in: 4.5.3, 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