CatalogPart Class
Serves as the base class for controls that reside in CatalogZoneBase zones, and that provide catalogs of available Web server controls (especially WebPart controls) that users can add to a Web page.
Assembly: System.Web (in System.Web.dll)
System.Web.UI::Control
System.Web.UI.WebControls::WebControl
System.Web.UI.WebControls::Panel
System.Web.UI.WebControls.WebParts::Part
System.Web.UI.WebControls.WebParts::CatalogPart
System.Web.UI.WebControls.WebParts::DeclarativeCatalogPart
System.Web.UI.WebControls.WebParts::ImportCatalogPart
System.Web.UI.WebControls.WebParts::PageCatalogPart
| Name | Description | |
|---|---|---|
 | CatalogPart() | Initializes the class for use by an inherited class instance. This constructor can only be called by an inherited class. |
| 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.) |
| AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.) |
| 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 of the background image for the panel control.(Inherited from Panel.) |
| 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.) |
| ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created.(Inherited from Control.) |
| ChromeState | Gets or sets whether a part control is in a minimized or normal state.(Inherited from Part.) |
| ChromeType | Gets or sets the type of border that frames a Web Parts control.(Inherited from Part.) |
| ClientID | Gets the control ID for HTML markup that is generated by ASP.NET.(Inherited from Control.) |
| ClientIDMode | |
| ClientIDSeparator | |
| Context | Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.) |
| Controls | This API supports the product infrastructure and is not intended to be used directly from your code. Gets a ControlCollection object that contains the child controls for a specified server control in the user interface hierarchy.(Inherited from Part.) |
| 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.) |
| DefaultButton | |
| Description | Gets or sets a brief phrase that summarizes what the part control does, for use in ToolTips and catalogs of part controls.(Inherited from Part.) |
| DesignMode | Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.) |
| Direction | |
| DisplayTitle | Gets a string that contains the actual current title of a CatalogPart control. |
| 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.) |
| 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.) |
| ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control.(Inherited from WebControl.) |
| GroupingText | Gets or sets the caption for the group of controls that is contained in the panel control.(Inherited from Panel.) |
| 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.) |
| Height | Gets or sets the height of the Web server control.(Inherited from WebControl.) |
| HorizontalAlign | Gets or sets the horizontal alignment of the contents within the panel.(Inherited from Panel.) |
| 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.) |
| 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.) |
| LoadViewStateByID | |
| 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.) |
| Page | |
| Parent | Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.) |
| RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.(Inherited from Control.) |
| ScrollBars | |
| 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 | |
| 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 WebControl.) |
| 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.) |
| Title | Gets or sets the title of a part control.(Inherited from Part.) |
| 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.) |
| 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 | |
| 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 UI on the page.(Inherited from Control.) |
| WebPartManager | Gets a reference to the current instance of the WebPartManager class. |
| Width | Gets or sets the width of the Web server control.(Inherited from WebControl.) |
| Wrap | Gets or sets a value indicating whether the content wraps within the panel.(Inherited from Panel.) |
| Zone | Gets a reference to the CatalogZoneBase zone that contains a CatalogPart control. |
| Name | Description | |
|---|---|---|
| AddAttributesToRender(HtmlTextWriter^) | Adds information about the background image, alignment, wrap, and direction to the list of attributes to render.(Inherited from Panel.) |
| AddedControl(Control^, Int32) | |
| 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) | |
| ClearCachedClientID() | |
| 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.) |
| CopyBaseAttributes(WebControl^) | Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.(Inherited from WebControl.) |
| CreateChildControls() | Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.(Inherited from Control.) |
| CreateControlCollection() | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.(Inherited from Control.) |
| CreateControlStyle() | |
| DataBind() | Binds a data source to the invoked server control and all its child controls.(Inherited from Part.) |
| 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.) |
| GetAvailableWebPartDescriptions() | Returns a collection of descriptions of the available WebPart controls in a catalog. |
| GetDesignModeState() | Retrieves the current state of a CatalogPart control's parent zone. (Overrides Control::GetDesignModeState().) |
| 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() | |
| GetUniqueIDRelativeTo(Control^) | |
| GetWebPart(WebPartDescription^) | Retrieves from a catalog the WebPart control that is referenced by the WebPartDescription object passed to the method. |
| 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.) |
| 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^) | Restores control-state information from a previous page request that was saved by the SaveControlState method.(Inherited from Control.) |
| LoadViewState(Object^) | Restores view-state information from a previous request that was saved with the SaveViewState method. (Inherited from WebControl.) |
| MapPathSecure(String^) | Retrieves the physical path that a virtual path, either absolute or relative, maps to.(Inherited from Control.) |
| MemberwiseClone() | |
| 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.) |
| OnInit(EventArgs^) | |
| OnLoad(EventArgs^) | |
| OnPreRender(EventArgs^) | Raises the PreRender event.(Overrides Control::OnPreRender(EventArgs^).) |
| OnUnload(EventArgs^) | |
| OpenFile(String^) | |
| RaiseBubbleEvent(Object^, EventArgs^) | Assigns any sources of the event and its information to the control's parent.(Inherited from Control.) |
| RemovedControl(Control^) | |
| Render(HtmlTextWriter^) | Renders the control to the specified HTML writer.(Inherited from WebControl.) |
| RenderBeginTag(HtmlTextWriter^) | |
| RenderChildren(HtmlTextWriter^) | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.(Inherited from Control.) |
| RenderContents(HtmlTextWriter^) | Renders the contents of the control to the specified writer. This method is used primarily by control developers.(Inherited from WebControl.) |
| 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^) | |
| ResolveAdapter() | Gets the control adapter responsible for rendering the specified control.(Inherited from Control.) |
| ResolveClientUrl(String^) | Gets a URL that can be used by the browser.(Inherited from Control.) |
| ResolveUrl(String^) | Converts a URL into one that is usable on the requesting client.(Inherited from Control.) |
| SaveControlState() | Saves any server control state changes that have occurred since the time the page was posted back to the server.(Inherited from Control.) |
| SaveViewState() | Saves any state that was modified after the TrackViewState method was invoked.(Inherited from WebControl.) |
| SetDesignModeState(IDictionary^) | Sets design-time data for a control.(Overrides Control::SetDesignModeState(IDictionary^).) |
| 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() | Causes the control to track changes to its view state so they can be stored in the object's ViewState property.(Inherited from WebControl.) |
| 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 | |
| PreRender | |
| Unload | Occurs when the server control is unloaded from memory.(Inherited from Control.) |
| 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.) |
| ICompositeControlDesignerAccessor::RecreateChildControls() | Allows the developer of a designer for a composite part control to recreate the control's child controls on the design surface.(Inherited from Part.) |
 | 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.) |
