WebZone.BackImageUrl Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the URL to a background image for a zone.

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

public virtual string BackImageUrl { get; set; }

Property Value

Type: System.String

A string that represents the URL to an image used as a background image for the zone. The default value is an empty string ("").

The background image for a zone is visible in all display modes in which a zone's contents are visible. If a zone contains part controls, the image appears behind the controls. If a zone contains no controls, its contents are not rendered in browse mode, so the image is not displayed.

If the supplied image is smaller than the body of a zone, it is tiled to cover the full body area.

The following code example demonstrates the use of the BackImageUrl property. Note that there are two zones in the declarative markup, and the second <asp:webpartzone> element is empty.

<%@ page language="C#" %>
<%@ register TagPrefix="uc1" 
  Src="DisplayModeMenuCS.ascx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" />
          <asp:Calendar ID="cal1" Runat="server" Title="My Calendar" />

In a browser, you can switch to design mode to see the image in the empty zone. Note that an actual URL for the BackImageUrl property is not provided in this example. For details on how to change page display modes, see Walkthrough: Changing Display Modes on a Web Parts Page.

.NET Framework
Available since 2.0
Return to top