Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
CatalogPartChrome Class
Collapse the table of content
Expand the table of content

CatalogPartChrome Class

Enables developers to override the rendering for only the selected sections of CatalogPart controls in a CatalogZoneBase zone.


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

public ref class CatalogPartChrome

The CatalogPartChrome type exposes the following members.

Public methodCatalogPartChromeInitializes a new instance of the CatalogPartChrome class.

Protected propertyZoneGets a reference to the associated CatalogZoneBase zone.

Protected methodCreateCatalogPartChromeStyleCreates the style object that supplies style attributes for each CatalogPart control rendered by the CatalogPartChrome object.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPerformPreRenderPerforms tasks that must be done prior to rendering CatalogPart controls.
Public methodRenderCatalogPartRenders a complete CatalogPart control with all its sections.
Protected methodRenderPartContentsRenders the main content area of a CatalogPart control, excluding the header and footer.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Chrome refers to the peripheral user interface (UI) elements that frame each Web Parts control or server control contained in a zone. The chrome for a control includes its border, its title bar, and the icons, title text, and verbs menu that appear within the title bar. The appearance of the chrome is set at the zone level, and applies to all the controls in the zone.

The Web Parts control set uses the CatalogPartChrome class to render the chrome for CatalogPart controls. Additionally, this class provides a way for developers to customize the rendering of any CatalogPart controls in a CatalogZoneBase zone. For example, you can override the CreateCatalogPartChromeStyle method to customize some specific style attributes applied to the CatalogZoneBase zone.

The CatalogPartChrome class contains several important methods that are useful when you want to override the rendering of CatalogPart controls. One is the CatalogPartChrome constructor, which you use when you override the CreateCatalogPartChrome method in a custom CatalogZoneBase zone to create an instance of your custom CatalogPartChrome object. Another useful method is the RenderPartContents method, which you can use to control the rendering of the content area of controls in a zone (as opposed to chrome elements such as headers, footers, and title bars). Finally, if you want complete programmatic control over all aspects of rendering the CatalogPart controls, you can override the RenderCatalogPart method.

Notes to Implementers

If you inherit from the CatalogPartChrome class, you must create a customized CatalogZone zone to return your customized CatalogPartChrome class. The Example section for this class overview demonstrates how to create a customized CatalogZone zone to return a customized CatalogPartChrome class.

The following code example demonstrates how to use the CatalogPartChrome class to override the default rendering of CatalogPart controls in a CatalogZoneBase zone.

The code example has three parts:

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

  • A Web page that hosts all the controls in the example.

  • A class that contains the source code for a custom CatalogPartChrome class and CatalogZoneBase zone.

The first part of the code example is the user control. The source code for the user control comes from another topic. For this code example to work, you need to obtain the .ascx file for the user control from the Walkthrough: Changing Display Modes on a Web Parts Page topic, and place the file in the same folder as the .aspx page in this code example.

The second part of the example is the Web page. Note that there is a Register directive near the top of the file to register the compiled component and a tag prefix. Also note that the page references the custom catalog zone using the element <aspSample:MyCatalogZone>.

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

The third part of the example contains the implementation of the custom catalog part chrome and catalog part zone. MyCatalogZone extends CatalogZone and overrides CreateCatalogPartChrome to return the custom catalog part chrome. MyCatalogPartChrome changes the background color of the catalog control in the CreateCatalogPartChromeStyle method. The background color of the zone is changed in the PerformPreRender method, and text is added to the catalog part in the RenderPartContents method.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 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.
© 2015 Microsoft