CatalogPartChrome.CreateCatalogPartChromeStyle Method

Reference

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates the style object that supplies style attributes for each CatalogPart control rendered by the CatalogPartChrome object.

protected:
 virtual System::Web::UI::WebControls::Style ^ CreateCatalogPartChromeStyle(System::Web::UI::WebControls::WebParts::CatalogPart ^ catalogPart, System::Web::UI::WebControls::WebParts::PartChromeType chromeType);

protected virtual System.Web.UI.WebControls.Style CreateCatalogPartChromeStyle (System.Web.UI.WebControls.WebParts.CatalogPart catalogPart, System.Web.UI.WebControls.WebParts.PartChromeType chromeType);

abstract member CreateCatalogPartChromeStyle : System.Web.UI.WebControls.WebParts.CatalogPart * System.Web.UI.WebControls.WebParts.PartChromeType -> System.Web.UI.WebControls.Style
override this.CreateCatalogPartChromeStyle : System.Web.UI.WebControls.WebParts.CatalogPart * System.Web.UI.WebControls.WebParts.PartChromeType -> System.Web.UI.WebControls.Style

Protected Overridable Function CreateCatalogPartChromeStyle (catalogPart As CatalogPart, chromeType As PartChromeType) As Style

Parameters

catalogPart: CatalogPart

The control that is currently being rendered.

chromeType: PartChromeType

The type of chrome for a particular control; one of the PartChromeType enumeration values.

Returns

Style

A Style that contains style attributes for catalogPart.

Exceptions

ArgumentNullException

The control that catalogPart refers to is null.

ArgumentOutOfRangeException

chromeType is not a PartChromeType.

Examples

The following code example demonstrates how to override the CreateCatalogPartChromeStyle method to change the background color of the catalog part control. For the full code required to run the example, including the Web page to host these controls, see the Example section of the CatalogPartChrome class overview.

protected override Style  CreateCatalogPartChromeStyle(CatalogPart catalogPart, PartChromeType chromeType)
{
    Style catalogStyle = base.CreateCatalogPartChromeStyle(catalogPart, chromeType);
    catalogStyle.BackColor = Color.Bisque;
    return catalogStyle;
}

Protected Overrides Function CreateCatalogPartChromeStyle(ByVal catalogPart As System.Web.UI.WebControls.WebParts.CatalogPart, ByVal chromeType As System.Web.UI.WebControls.WebParts.PartChromeType) As System.Web.UI.WebControls.Style
    Dim editorStyle As Style
    editorStyle = MyBase.CreateCatalogPartChromeStyle(catalogPart, chromeType)
    editorStyle.BackColor = Drawing.Color.Bisque
    Return editorStyle
End Function

Remarks

The CreateCatalogPartChromeStyle method creates a Style object that is used by the CatalogPartChrome object to render a CatalogPart control.

Notes to Inheritors

If you inherit from the CatalogPartChrome class, you can optionally override the CreateCatalogPartChromeStyle(CatalogPart, PartChromeType) method, and merge the style information from the base method with custom style attributes that you want to add. For a demonstration, see the Example section.

Applies to