PanelStyle.BackImageUrl Property

Definition

Namespace:

System.Web.UI.WebControls

Assembly:

System.Web.dll

Gets or sets the URL of the background image for the panel control.

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

public virtual string BackImageUrl { get; set; }

member this.BackImageUrl : string with get, set

Public Overridable Property BackImageUrl As String

Property Value

String

The URL of the background image for the panel control. The default value is an empty string ("").

Exceptions

ArgumentNullException

The BackImageUrl property is null.

Examples

The following code example applies the same background image to two panel controls, Panel1 and Panel2. For this example to work correctly, you must provide your own image. This code example is part of a larger example provided for the PanelStyle class.

public partial class PanelStylecs_aspx : Page
{
    void Page_Load(object sender, EventArgs e)
    {
        StateBag panelState = new StateBag();
        PanelStyle myPanelStyle = new PanelStyle(panelState);
        
        // Set the properties of the PanelStyle class.
        myPanelStyle.HorizontalAlign = HorizontalAlign.Center;
        myPanelStyle.ScrollBars = ScrollBars.Both;
        myPanelStyle.Wrap = false;
        myPanelStyle.Direction = ContentDirection.LeftToRight;
        myPanelStyle.BackImageUrl = @"~\images\picture.jpg";

        // Use the ApplyStyle method of the Panel control to apply
        // the settings from the myPanelStyle object.
        Panel1.ApplyStyle(myPanelStyle);
        Panel2.ApplyStyle(myPanelStyle); 
    }
}

Partial Class PanelStylevb_aspx
    Inherits Page

    Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)

        Dim panelState As StateBag = New StateBag()
        Dim myPanelStyle As PanelStyle = New PanelStyle(panelState)

        ' Set the properties of the PanelStyle class.
        myPanelStyle.HorizontalAlign = HorizontalAlign.Center
        myPanelStyle.ScrollBars = ScrollBars.Both
        myPanelStyle.Wrap = False
        myPanelStyle.Direction = ContentDirection.LeftToRight
        myPanelStyle.BackImageUrl = "~\images\picture.jpg"

        ' Use the ApplyStyle method of the Panel control to apply
        ' the settings from the myPanelStyle object.
        Panel1.ApplyStyle(myPanelStyle)
        Panel2.ApplyStyle(myPanelStyle)
        
    End Sub

End Class

Remarks

The BackImageUrl property specifies the URL of the background image for the panel control. For this property to work, an image file must exist at the specified location. If the specified image file is not accessible, then the panel control is displayed without a background image.