This documentation is archived and is not being maintained.

GenericWebPart::CatalogIconImageUrl Property

Gets or sets the URL to an image that represents a GenericWebPart control in a catalog of controls.

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

public:
virtual property String^ CatalogIconImageUrl {
	String^ get () override;
	void set (String^ value) override;
}
<asp:GenericWebPart CatalogIconImageUrl="String" />

Property Value

Type: System::String
A string that represents the URL to an image used to represent the control in a catalog. The default value is an empty string ("").

Implements

IWebPart::CatalogIconImageUrl

Web Parts applications often provide a catalog (or list) of controls that users can add to a page. The CatalogIconImageUrl property on a control contains the URL to an image that represents the control when it appears in a catalog. This property overrides the base property so that you can access the property on the child control as if it were a true WebPart control.

You can set values for the property on your control in the declarative markup of a Web page, as well as programmatically. To provide a default value for the property whenever the control is used, you can implement the IWebPart interface.

The following code example demonstrates declarative and programmatic use of the CatalogIconImageUrl property. The complete source code for the example is found in the Example section of the GenericWebPart overview topic.

The first part of the code example shows how the CatalogIconImageUrl property is set declaratively on a server control within a WebPartZone control.

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

The second part of the code example demonstrates the method that programmatically accesses the value of the property when a user clicks the Display All Property Values button.

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: