PanelStyle Class

Definition

Represents the style for a Panel control.

public ref class PanelStyle : System::Web::UI::WebControls::Style
public class PanelStyle : System.Web.UI.WebControls.Style
type PanelStyle = class
    inherit Style
Public Class PanelStyle
Inherits Style
Inheritance

Examples

The following code example demonstrates creating a PanelStyle object and setting its properties. This example has two parts:

A partial class, PanelStylecs_aspx, that demonstrates creating a new PanelStyle object and setting its properties.

A Web Forms page that uses the PanelStylecs_aspx example as its code-behind file.

The first part of the example demonstrates creating a PanelStyle object, myPanelStyle, and setting its properties. Then the ApplyStyle method is called for both the Panel1 panel and the Panel2 panel, and myPanelStyle is applied to both of them.

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

The second part of the example shows an .aspx file that is used with the previous example.

<%@ Page Language="C#" CodeFile="PanelStyle.cs" Inherits="PanelStylecs_aspx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>PanelStyle Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <h3>PanelStyle Example</h3>
      <asp:Panel id="Panel1" 
        runat="server" 
        width="150" 
        height="50">
        This is the Panel1 panel control.
      </asp:Panel>
      <br /><br />
      <asp:Panel id="Panel2" 
        runat="server" 
        width="150" 
        height="50">
        This is the Panel2 panel control.
      </asp:Panel>
    </form>
  </body>
</html>
<%@ Page Language="VB" AutoEventWireup="true" CodeFile="PanelStyle.vb" Inherits="PanelStylevb_aspx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>PanelStyle Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <h3>PanelStyle Example</h3>
      <asp:Panel id="Panel1" 
        runat="server" 
        width="150" 
        height="50">
        This is the Panel1 panel control.
      </asp:Panel>
      <br /><br />
      <asp:Panel id="Panel2" 
        runat="server" 
        width="150" 
        height="50">
        This is the Panel2 panel control.
      </asp:Panel>
    </form>
  </body>
</html>

Remarks

The PanelStyle class is used to represent the style settings for a panel control. It encapsulates the properties that control the appearance of a panel and can be applied to multiple panel controls to provide a common appearance.

You can specify an image to display in the background of the panel by setting the BackImageUrl property. The horizontal alignment of the contents of the panel is indicated by the HorizontalAlign property. The direction of controls that contain text within the panel control can be specified by setting the Direction property.

Constructors

PanelStyle(StateBag)

Initializes a new instance of the PanelStyle class.

Properties

BackColor

Gets or sets the background color of the Web server control.

(Inherited from Style)
BackImageUrl

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

BorderColor

Gets or sets the border color of the Web server control.

(Inherited from Style)
BorderStyle

Gets or sets the border style of the Web server control.

(Inherited from Style)
BorderWidth

Gets or sets the border width of the Web server control.

(Inherited from Style)
CanRaiseEvents

Gets a value indicating whether the component can raise an event.

(Inherited from Component)
Container

Gets the IContainer that contains the Component.

(Inherited from Component)
CssClass

Gets or sets the cascading style sheet (CSS) class rendered by the Web server control on the client.

(Inherited from Style)
DesignMode

Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
Direction

Gets or sets the direction in which to display controls that include text in a panel control.

Events

Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
Font

Gets the font properties associated with the Web server control.

(Inherited from Style)
ForeColor

Gets or sets the foreground color (typically the color of the text) of the Web server control.

(Inherited from Style)
Height

Gets or sets the height of the Web server control.

(Inherited from Style)
HorizontalAlign

Gets or sets the horizontal alignment of the contents within a panel control.

IsEmpty

A protected property. Gets a value indicating whether any style elements have been defined in the state bag.

(Inherited from Style)
IsTrackingViewState

Returns a value indicating whether any style elements have been defined in the state bag.

(Inherited from Style)
RegisteredCssClass

Gets the cascading style sheet (CSS) class that is registered with the control.

(Inherited from Style)
ScrollBars

Gets or sets the visibility and position of scroll bars in a panel control.

Site

Gets or sets the ISite of the Component.

(Inherited from Component)
ViewState

Gets the state bag that holds the style elements.

(Inherited from Style)
Width

Gets or sets the width of the Web server control.

(Inherited from Style)
Wrap

Gets or sets a value indicating whether the content wraps within the panel.

Methods

AddAttributesToRender(HtmlTextWriter)

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriter. This method is primarily used by control developers.

(Inherited from Style)
AddAttributesToRender(HtmlTextWriter, WebControl)

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriter and Web server control. This method is primarily used by control developers.

(Inherited from Style)
CopyFrom(Style)

Duplicates the style properties of the specified Style object for the current instance of the PanelStyle class.

CreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Dispose()

Releases all resources used by the Component.

(Inherited from Component)
Dispose(Boolean)

Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(Inherited from Component)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
FillStyleAttributes(CssStyleCollection, IUrlResolutionService)

Adds the specified object's style properties to a CssStyleCollection object.

(Inherited from Style)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetService(Type)

Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetStyleAttributes(IUrlResolutionService)

Retrieves the CssStyleCollection object for the specified IUrlResolutionService-implemented object.

(Inherited from Style)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
LoadViewState(Object)

Loads the previously saved state.

(Inherited from Style)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
MergeWith(Style)

Combines the style settings of the specified Style object with the current instance of the PanelStyle class.

Reset()

Removes any defined style settings from the PanelStyle class.

SaveViewState()

A protected method. Saves any state that has been modified after the TrackViewState() method was invoked.

(Inherited from Style)
SetBit(Int32)

A protected internal method. Sets an internal bitmask field that indicates the style properties that are stored in the state bag.

(Inherited from Style)
SetDirty()

Marks the Style so that its state will be recorded in view state.

(Inherited from Style)
ToString()

Returns a string that represents the current object.

(Inherited from Style)
TrackViewState()

A protected method. Marks the beginning for tracking state changes on the control. Any changes made after tracking has begun will be tracked and saved as part of the control view state.

(Inherited from Style)

Events

Disposed

Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)

Explicit Interface Implementations

IStateManager.IsTrackingViewState

Gets a value that indicates whether a server control is tracking its view state changes.

(Inherited from Style)
IStateManager.LoadViewState(Object)

Loads the previously saved state.

(Inherited from Style)
IStateManager.SaveViewState()

Returns the object containing state changes.

(Inherited from Style)
IStateManager.TrackViewState()

Starts tracking state changes.

(Inherited from Style)

Applies to

See also