GenericWebPart.CatalogIconImageUrl Property

public:
 virtual property System::String ^ CatalogIconImageUrl { System::String ^ get(); void set(System::String ^ value); };

public override string CatalogIconImageUrl { get; set; }

member this.CatalogIconImageUrl : string with get, set

Public Overrides Property CatalogIconImageUrl As String

Property Value

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

Examples

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.

<asp:WebPartZone ID="WebPartZone1" runat="server">
  <ZoneTemplate>
    <asp:Calendar ID="Calendar1" runat="server"
      Title="My Calendar"
      Description="A calendar used as a GenericWebPart control."
      CatalogIconImageUrl="MyCatalogIcon.gif"
      TitleIconimageUrl ="MyTitleIcon.gif"
      TitleUrl="MyInfoUrl.htm" 
      Width="250"/>
  </ZoneTemplate>
</asp:WebPartZone>

<asp:WebPartZone ID="WebPartZone1" runat="server">
  <ZoneTemplate>
    <asp:Calendar ID="Calendar1" runat="server"
      Title="My Calendar"
      Description="A calendar used as a GenericWebPart control."
      CatalogIconImageUrl="MyCatalogIcon.gif"
      TitleIconimageUrl ="MyTitleIcon.gif"
      TitleUrl="MyInfoUrl.htm" 
      Width="250"/>
  </ZoneTemplate>
</asp:WebPartZone>

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.

protected void Button1_Click(object sender, EventArgs e)
{

  Label2.Text =
    @"<h3>Calendar GenericWebPart Properties</h3>" +
    "<em>Title: </em>" + calendarPart.Title +
    "<br />" +
    "<em>CatalogIconImageUrl:  </em>" + calendarPart.CatalogIconImageUrl +
    "<br />" +
    "<em>TitleUrl: </em>" + calendarPart.TitleUrl +
    "<br />" +
    "<em>Decription: </em>" + calendarPart.Description +
    "<br />" +
    "<em>TitleIconImageUrl: </em>" + calendarPart.TitleIconImageUrl +
    "<br />" +
    "<em>ChildControl ID: </em>" + calendarPart.ChildControl.ID +
    "<br />" +
    "<em>ChildControl Type: </em>" + calendarPart.ChildControl.GetType().Name +
    "<br />" +
    "<em>GenericWebPart ID: </em>" + calendarPart.ID +
    "<br />" +
    "<em>GenericWebPart Type: </em>" + calendarPart.GetType().Name +
    "<br />" +
    "<em>GenericWebPart Parent ID: </em>" + calendarPart.Parent.ID;

  Label3.Text =
    @"<h3>BulletedList GenericWebPart Properties</h3>" +
    "<em>Title: </em>" + listPart.Title +
    "<br />" +
    "<em>CatalogIconImageUrl:  </em>" + listPart.CatalogIconImageUrl +
    "<br />" +
    "<em>TitleUrl: </em>" + listPart.TitleUrl +
    "<br />" +
    "<em>Decription: </em>" + listPart.Description +
    "<br />" +
    "<em>TitleIconImageUrl: </em>" + listPart.TitleIconImageUrl +
    "<br />" +
    "<em>ChildControl ID: </em>" + listPart.ChildControl.ID +
    "<br />" +
    "<em>ChildControl Type: </em>" + listPart.ChildControl.GetType().Name +
    "<br />" +
    "<em>GenericWebPart ID: </em>" + listPart.ID +
    "<br />" +
    "<em>GenericWebPart Type: </em>" + listPart.GetType().Name +
    "<br />" +
    "<em>GenericWebPart Parent ID: </em>" + listPart.Parent.ID;
}

  Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)

    Label2.Text = _
      "<h3>Calendar GenericWebPart Properties</h3>" & _
      "<em>Title: </em>" & calendarPart.Title & _
      "<br />" & _
      "<em>CatalogIconImageUrl:  </em>" & calendarPart.CatalogIconImageUrl & _
      "<br />" & _
      "<em>TitleUrl: </em>" & calendarPart.TitleUrl & _
      "<br />" & _
      "<em>Decription: </em>" & calendarPart.Description & _
      "<br />" & _
      "<em>TitleIconImageUrl: </em>" & calendarPart.TitleIconImageUrl & _
      "<br />" & _
      "<em>ChildControl ID: </em>" & calendarPart.ChildControl.ID & _
      "<br />" & _
      "<em>ChildControl Type: </em>" & calendarPart.ChildControl.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart ID: </em>" & calendarPart.ID & _
      "<br />" & _
      "<em>GenericWebPart Type: </em>" & calendarPart.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart Parent ID: </em>" & calendarPart.Parent.ID

    Label3.Text = _
      "<h3>BulletedList GenericWebPart Properties</h3>" & _
      "<em>Title: </em>" & listPart.Title & _
      "<br />" & _
      "<em>CatalogIconImageUrl:  </em>" & listPart.CatalogIconImageUrl & _
      "<br />" & _
      "<em>TitleUrl: </em>" & listPart.TitleUrl & _
      "<br />" & _
      "<em>Decription: </em>" & listPart.Description & _
      "<br />" & _
      "<em>TitleIconImageUrl: </em>" & listPart.TitleIconImageUrl & _
      "<br />" & _
      "<em>ChildControl ID: </em>" & listPart.ChildControl.ID & _
      "<br />" & _
      "<em>ChildControl Type: </em>" & listPart.ChildControl.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart ID: </em>" & listPart.ID & _
      "<br />" & _
      "<em>GenericWebPart Type: </em>" & listPart.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart Parent ID: </em>" & listPart.Parent.ID
  End Sub

End Class

Remarks

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.

Applies to

See also

• ASP.NET Web Parts Controls