CatalogZone Class

.NET Framework (current version)

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)

Inheritance Hierarchy

System::Object
System.Web.UI::Control
System.Web.UI.WebControls::WebControl
System.Web.UI.WebControls::CompositeControl
System.Web.UI.WebControls.WebParts::WebZone
System.Web.UI.WebControls.WebParts::ToolZone
System.Web.UI.WebControls.WebParts::CatalogZoneBase
System.Web.UI.WebControls.WebParts::CatalogZone

Syntax

C++

public ref class CatalogZone : CatalogZoneBase

Constructors

	Name	Description
	CatalogZone()	Initializes a new instance of the CatalogZone class.

Properties

	Name	Description
	AccessKey	Gets or sets the access key that allows you to quickly navigate to the Web server control.(Inherited from WebControl.)
	Adapter	Gets the browser-specific adapter for the control.(Inherited from Control.)
	AddVerb	Gets a reference to a WebPartVerb object that enables end users to add controls from a catalog to a Web Parts page.(Inherited from CatalogZoneBase.)
	AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.)
	AssociatedDisplayModes	Gets the collection of WebPartDisplayMode objects that are associated with a particular ToolZone zone.(Inherited from ToolZone.)
	Attributes	Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.(Inherited from WebControl.)
	BackColor	Gets or sets the background color of the Web server control.(Inherited from WebControl.)
	BackImageUrl	Gets or sets the URL to a background image for a zone.(Inherited from WebZone.)
	BindingContainer	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the control that contains this control's data binding.(Inherited from Control.)
	BorderColor	Gets or sets the border color of the Web control.(Inherited from WebControl.)
	BorderStyle	Gets or sets the border style of the Web server control.(Inherited from WebControl.)
	BorderWidth	Gets or sets the border width of the Web server control.(Inherited from WebControl.)
	CatalogPartChrome	Gets a reference to the instance of the CatalogPartChrome class associated with the CatalogZoneBase zone. (Inherited from CatalogZoneBase.)
	CatalogParts	Gets a collection of all the CatalogPart controls contained in a CatalogZoneBase zone.(Inherited from CatalogZoneBase.)
	ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created.(Inherited from Control.)
	ClientID	Gets the control ID for HTML markup that is generated by ASP.NET.(Inherited from Control.)
	ClientIDMode	Gets or sets the algorithm that is used to generate the value of the ClientID property.(Inherited from Control.)
	ClientIDSeparator	Gets a character value representing the separator character used in the ClientID property.(Inherited from Control.)
	CloseVerb	Gets 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.)
	Context	Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.)
	Controls	Gets a ControlCollection object that represents the child controls in a CompositeControl.(Inherited from CompositeControl.)
	ControlStyle	Gets the style of the Web server control. This property is used primarily by control developers.(Inherited from WebControl.)
	ControlStyleCreated	Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.(Inherited from WebControl.)
	CssClass	Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.(Inherited from WebControl.)
	DataItemContainer	Gets a reference to the naming container if the naming container implements IDataItemContainer.(Inherited from Control.)
	DataKeysContainer	Gets a reference to the naming container if the naming container implements IDataKeysControl.(Inherited from Control.)
	DesignMode	Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.)
	Display	Gets a value that indicates whether a ToolZone control is currently displayed.(Inherited from ToolZone.)
	EditUIStyle	Gets the style attributes for the editable controls contained in a ToolZone control.(Inherited from ToolZone.)
	EmptyZoneText	Gets or sets a message that appears when a zone contains no controls.(Inherited from CatalogZoneBase.)
	EmptyZoneTextStyle	Gets the style attributes for the placeholder text in an empty zone.(Inherited from WebZone.)
	Enabled	Gets or sets a value indicating whether the Web server control is enabled.(Inherited from WebControl.)
	EnableTheming	Gets or sets a value indicating whether themes apply to this control.(Inherited from WebControl.)
	EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.(Inherited from Control.)
	ErrorStyle	Gets the style attributes for rendering the error message that is displayed if a WebPart control cannot be loaded or created.(Inherited from WebZone.)
	Events	Gets a list of event handler delegates for the control. This property is read-only.(Inherited from Control.)
	Font	Gets the font properties associated with the Web server control.(Inherited from WebControl.)
	FooterStyle	Gets the style attributes for the contents of a zone's footer area.(Inherited from WebZone.)
	ForeColor	Gets or sets the foreground color (typically the color of the text) of the Web server control.(Inherited from WebControl.)
	HasAttributes	Gets a value indicating whether the control has attributes set.(Inherited from WebControl.)
	HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings.(Inherited from Control.)
	HasFooter	Gets a value indicating whether a zone has a footer area.(Inherited from WebZone.)
	HasHeader	Gets a value indicating whether a zone has a header area.(Inherited from WebZone.)
	HeaderCloseVerb	Gets a reference to the WebPartVerb object in the header of a ToolZone control that is used to close the control.(Inherited from ToolZone.)
	HeaderStyle	Gets the style attributes for the contents of a zone's header area.(Inherited from WebZone.)
	HeaderText	Gets or sets the text for the header area of a zone.(Inherited from CatalogZoneBase.)
	HeaderVerbStyle	Gets the style attributes for all header verbs displayed in a ToolZone control.(Inherited from ToolZone.)
	Height	Gets or sets the height of the Web server control.(Inherited from WebControl.)
	ID	Gets or sets the programmatic identifier assigned to the server control.(Inherited from Control.)
	IdSeparator	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the character used to separate control identifiers.(Inherited from Control.)
	InstructionText	Gets or sets the text in a zone that provides directions for end users.(Inherited from CatalogZoneBase.)
	InstructionTextStyle	Gets the style attributes for the instruction text that appears at the top of a ToolZone control.(Inherited from ToolZone.)
	IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state.(Inherited from Control.)
	IsEnabled	Gets a value indicating whether the control is enabled.(Inherited from WebControl.)
	IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state.(Inherited from Control.)
	IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control.(Inherited from Control.)
	LabelStyle	Gets the style attributes for the contents of the labels that appear alongside the editing controls within a ToolZone control. The derived ToolZone controls, such as CatalogZone and EditorZone, apply the styles to the labels.(Inherited from ToolZone.)
	LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
	NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control::ID property value.(Inherited from Control.)
	Padding	Gets or sets the cell padding attributes on the table that contains the WebPart controls in a zone.(Inherited from WebZone.)
	Page	Gets a reference to the Page instance that contains the server control.(Inherited from Control.)
	Parent	Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.)
	PartChromePadding	Gets or sets the distance between the contents of a WebPart control and the border of the control.(Inherited from WebZone.)
	PartChromeStyle	Gets style characteristics that apply to the borders of Web Parts controls contained by a zone.(Inherited from WebZone.)
	PartChromeType	Gets or sets the type of border that frames Web Parts controls contained by a zone.(Inherited from WebZone.)
	PartLinkStyle	Gets an object that contains style attributes for the CatalogPart controls that are not currently selected in the zone.(Inherited from CatalogZoneBase.)
	PartStyle	Gets style characteristics that apply to the border and contents of each Web Parts control contained by a zone.(Inherited from WebZone.)
	PartTitleStyle	Gets style attributes for the title bar content for each Web Parts control contained by a zone.(Inherited from WebZone.)
	RenderClientScript	Gets a value that indicates whether to render client script on a Web Parts page.(Inherited from WebZone.)
	RenderingCompatibility	Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.(Inherited from Control.)
	SelectedCatalogPartID	Gets or sets a string as an identifier for the currently selected CatalogPart control in a zone.(Inherited from CatalogZoneBase.)
	SelectedPartLinkStyle	Gets an object that contains style attributes for the CatalogPart control that is currently selected in the zone.(Inherited from CatalogZoneBase.)
	SelectTargetZoneText	Gets 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.)
	ShowCatalogIcons	Gets or sets a value that indicates whether server controls in the catalog display their associated icons in the catalog.(Inherited from CatalogZoneBase.)
	Site	Gets information about the container that hosts the current control when rendered on a design surface.(Inherited from Control.)
	SkinID	Gets or sets the skin to apply to the control.(Inherited from WebControl.)
	Style	Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.(Inherited from WebControl.)
	SupportsDisabledAttribute	Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.(Inherited from CompositeControl.)
	TabIndex	Gets or sets the tab index of the Web server control.(Inherited from WebControl.)
	TagKey	Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.(Inherited from WebZone.)
	TagName	Gets the name of the control tag. This property is used primarily by control developers.(Inherited from WebControl.)
	TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control.)
	TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control.(Inherited from Control.)
	ToolTip	Gets or sets the text displayed when the mouse pointer hovers over the Web server control.(Inherited from WebControl.)
	UniqueID	Gets the unique, hierarchically qualified identifier for the server control.(Inherited from Control.)
	ValidateRequestMode	Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.(Inherited from Control.)
	VerbButtonType	Gets or sets what kind of button is used to represent verbs in a zone.(Inherited from WebZone.)
	VerbStyle	Gets the style attributes for the user interface (UI) verbs associated with Web Parts controls in a zone.(Inherited from WebZone.)
	ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.(Inherited from Control.)
	ViewStateIgnoresCase	Gets a value that indicates whether the StateBag object is case-insensitive.(Inherited from Control.)
	ViewStateMode	Gets or sets the view-state mode of this control.(Inherited from Control.)
	Visible	Gets or sets a value that indicates whether a server control is rendered as a user interface (UI) element on the page. (Inherited from ToolZone.)
	WebPartManager	Gets a reference to the WebPartManager control associated with a WebZone control instance on a Web Parts page.(Inherited from WebZone.)
	Width	Gets or sets the width of the Web server control.(Inherited from WebControl.)
	ZoneTemplate	Gets or sets a template to contain child controls within a CatalogZone control in page persistence format.

