PageCatalogPart Class
Provides a catalog that keeps references to all WebPart controls (and other server controls contained in WebPartZoneBase zones) that a user has closed on a single Web Parts page, which enables users to add the closed controls back to the page. This class cannot be inherited.
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::PageCatalogPart
Assembly: System.Web (in System.Web.dll)
The PageCatalogPart type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | AccessKey | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::AccessKey.) |
![]() | 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 | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::BackColor.) |
![]() | BackImageUrl | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides Panel::BackImageUrl.) |
![]() | BindingContainer | Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.) |
![]() | BorderColor | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::BorderColor.) |
![]() | BorderStyle | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::BorderStyle.) |
![]() | BorderWidth | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::BorderWidth.) |
![]() | 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 | 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.) |
![]() | Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) |
![]() | Controls | Infrastructure. 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 | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::CssClass.) |
![]() | 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 | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides Panel::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 | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides Panel::Direction.) |
![]() | DisplayTitle | Gets a string that contains the actual current title of a CatalogPart control. (Inherited from CatalogPart.) |
![]() | Enabled | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::Enabled.) |
![]() | EnableTheming | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::EnableTheming.) |
![]() | 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 | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::Font.) |
![]() | ForeColor | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::ForeColor.) |
![]() | GroupingText | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides Panel::GroupingText.) |
![]() | 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 | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::Height.) |
![]() | HorizontalAlign | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides Panel::HorizontalAlign.) |
![]() | ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) |
![]() | IdSeparator | Infrastructure. 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 | 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.) |
![]() | 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.) |
![]() | RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) |
![]() | ScrollBars | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides Panel::ScrollBars.) |
![]() | Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
![]() | SkinID | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::SkinID.) |
![]() | 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 Panel.) |
![]() | TabIndex | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::TabIndex.) |
![]() | 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 that appears in the control's title bar. (Overrides Part::Title.) |
![]() | ToolTip | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::ToolTip.) |
![]() | UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (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 | 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 | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides Control::Visible.) |
![]() | WebPartManager | Gets a reference to the current instance of the WebPartManager class. (Inherited from CatalogPart.) |
![]() | Width | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides WebControl::Width.) |
![]() | Wrap | This inherited property is not used by the Web Parts control set when rendering a PageCatalogPart control. The property is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio 2005 designer tools. (Overrides Panel::Wrap.) |
![]() | Zone | Gets a reference to the CatalogZoneBase zone that contains a CatalogPart control. (Inherited from CatalogPart.) |
| Name | Description | |
|---|---|---|
![]() | AddAttributesToRender | Adds information about the background image, alignment, wrap, and direction to the list of attributes to render. (Inherited from Panel.) |
![]() | AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) |
![]() | AddParsedSubObject | 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 | 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 | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) |
![]() | BuildProfileTree | Infrastructure. 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 | Infrastructure. Sets the cached ClientID value to nullptr. (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 | Infrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) |
![]() | CopyBaseAttributes | 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 | Creates a style object that is used internally by the Panel control to implement all style related properties. (Inherited from Panel.) |
![]() | 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.) |
![]() | 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) | 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.) |
![]() | Focus | Sets input focus to a control. (Inherited from Control.) |
![]() | GetAvailableWebPartDescriptions | Returns a collection of descriptions of the available WebPart controls in a catalog. (Overrides CatalogPart::GetAvailableWebPartDescriptions().) |
![]() | GetDesignModeState | Retrieves the current state of a CatalogPart control's parent zone. (Inherited from CatalogPart.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (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 | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) |
![]() | GetWebPart | Returns a reference to a WebPart control based on the value of the description passed into the method. (Overrides CatalogPart::GetWebPart(WebPartDescription).) |
![]() | 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 | Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.) |
![]() | LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) |
![]() | LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState method. (Inherited from WebControl.) |
![]() | MapPathSecure | 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 | 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 | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) |
![]() | OnDataBinding | Raises the DataBinding event. (Inherited from Control.) |
![]() | OnInit | Raises the Init event. (Inherited from Control.) |
![]() | OnLoad | Raises the Load event. (Inherited from Control.) |
![]() | OnPreRender | Raises the PreRender event. (Inherited from CatalogPart.) |
![]() | OnUnload | Raises the Unload event. (Inherited from Control.) |
![]() | OpenFile | Gets a Stream used to read a file. (Inherited from Control.) |
![]() | RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) |
![]() | RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) |
![]() | Render | Renders the control to the specified HTML writer. (Inherited from WebControl.) |
![]() | RenderBeginTag | Renders the HTML opening tag of the Panel control to the specified writer. (Inherited from Panel.) |
![]() | RenderChildren | 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 | 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 | Renders the HTML closing tag of the Panel control into the specified writer. (Inherited from Panel.) |
![]() | ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) |
![]() | ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
![]() | ResolveUrl | 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 | Sets design-time data for a control. (Inherited from CatalogPart.) |
![]() | SetRenderMethodDelegate | Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (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 | 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.) |
| Name | Description | |
|---|---|---|
![]() | FindDataSourceControl | Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.) |
![]() | FindFieldTemplate | 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.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IAttributeAccessor::GetAttribute | Infrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.) |
![]() ![]() | IAttributeAccessor::SetAttribute | Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl.) |
![]() ![]() | 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::GetDesignModeState | For a description of this member, see IControlDesignerAccessor::GetDesignModeState. (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor::SetDesignModeState | For a description of this member, see IControlDesignerAccessor::SetDesignModeState. (Inherited from Control.) |
![]() ![]() | IControlDesignerAccessor::SetOwnerControl | Infrastructure. For a description of this member, see IControlDesignerAccessor::SetOwnerControl. (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.) |
![]() ![]() | IParserAccessor::AddParsedSubObject | For a description of this member, see IParserAccessor::AddParsedSubObject. (Inherited from Control.) |
The PageCatalogPart class serves one very specific purpose on a Web Parts page: it acts as a page catalog to maintain any controls previously added to the page that a user has closed, so that the user can add them back to the page. This control is visible only when a Web page is in catalog display mode, a special view that enables users to add and remove controls on the page. Add a PageCatalogPart control to your page if you want to provide users with the flexibility of closing and reopening controls. If your page does not allow users to close controls at all, there is no need to add a PageCatalogPart control to your page.
Only closed controls are added to the page catalog. A closed control has several attributes:
It is not visible on the page.
It is not rendered on the page.
It does not participate in page life-cycle phases.
Closing a control is different from deleting it, which permanently removes it from the page. A user can reopen a closed control instance from a page catalog, but after a user deletes a control, he or she can never recover that specific instance.
The most common and convenient way to add a PageCatalogPart control to a page is by declaring it in page persistence format. As with any declarative CatalogPart control, a PageCatalogPart control must be declared within the proper context of ASP.NET markup elements on a Web page. For a working code example of how to declare a PageCatalogPart control in a Web page, see the Example section of this topic. You must add the following sequence of declarative elements to the page:
An <asp:catalogzone> element must be declared, and a child <zonetemplate> element must be added to it to contain any CatalogPart controls declared in the zone.
An <asp:pagecatalogpart> element must be added as a child of the <zonetemplate> element. There might also be other CatalogPart controls declared as child elements of the <zonetemplate> element, including DeclarativeCatalogPart or ImportCatalogPart controls.
The PageCatalogPart class has only one usable property, the Title property, which overrides the base property so that a default title can be provided for the page catalog if no value is supplied.
The remaining properties for the PageCatalogPart class override the inherited properties, but are not actually used for rendering the control. They are overridden only so that special code attributes can be set on them to hide them from design tools like Microsoft Visual Studio 2005. You should not use these hidden properties, because they have no effect on rendering. The fact that they are hidden from IntelliSense and the Properties pane in Visual Studio helps developers avoid using them by mistake. All these hidden properties are noted as such in their respective Help topics.
The PageCatalogPart class also has several important methods. The GetAvailableWebPartDescriptions method retrieves a WebPartDescription object for each WebPart control in the page catalog, which enables a PageCatalogPart control to display information about each server control without having to create an instance of that control. Another method is the GetWebPart method. This method gets an instance of a particular WebPart control, based on the description passed to the method.
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.
| Topic | Location |
|---|---|
| How to: Set the Display Mode of a Web Parts Page | Building ASP .NET Web Applications |
| How to: Set the Display Mode of a Web Parts Page | Building ASP .NET Web Applications |
The following code example demonstrates how to use the PageCatalogPart control declaratively on a Web page. This example has four parts:
A user control that enables you to change display modes on a Web Parts page.
A Web page that contains a CatalogZone control, a PageCatalogPart control, and a DeclarativeCatalogPart control.
A source code file that contains two custom WebPart controls.
An explanation of how the example works when you load the page in a browser.
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.
The second part of the code example is the Web page. At the top of the page are two register directives, one for the user control and one for the compiled component that contains the two custom WebPart controls. Notice that the page has a declarative reference to the PageCatalogPart control, nested within the proper hierarchy of declarative elements as described in the Remarks section of this topic. There is also an <asp:declarativecatalogpart> element, which contains references for a standard ASP.NET Calendar control and the two custom WebPart controls, all of which are the controls that users can select from the catalog.
The third part of the code example is the source code for the two WebPart controls. 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 walkthrough that demonstrates both methods of compiling, see Walkthrough: Developing and Using a Custom Web Server Control.
When you load the page in a browser, select Catalog Mode in the Display Mode drop-down list control to switch to catalog mode. In catalog mode, you can see the controls that are available to be added to the page. Add one of the controls, then use the Display Mode drop-down list control to return the page to browse mode. Click the verbs menu (the downward arrow) in the title bar of one of the controls, and click Close to close the control. Return the page to catalog mode, and notice that the control you closed now appears in the page catalog, and is available to be added back to the page.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.








