Export (0) Print
Expand All

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.

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

public ref class PageCatalogPart sealed : public CatalogPart
<asp:PageCatalogPart />

The PageCatalogPart type exposes the following members.

  NameDescription
Public methodPageCatalogPartInitializes a new instance of the class.
Top

  NameDescription
Public propertyAccessKeyThis 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.)
Public propertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public propertyAttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public propertyBackColorThis 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.)
Public propertyBackImageUrlThis 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.)
Public propertyBindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public propertyBorderColorThis 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.)
Public propertyBorderStyleThis 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.)
Public propertyBorderWidthThis 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.)
Public propertyChromeStateGets or sets whether a part control is in a minimized or normal state. (Inherited from Part.)
Public propertyChromeTypeGets or sets the type of border that frames a Web Parts control. (Inherited from Part.)
Public propertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public propertyClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected propertyContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public propertyControlsInfrastructure. Gets a ControlCollection object that contains the child controls for a specified server control in the user interface hierarchy. (Inherited from Part.)
Public propertyControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyControlStyleCreatedGets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.)
Public propertyCssClassThis 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.)
Public propertyDataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public propertyDataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Public propertyDefaultButtonThis 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.)
Public propertyDescriptionGets or sets a brief phrase that summarizes what the part control does, for use in ToolTips and catalogs of part controls. (Inherited from Part.)
Protected propertyDesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public propertyDirectionThis 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.)
Public propertyDisplayTitleGets a string that contains the actual current title of a CatalogPart control. (Inherited from CatalogPart.)
Public propertyEnabledThis 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.)
Public propertyEnableThemingThis 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.)
Public propertyEnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.)
Public propertyFontThis 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.)
Public propertyForeColorThis 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.)
Public propertyGroupingTextThis 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.)
Public propertyHasAttributesGets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Public propertyHeightThis 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.)
Public propertyHorizontalAlignThis 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.)
Public propertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected propertyIsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected propertyIsEnabledGets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected propertyIsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public propertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control::ID property value. (Inherited from Control.)
Public propertyPageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public propertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public propertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public propertyScrollBarsThis 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.)
Public propertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public propertySkinIDThis 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.)
Public propertyStyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.)
Public propertySupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from Panel.)
Public propertyTabIndexThis 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.)
Public propertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public propertyTemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public propertyTitleGets or sets the title that appears in the control's title bar. (Overrides Part::Title.)
Public propertyToolTipThis 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.)
Public propertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public propertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.)
Public propertyViewStateModeGets or sets the view-state mode of this control. (Inherited from Control.)
Public propertyVisibleThis 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.)
Public propertyWidthThis 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.)
Public propertyWrapThis 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.)
Top

  NameDescription
Protected methodAddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Public methodApplyStyleCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.)
Public methodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Public methodCopyBaseAttributesCopies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodCreateChildControlsCalled 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.)
Public methodDataBind()Binds a data source to the invoked server control and all its child controls. (Inherited from Part.)
Public methodDisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodFindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Public methodFocusSets input focus to a control. (Inherited from Control.)
Public methodGetAvailableWebPartDescriptionsReturns a collection of descriptions of the available WebPart controls in a catalog. (Overrides CatalogPart::GetAvailableWebPartDescriptions().)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public methodGetWebPartReturns a reference to a WebPart control based on the value of the description passed into the method. (Overrides CatalogPart::GetWebPart(WebPartDescription).)
Public methodHasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected methodLoadControlStateRestores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected methodMapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Public methodMergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodOnInitRaises the Init event. (Inherited from Control.)
Protected methodOnLoadRaises the Load event. (Inherited from Control.)
Protected methodOnPreRenderRaises the PreRender event. (Inherited from CatalogPart.)
Protected methodOnUnloadRaises the Unload event. (Inherited from Control.)
Protected methodOpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected methodRemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected methodRenderRenders the control to the specified HTML writer. (Inherited from WebControl.)
Public methodRenderBeginTagRenders the HTML opening tag of the Panel control to the specified writer. (Inherited from Panel.)
Protected methodRenderChildrenOutputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
Protected methodRenderContentsRenders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Public methodRenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Public methodRenderEndTagRenders the HTML closing tag of the Panel control into the specified writer. (Inherited from Panel.)
Public methodResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public methodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected methodSaveControlStateSaves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Public methodSetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public methodSetTraceData(Object, Object)Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control.)
Public methodSetTraceData(Object, Object, Object)Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventDataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
Public eventDisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.)
Public eventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public eventLoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public eventPreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public eventUnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Top

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

  NameDescription
Explicit interface implemetationPrivate methodIAttributeAccessor::GetAttributeInfrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodIAttributeAccessor::SetAttributeSets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodICompositeControlDesignerAccessor::RecreateChildControlsAllows the developer of a designer for a composite part control to recreate the control's child controls on the design surface. (Inherited from Part.)
Explicit interface implemetationPrivate propertyIControlBuilderAccessor::ControlBuilderFor a description of this member, see IControlBuilderAccessor::ControlBuilder. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor::GetDesignModeStateFor a description of this member, see IControlDesignerAccessor::GetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor::SetDesignModeStateFor a description of this member, see IControlDesignerAccessor::SetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor::SetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessor::SetOwnerControl. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlDesignerAccessor::UserDataFor a description of this member, see IControlDesignerAccessor::UserData. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor::DataBindingsFor a description of this member, see IDataBindingsAccessor::DataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor::HasDataBindingsFor a description of this member, see IDataBindingsAccessor::HasDataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor::ExpressionsFor a description of this member, see IExpressionsAccessor::Expressions. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor::HasExpressionsFor a description of this member, see IExpressionsAccessor::HasExpressions. (Inherited from Control.)
Explicit interface implemetationPrivate methodIParserAccessor::AddParsedSubObjectFor a description of this member, see IParserAccessor::AddParsedSubObject. (Inherited from Control.)
Top

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:

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

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

TopicLocation
How to: Set the Display Mode of a Web Parts PageBuilding ASP .NET Web Applications
How to: Set the Display Mode of a Web Parts PageBuilding 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.

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

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.

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

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.

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

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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

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

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

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