Methods

	Name	Description
	AddAttributesToRender(HtmlTextWriter^)	Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.(Inherited from WebControl.)
	AddedControl(Control^, Int32)	Called after a child control is added to the Controls collection of the Control object.(Inherited from Control.)
	AddParsedSubObject(Object^)	Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.(Inherited from Control.)
	ApplyStyle(Style^)	Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.(Inherited from WebControl.)
	ApplyStyleSheetSkin(Page^)	Applies the style properties defined in the page style sheet to the control.(Inherited from Control.)
	BeginRenderTracing(TextWriter^, Object^)	Begins design-time tracing of rendering data.(Inherited from Control.)
	BuildProfileTree(String^, Boolean)	This API supports the product infrastructure and is not intended to be used directly from your code. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.(Inherited from Control.)
	ClearCachedClientID()	This API supports the product infrastructure and is not intended to be used directly from your code. Sets the cached ClientID value to null.(Inherited from Control.)
	ClearChildControlState()	Deletes the control-state information for the server control's child controls. (Inherited from Control.)
	ClearChildState()	Deletes the view-state and control-state information for all the server control's child controls.(Inherited from Control.)
	ClearChildViewState()	Deletes the view-state information for all the server control's child controls.(Inherited from Control.)
	ClearEffectiveClientIDMode()	This API supports the product infrastructure and is not intended to be used directly from your code. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.(Inherited from Control.)
	Close()	Switches the Web page from catalog display mode to normal browse mode.(Inherited from CatalogZoneBase.)
	CopyBaseAttributes(WebControl^)	Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.(Inherited from WebControl.)
	CreateCatalogPartChrome()	Creates an instance of a CatalogPartChrome object used to render the peripheral user interface (UI) elements for CatalogPart controls in a zone.(Inherited from CatalogZoneBase.)
	CreateCatalogParts()	Creates an instance of each CatalogPart type that is declared in the zone.(Overrides CatalogZoneBase::CreateCatalogParts().)
	CreateChildControls()	This API supports the product infrastructure and is not intended to be used directly from your code. Creates the set of child controls associated with a CatalogZoneBase zone.(Inherited from CatalogZoneBase.)
	CreateControlCollection()	Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.(Inherited from Control.)
	CreateControlStyle()	Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.(Inherited from WebControl.)
	DataBind()	Binds a data source to the CompositeControl and all its child controls.(Inherited from CompositeControl.)
	DataBind(Boolean)	Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.)
	DataBindChildren()	Binds a data source to the server control's child controls.(Inherited from Control.)
	Dispose()	Enables a server control to perform final clean up before it is released from memory.(Inherited from Control.)
	EndRenderTracing(TextWriter^, Object^)	Ends design-time tracing of rendering data.(Inherited from Control.)
	EnsureChildControls()	Determines whether the server control contains child controls. If it does not, it creates child controls.(Inherited from Control.)
	EnsureID()	Creates an identifier for controls that do not have an identifier assigned.(Inherited from Control.)
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	FindControl(String^)	Searches the current naming container for a server control with the specified id parameter.(Inherited from Control.)
	FindControl(String^, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.(Inherited from Control.)
	Focus()	Sets input focus to a control.(Inherited from Control.)
	GetDesignModeState()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets design-time data for a control.(Inherited from Control.)
	GetEffectiveChromeType(Part^)	Returns the actual or effective current PartChromeType value of a WebPart control, given the PartChromeType property of the zone and the current display mode of the Web Parts page.(Inherited from WebZone.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetRouteUrl(Object^)	Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)
	GetRouteUrl(RouteValueDictionary^)	Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)
	GetRouteUrl(String^, Object^)	Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)
	GetRouteUrl(String^, RouteValueDictionary^)	Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetUniqueIDRelativeTo(Control^)	Returns the prefixed portion of the UniqueID property of the specified control.(Inherited from Control.)
	HasControls()	Determines if the server control contains any child controls.(Inherited from Control.)
	HasEvents()	Returns a value indicating whether events are registered for the control or any child controls.(Inherited from Control.)
	InvalidateCatalogParts()	Destroys the collection of CatalogPart controls associated with a CatalogZoneBase zone.(Inherited from CatalogZoneBase.)
	IsLiteralContent()	This API supports the product infrastructure and is not intended to be used directly from your code. Determines if the server control holds only literal content.(Inherited from Control.)
	LoadControlState(Object^)	Loads 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.)
	LoadPostData(String^, NameValueCollection^)	This API supports the product infrastructure and is not intended to be used directly from your code. 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.)
	LoadViewState(Object^)	Loads previously saved state information for a zone.(Inherited from CatalogZoneBase.)
	MapPathSecure(String^)	Retrieves the physical path that a virtual path, either absolute or relative, maps to.(Inherited from Control.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	MergeStyle(Style^)	Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.(Inherited from WebControl.)
	OnBubbleEvent(Object^, EventArgs^)	Determines whether the event for the server control is passed up the page's UI server control hierarchy.(Inherited from Control.)
	OnDataBinding(EventArgs^)	Raises the DataBinding event.(Inherited from Control.)
	OnDisplayModeChanged(Object^, WebPartDisplayModeEventArgs^)	Provides 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.)
	OnInit(EventArgs^)	Registers the page object so that the page requires control state.(Inherited from CatalogZoneBase.)
	OnLoad(EventArgs^)	Raises the Load event.(Inherited from Control.)
	OnPreRender(EventArgs^)	Raises the PreRender event and registers the page object so that it requires postbacks.(Inherited from CatalogZoneBase.)
	OnSelectedWebPartChanged(Object^, WebPartEventArgs^)	Provides a base method declaration that derived ToolZone controls can override to handle the event of changing which Web Parts control is selected within a specialized zone.(Inherited from ToolZone.)
	OnUnload(EventArgs^)	Raises the Unload event.(Inherited from Control.)
	OpenFile(String^)	Gets a Stream used to read a file.(Inherited from Control.)
	RaiseBubbleEvent(Object^, EventArgs^)	Assigns any sources of the event and its information to the control's parent.(Inherited from Control.)
	RaisePostBackEvent(String^)	Carries out the actions associated with one of the zone verbs, or raises an event that posts back to the server.(Inherited from CatalogZoneBase.)
	RecreateChildControls()	Recreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl.)
	RemovedControl(Control^)	Called after a child control is removed from the Controls collection of the Control object.(Inherited from Control.)
	Render(HtmlTextWriter^)	Renders the zone to the specified HtmlTextWriter object.(Inherited from CatalogZoneBase.)
	RenderBeginTag(HtmlTextWriter^)	Renders the opening HTML tag of the zone control to the specified HtmlTextWriter object. (Inherited from WebZone.)
	RenderBody(HtmlTextWriter^)	Overrides the base method to render the body area of a zone derived from the CatalogZoneBase class.(Inherited from CatalogZoneBase.)
	RenderCatalogPartLinks(HtmlTextWriter^)	Renders the links to the individual CatalogPart controls in a CatalogZoneBase zone.(Inherited from CatalogZoneBase.)
	RenderChildren(HtmlTextWriter^)	Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.(Inherited from Control.)
	RenderContents(HtmlTextWriter^)	Renders the entire contents of a zone control between the beginning and ending tags to the specified HtmlTextWriter object. (Inherited from WebZone.)
	RenderControl(HtmlTextWriter^)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.(Inherited from Control.)
	RenderControl(HtmlTextWriter^, ControlAdapter^)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.(Inherited from Control.)
	RenderEndTag(HtmlTextWriter^)	Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.(Inherited from WebControl.)
	RenderFooter(HtmlTextWriter^)	Renders the footer area for a CatalogZoneBase zone.(Inherited from CatalogZoneBase.)
	RenderHeader(HtmlTextWriter^)	Overrides the base method to provide specialized rendering for the header area required by ToolZone controls.(Inherited from ToolZone.)
	RenderVerb(HtmlTextWriter^, WebPartVerb^)	Renders an individual verb with a ToolZone control.(Inherited from ToolZone.)
	RenderVerbs(HtmlTextWriter^)	Renders the verbs in the footer area of a CatalogZoneBase zone.(Inherited from CatalogZoneBase.)
	ResolveAdapter()	Gets the control adapter responsible for rendering the specified control.(Inherited from Control.)
	ResolveClientUrl(String^)	Gets a URL that can be used by the browser.(Inherited from Control.)
	ResolveUrl(String^)	Converts a URL into one that is usable on the requesting client.(Inherited from Control.)
	SaveControlState()	Saves any changes in a CatalogZoneBase control's state that occur after the Web page is posted back to the server.(Inherited from CatalogZoneBase.)
	SaveViewState()	Saves any view-state changes that have occurred after a page was posted back to the server.(Inherited from CatalogZoneBase.)
	SetDesignModeState(IDictionary^)	Sets design-time data for a control.(Inherited from Control.)
	SetRenderMethodDelegate(RenderMethod^)	This API supports the product infrastructure and is not intended to be used directly from your code. Assigns an event handler delegate to render the server control and its content into its parent control.(Inherited from Control.)
	SetTraceData(Object^, Object^)	Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.(Inherited from Control.)
	SetTraceData(Object^, Object^, Object^)	Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.(Inherited from Control.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	TrackViewState()	Tracks changes to a zone control's view state.(Inherited from CatalogZoneBase.)

Events

	Name	Description
	DataBinding	Occurs when the server control binds to a data source.(Inherited from Control.)
	Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.(Inherited from Control.)
	Init	Occurs when the server control is initialized, which is the first step in its lifecycle.(Inherited from Control.)
	Load	Occurs when the server control is loaded into the Page object.(Inherited from Control.)
	PreRender	Occurs after the Control object is loaded but prior to rendering.(Inherited from Control.)
	Unload	Occurs when the server control is unloaded from memory.(Inherited from Control.)

Explicit Interface Implementations

	Name	Description
	IAttributeAccessor::GetAttribute(String^)	This API supports the product infrastructure and is not intended to be used directly from your code. Gets an attribute of the Web control with the specified name.(Inherited from WebControl.)
	IAttributeAccessor::SetAttribute(String^, String^)	Sets an attribute of the Web control to the specified name and value.(Inherited from WebControl.)
	IControlDesignerAccessor::GetDesignModeState()	For a description of this member, see IControlDesignerAccessor::GetDesignModeState.(Inherited from Control.)
	IControlDesignerAccessor::SetDesignModeState(IDictionary^)	For a description of this member, see IControlDesignerAccessor::SetDesignModeState. (Inherited from Control.)
	IControlDesignerAccessor::SetOwnerControl(Control^)	This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IControlDesignerAccessor::SetOwnerControl. (Inherited from Control.)
	IParserAccessor::AddParsedSubObject(Object^)	For a description of this member, see IParserAccessor::AddParsedSubObject. (Inherited from Control.)
	IPostBackDataHandler::LoadPostData(String^, NameValueCollection^)	Implements the IPostBackDataHandler::LoadPostData method by calling the LoadPostData method of the CatalogZoneBase class.(Inherited from CatalogZoneBase.)
	IPostBackDataHandler::RaisePostDataChangedEvent()	For a description of this member, see RaisePostDataChangedEvent.(Inherited from CatalogZoneBase.)
	IPostBackEventHandler::RaisePostBackEvent(String^)	This API supports the product infrastructure and is not intended to be used directly from your code. Implements the RaisePostBackEvent method. (Inherited from ToolZone.)
	ICompositeControlDesignerAccessor::RecreateChildControls()	Enables a designer to recreate the composite control's collection of child controls in the design-time environment.(Inherited from CompositeControl.)
	IControlBuilderAccessor::ControlBuilder	For a description of this member, see IControlBuilderAccessor::ControlBuilder. (Inherited from Control.)
	IControlDesignerAccessor::UserData	For a description of this member, see IControlDesignerAccessor::UserData. (Inherited from Control.)
	IDataBindingsAccessor::DataBindings	For a description of this member, see IDataBindingsAccessor::DataBindings. (Inherited from Control.)
	IDataBindingsAccessor::HasDataBindings	For a description of this member, see IDataBindingsAccessor::HasDataBindings. (Inherited from Control.)
	IExpressionsAccessor::Expressions	For a description of this member, see IExpressionsAccessor::Expressions. (Inherited from Control.)
	IExpressionsAccessor::HasExpressions	For a description of this member, see IExpressionsAccessor::HasExpressions. (Inherited from Control.)

Extension Methods

	Name	Description
	EnableDynamicData(Type^)	Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)
	EnableDynamicData(Type^, IDictionary<String^, Object^>^)	Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)
	EnableDynamicData(Type^, Object^)	Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)
	FindDataSourceControl()	Returns the data source that is associated with the data control for the specified control.(Defined by DynamicDataExtensions.)
	FindFieldTemplate(String^)	Returns the field template for the specified column in the specified control's naming container.(Defined by DynamicDataExtensions.)
	FindMetaTable()	Returns the metatable object for the containing data control.(Defined by DynamicDataExtensions.)
	GetDefaultValues()	Overloaded. Gets the collection of the default values for the specified data control.(Defined by DynamicDataExtensions.)
	GetMetaTable()	Overloaded. Gets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)
	SetMetaTable(MetaTable^)	Overloaded. Sets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)
	SetMetaTable(MetaTable^, IDictionary<String^, Object^>^)	Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)
	SetMetaTable(MetaTable^, Object^)	Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)
	TryGetMetaTable(MetaTable^%)	Overloaded. Determines whether table metadata is available.(Defined by DynamicDataExtensions.)

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
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.

Note
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.

Examples

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.

C++

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

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.

C++

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

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.

Note
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.

Note

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.

C++

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

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.