| 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.) |
The CatalogPart class is a base class for special controls that reside in CatalogZoneBase zones. These derived CatalogPart controls provide catalogs of Web server controls that end users can add to a Web page. Use CatalogPart controls in a Web application when you want to provide end users with the flexibility to change the functionality of a Web page by adding or removing server controls.
A catalog is simply a list of one or more available Web server controls (including WebPart controls, ASP.NET server controls, and custom or user controls) that users can add to a Web page. A catalog has a number of common characteristics, including instruction text for end users; text to describe each server control; helper controls to select the server controls and add them to the page; a common header, footer, and border; and a number of style attributes.
There are three types of CatalogPart controls provided with the Web Parts control set, as described in the following table. Each type of CatalogPart control contains server controls that are added to a page from a different source.
 Important |
|---|
Controls that inherit from the CatalogPart class can reside only in zones derived from the CatalogZoneBase class. |
Control | Description |
|---|---|
Contains controls that have been closed on a page, and that can be reopened (added back to the page) by users. The controls in this type of catalog are controls that were already added to the page from another source, and were then closed by a user. | |
Contains server controls declared within a DeclarativeCatalogPart control, which is itself contained in a CatalogZoneBase zone in the markup of a Web page. | |
Provides the user interface (UI) for a user to upload a control's definition file (an XML file defined by a schema, that contains state information) to a catalog, so that the control can be added to a Web page. The controls themselves do not appear in this type of catalog; the catalog is just a mechanism for accessing the definition files for external controls so they can be added to a page. |
The CatalogPart class inherits from the base Part class, so that it has the common behavior of other part controls in the Web Parts control set. In addition, it adds some members that are useful for the catalog functionality. The DisplayTitle property gets the actual string that is currently being displayed as the title of the control. The value of this property can be the same as the value of the Title property or, if no value has been assigned to that property, a default value supplied by the .NET Framework. The WebPartManager and Zone properties both provide convenient access to the two essential objects that control the life cycle of a CatalogPart control: the WebPartManager control, and the CatalogZoneBase zone that contains the CatalogPart control, respectively.
The CatalogPart class also contains several methods. The GetAvailableWebPartDescriptions method is declared as an abstract method that must be implemented by inheritors. Its intended purpose is to return a collection of descriptions of the controls in the catalog. A related method, GetWebPart, is also declared as abstract and must be implemented by inheritors. This method is intended to return an instance of a WebPart control based on a description that is passed to the method as a parameter.
Notes to Inheritors:
Because the CatalogPart class is abstract, you cannot use it directly on a Web page. The Web Parts control set provides three CatalogPart controls (listed in the table in the Remarks section of this topic) that derive from the base class and that can be used on Web Parts pages. These controls should provide most of the features needed to create catalogs of Web server controls. However, you might have specialized needs that would require developing a custom CatalogPart control. For example, you can create a special type of CatalogPart control that makes server controls available through a Web service, or directly from a database. To do this, you must inherit from the CatalogPart class. You must also override the abstract GetAvailableWebPartDescriptions and GetWebPart methods to provide an implementation that returns the WebPart or other server controls, and their descriptions. You will also need methods to load the various server controls from your database or Web service.
The following code example demonstrates the use of the CatalogPart class. Because the class is abstract, it is not used directly in code. However, the example shows how to work with the three derived CatalogPart controls provided with the Web Parts control set to demonstrate common usage scenarios.
There are four parts to the code example:
A user control that enables you to change display modes on the Web page.
A Web page, which contains the three CatalogPart controls provided with the Web Parts control set, all declared within a CatalogZone on a Web page. The page also contains a WebPartZone control, with an AdRotator control declared in the zone.
An XML file that contains quotations displayed in the AdRotator control on the Web page.
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. You should save this code in a file named DisplayModeMenuCS.ascx or DisplayModeMenuVB.ascx (depending on which language you are using). 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.
The second part of the code example is the Web page. The page contains a CatalogZone control, and within the child <zonetemplate> element, each of the three CatalogPart controls provided with the Web Parts control set is declared. Some attribute are set on the DeclarativeCatalogPart control, and also in the <script> section of the page, the attributes on that control are accessed programmatically. The control contains one child control that a user can add to the page: a standard Calendar control. The CatalogZone and CatalogPart control will only be visible when the user switches the page to catalog display mode.
The page also contains a WebPartZone control, and within its child <zonetemplate> element is an AdRotator control that displays alternating messages from an XML file. If a user closes the control by clicking its close verb when the page is displayed, the control is added to the page catalog, and the user can reopen the control by switching the page into catalog display mode, accessing the PageCatalogPart control, and adding back the closed control.
The third part of the code example is the XML file. This file is a source file for the AdRotator control that is declared on the page. The file contains favorite quotations, which the control periodically rotates and displays. Copy the following content into a text editor, and save the file as Quotes.xml.
<?xml version="1.0" encoding="utf-8" ?>
<Advertisements>
<Ad>
<AlternateText>
A stitch in time saves nine.
</AlternateText>
</Ad>
<Ad>
<AlternateText>
A penny saved is a penny earned.
</AlternateText>
</Ad>
</Advertisements>
To run the code example, load the Web page in a browser. Use the Display Modes drop-down control to select Catalog and switch the page to catalog display mode. Notice the effects of the various property values that were set on the DeclarativeCatalogPart control that contains the Calendar control. You can select the check box next to the Calendar control, and click Add to add it to the page. If you click the Display DeclarativeCatalogPart Properties button, the values of the properties for that control are displayed. You can click Close to return the page to normal browse mode and see the added control on the page. Now go to the verbs menu on the AdRotator control (represented by the downward arrow in the title bar) and click Close. The control is closed and added to the page catalog. Switch the page into catalog display mode again, and click the Page Catalog hyperlink to display the PageCatalogPart control. Note that the AdRotator control is referenced there by its title, Favorite Quotes. Select the Favorite Quotes control, and click the Add button to add the control back to the page. Click the Close button to return the page to browse mode.
 Note |
|---|
The ImportCatalogPart control is also declared on this page, but a sample showing how to import controls is more involved, so full use of the control is not demonstrated in this code example. To see a full working example, see the class overview documents for the ImportCatalogPart class or the CatalogZone class. |
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.