PanelContainerDesigner Class

Definition

Namespace:

System.Web.UI.Design.WebControls

Assembly:

System.Design.dll

Provides design-time support in a visual designer for the Panel control.

public ref class PanelContainerDesigner : System::Web::UI::Design::ContainerControlDesigner

public class PanelContainerDesigner : System.Web.UI.Design.ContainerControlDesigner

type PanelContainerDesigner = class
    inherit ContainerControlDesigner

Public Class PanelContainerDesigner
Inherits ContainerControlDesigner

Inheritance

Object

ComponentDesigner

HtmlControlDesigner

ControlDesigner

ContainerControlDesigner

PanelContainerDesigner

Examples

The following code example shows how to extend the PanelContainerDesigner class to change the appearance and behavior of controls that are derived from the Panel control at design time.

The example derives the MyPanelContainer class from the Panel control. The example also derives the MyPanelContainerDesigner class from the PanelContainerDesigner class and applies a DesignerAttribute attribute for the MyPanelContainerDesigner on the MyPanelContainer class.

The MyPanelContainerDesigner overrides the following PanelContainerDesigner members:

• The FrameStyle property to define a design-time border style for the MyPanelContainer control.

• The FrameCaption property to provide a default caption for the MyPanelContainer control, if none was defined.

• The Initialize method to throw an ArgumentException exception, if the associated control is not a MyPanelContainer object.

using System;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.Design.WebControls;
using System.ComponentModel;
using System.Security.Permissions;

namespace Examples.CS.WebControls.Design
{
    // The MyPanelContainer is a copy of the Panel.
    [AspNetHostingPermission(SecurityAction.Demand, 
        Level = AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand, 
        Level = AspNetHostingPermissionLevel.Minimal)]
    [Designer(typeof(Examples.CS.WebControls.Design.MyPanelContainerDesigner))]
    public class MyPanelContainer : Panel
    {
    } // MyPanelContainer

    // Override members of the PanelContainerDesigner.
    public class MyPanelContainerDesigner : PanelContainerDesigner
    {
        // Provide a design-time caption for the panel.
        public override string FrameCaption 
        {
            get
            {
                // If the FrameCaption is empty, use the panel control ID.
                string localCaption = base.FrameCaption;
                if (localCaption == null || localCaption == "")
                    localCaption = ((Panel)Component).ID.ToString();

                return localCaption;
            }
        } // FrameCaption

        // Provide a design-time border style for the panel.
        public override Style FrameStyle
        {
            get
            {
                Style styleOfFrame = base.FrameStyle;

                // If no border style is defined, define one.
                if (styleOfFrame.BorderStyle == BorderStyle.NotSet ||
                    styleOfFrame.BorderStyle == BorderStyle.None)
                    styleOfFrame.BorderStyle = BorderStyle.Outset;

                return styleOfFrame;
            }
        } // FrameStyle

        // Initialize the designer.
        public override void Initialize(IComponent component)
        {
            // Ensure that only a MyPanelContainer can be created 
            // in this designer.
            if (!(component is MyPanelContainer))
                throw new ArgumentException();
            
            base.Initialize(component);
        } // Initialize
    } // MyPanelContainerDesigner
} // Examples.CS.WebControls.Design

Imports System.Web
Imports System.Web.UI.WebControls
Imports System.Web.UI.Design.WebControls
Imports System.ComponentModel
Imports System.Security.Permissions

Namespace Examples.VB.WebControls.Design

    ' The MyPanelContainer is a copy of the PanelContainer.
    <AspNetHostingPermission(SecurityAction.Demand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
    <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
    <Designer(GetType(Examples.VB.WebControls.Design.MyPanelContainerDesigner))> _
    Public Class MyPanelContainer
        Inherits Panel
    End Class

    ' Override members of the PanelContainerDesigner.
    Public Class MyPanelContainerDesigner
        Inherits PanelContainerDesigner

        ' Provide a design-time caption for the panel.
        Public Overrides ReadOnly Property FrameCaption() As String
            Get
                ' If the FrameCaption is empty, use the panel control ID.
                Dim localCaption As String = MyBase.FrameCaption
                If localCaption Is Nothing Or localCaption = "" Then
                    localCaption = CType(Component, Panel).ID.ToString()
                End If

                Return localCaption
            End Get
        End Property ' FrameCaption

        ' Provide a design-time border style for the panel.
        Public Overrides ReadOnly Property FrameStyle() As Style
            Get
                Dim styleOfFrame As Style = MyBase.FrameStyle

                ' If no border style is defined, define one.
                If (styleOfFrame.BorderStyle = BorderStyle.NotSet Or _
                    styleOfFrame.BorderStyle = BorderStyle.None) Then
                    styleOfFrame.BorderStyle = BorderStyle.Outset
                End If

                Return styleOfFrame
            End Get
        End Property ' FrameStyle

        ' Initialize the designer.
        Public Overrides Sub Initialize(ByVal component As IComponent)

            ' Ensure that only a MyPanelContainer can be created   
            ' in this designer. 
            If Not TypeOf component Is MyPanelContainer Then
                Throw New ArgumentException()
            End If

            MyBase.Initialize(component)

        End Sub
    End Class
End Namespace ' Examples.VB.WebControls.Design

Remarks

The Panel control is used as a container for other controls, especially when controls are generated programmatically.

In a visual designer, when you switch from Source to Design view, the markup source code that describes the associated Panel control is parsed, and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to markup source code and edited into the markup for the Web page. The PanelContainerDesigner class provides design-time support for Panel controls in a visual designer.

The FrameCaption property gets the caption that appears on the associated Panel control. The FrameStyle property gets the styles of the associated control.

The UsePreviewControl property always returns true, indicating that the designer creates a temporary copy of the associated Panel to generate the design-time markup.

The Initialize method prepares the designer to view, edit, and design the associated Panel control. The AddDesignTimeCssAttributes method sets collection elements to the string representations of various style attributes of the associated control.

Constructors

PanelContainerDesigner()

Initializes a new instance of the PanelContainerDesigner class.

Properties

ActionLists	Gets the action list collection for the control designer. (Inherited from ControlDesigner)
AllowResize	Gets a value indicating if the control can be resized at design time. (Inherited from ContainerControlDesigner)
AssociatedComponents	Gets the collection of components associated with the component managed by the designer. (Inherited from ComponentDesigner)
AutoFormats	Gets the collection of predefined automatic formatting schemes to display in the Auto Format dialog box for the associated control at design time. (Inherited from ControlDesigner)
Behavior	Obsolete. Gets or sets the DHTML behavior that is associated with the designer. (Inherited from HtmlControlDesigner)
Component	Gets the component this designer is designing. (Inherited from ComponentDesigner)
DataBindings	Gets the data bindings collection for the current control. (Inherited from HtmlControlDesigner)
DataBindingsEnabled	Gets a value indicating whether data binding is supported by the containing region for the associated control. (Inherited from ControlDesigner)
DesignerState	Gets an object that is used to persist data for the associated control at design time. (Inherited from ControlDesigner)
DesignTimeElement	Obsolete. Gets the design-time object representing the control that is associated with the HtmlControlDesigner object on the design surface. (Inherited from HtmlControlDesigner)
DesignTimeElementView	Obsolete. Gets the view-control object for the control designer. (Inherited from ControlDesigner)
DesignTimeHtmlRequiresLoadComplete	Obsolete. Gets a value indicating whether the design host must finish loading before the GetDesignTimeHtml method can be called. (Inherited from ControlDesigner)
Expressions	Gets the expression bindings for the current control at design time. (Inherited from HtmlControlDesigner)
FrameCaption	Gets the caption that appears on the associated Panel control.
FrameStyle	Gets the styles of the associated Panel control.
HidePropertiesInTemplateMode	Gets a value indicating whether the properties of the associated control are hidden when the control is in template mode. (Inherited from ControlDesigner)
ID	Gets or sets the ID string for the control. (Inherited from ControlDesigner)
InheritanceAttribute	Gets an attribute that indicates the type of inheritance of the associated component. (Inherited from ComponentDesigner)
Inherited	Gets a value indicating whether this component is inherited. (Inherited from ComponentDesigner)
InTemplateMode	Gets a value indicating whether the control is in either template viewing or editing mode in the design host. The InTemplateMode property is read-only. (Inherited from ControlDesigner)
IsDirty	Obsolete. Gets or sets a value indicating whether the Web server control has been marked as changed. (Inherited from ControlDesigner)
NoWrap	Gets a value that specifies whether to use the HTML nowrap attribute on tables. (Inherited from ContainerControlDesigner)
ParentComponent	Gets the parent component for this designer. (Inherited from ComponentDesigner)
ReadOnly	Obsolete. Gets or sets a value indicating whether the properties of the control are read-only at design time. (Inherited from ControlDesigner)
RootDesigner	Gets the control designer for the Web Forms page that contains the associated control. (Inherited from ControlDesigner)
SetTextualDefaultProperty	(Inherited from ComponentDesigner)
ShadowProperties	Gets a collection of property values that override user settings. (Inherited from ComponentDesigner)
ShouldCodeSerialize	Obsolete. Gets or sets a value indicating whether to create a field declaration for the control in the code-behind file for the current design document during serialization. (Inherited from HtmlControlDesigner)
Tag	Gets an object representing the HTML markup element for the associated control. (Inherited from ControlDesigner)
TemplateGroups	Gets a collection of template groups, each containing one or more template definitions. (Inherited from ControlDesigner)
UsePreviewControl	Gets a value indicating whether the designer should use a temporary copy rather than the actual control that is associated with the designer to generate the design-time markup.
Verbs	Gets the design-time verbs supported by the component that is associated with the designer. (Inherited from ComponentDesigner)
ViewControl	Gets or sets a Web server control that can be used for previewing the design-time HTML markup. (Inherited from ControlDesigner)
ViewControlCreated	Gets or sets a value indicating whether a View control has been created for display on the design surface. (Inherited from ControlDesigner)
Visible	Gets a value that indicates whether the control is visible at design time. (Inherited from ControlDesigner)

Methods

AddDesignTimeCssAttributes(IDictionary)	Adds string representations of style attributes to a collection to be used in the design-time rendering of the control.
CreateErrorDesignTimeHtml(String, Exception)	Creates the HTML markup to display a specified exception error message at design time. (Inherited from ControlDesigner)
CreateErrorDesignTimeHtml(String)	Creates HTML markup to display a specified error message at design time. (Inherited from ControlDesigner)
CreatePlaceHolderDesignTimeHtml()	Provides a simple rectangular placeholder representation that displays the type and ID of the control. (Inherited from ControlDesigner)
CreatePlaceHolderDesignTimeHtml(String)	Provides a simple rectangular placeholder representation that displays the type and ID of the control, and also additional specified instructions or information. (Inherited from ControlDesigner)
CreateViewControl()	Returns a copy of the associated control for viewing or rendering on the design surface. (Inherited from ControlDesigner)
Dispose()	Releases all resources used by the ComponentDesigner. (Inherited from ComponentDesigner)
Dispose(Boolean)	Releases the unmanaged resources that are used by the HtmlControlDesigner object and optionally releases the managed resources. (Inherited from HtmlControlDesigner)
DoDefaultAction()	Creates a method signature in the source code file for the default event on the component and navigates the user's cursor to that location. (Inherited from ComponentDesigner)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetBounds()	Retrieves the coordinates of the rectangle representing the boundaries for the control as displayed on the design surface. (Inherited from ControlDesigner)
GetDesignTimeCssAttributes()	Returns the collection of style attributes for the control at design time. (Inherited from ContainerControlDesigner)
GetDesignTimeHtml()	Retrieves the HTML markup that is used to represent the control at design time. (Inherited from ControlDesigner)
GetDesignTimeHtml(DesignerRegionCollection)	Returns the HTML markup that is used to represent the control at design time. (Inherited from ContainerControlDesigner)
GetEditableDesignerRegionContent(EditableDesignerRegion)	Returns the content for the editable region of the control at design time. (Inherited from ContainerControlDesigner)
GetEmptyDesignTimeHtml()	Retrieves the HTML markup to represent a Web server control at design time that will have no visual representation at run time. (Inherited from ControlDesigner)
GetErrorDesignTimeHtml(Exception)	Retrieves the HTML markup that provides information about the specified exception. (Inherited from ControlDesigner)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetPersistenceContent()	Returns the persistable content of the control at design time. (Inherited from ContainerControlDesigner)
GetPersistInnerHtml()	Obsolete. Retrieves the persistable inner HTML markup of the control. (Inherited from ControlDesigner)
GetService(Type)	Attempts to retrieve the specified type of service from the design mode site of the designer's component. (Inherited from ComponentDesigner)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetViewRendering()	Retrieves an object that contains the design-time markup for the content and regions of the associated control. (Inherited from ControlDesigner)
Initialize(IComponent)	Prepares the designer to view, edit, and design the associated control.
InitializeExistingComponent(IDictionary)	Reinitializes an existing component. (Inherited from ComponentDesigner)
InitializeNewComponent(IDictionary)	Initializes a newly created component. (Inherited from ComponentDesigner)
InitializeNonDefault()	Obsolete. Initializes the settings for an imported component that is already initialized to settings other than the defaults. (Inherited from ComponentDesigner)
Invalidate()	Invalidates the whole area of the control that is displayed on the design surface and signals the control designer to redraw the control. (Inherited from ControlDesigner)
Invalidate(Rectangle)	Invalidates the specified area of the control that is displayed on the design surface and signals the control designer to redraw the control. (Inherited from ControlDesigner)
InvokeGetInheritanceAttribute(ComponentDesigner)	Gets the InheritanceAttribute of the specified ComponentDesigner. (Inherited from ComponentDesigner)
IsPropertyBound(String)	Obsolete. Retrieves a value indicating whether the specified property on the associated control is data-bound. (Inherited from ControlDesigner)
Localize(IDesignTimeResourceWriter)	Uses the provided resource writer to persist the localizable properties of the associated control to a resource in the design host. (Inherited from ControlDesigner)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAutoFormatApplied(DesignerAutoFormat)	Called when a predefined, automatic formatting scheme has been applied to the associated control. (Inherited from ControlDesigner)
OnBehaviorAttached()	Called when the control designer is attached to a Behavior object. (Inherited from ControlDesigner)
OnBehaviorDetaching()	Obsolete. Called when a behavior disassociates from the element. (Inherited from HtmlControlDesigner)
OnBindingsCollectionChanged(String)	Obsolete. Called when the data-binding collection changes. (Inherited from ControlDesigner)
OnClick(DesignerRegionMouseEventArgs)	Called by the design host when the user clicks the associated control at design time. (Inherited from ControlDesigner)
OnComponentChanged(Object, ComponentChangedEventArgs)	Called when the associated control changes. (Inherited from ControlDesigner)
OnComponentChanging(Object, ComponentChangingEventArgs)	Represents the method that will handle the ComponentChanging event for the associated control. (Inherited from ControlDesigner)
OnControlResize()	Obsolete. Called when the associated Web server control has been resized in the design host at design time. (Inherited from ControlDesigner)
OnPaint(PaintEventArgs)	Called when the control designer draws the associated control on the design surface, if the CustomPaint value is true. (Inherited from ControlDesigner)
OnSetComponentDefaults()	Obsolete. Sets the default properties for the component. (Inherited from ComponentDesigner)
OnSetParent()	Provides a way to perform additional processing when the associated control is attached to a parent control. (Inherited from HtmlControlDesigner)
PostFilterAttributes(IDictionary)	Allows a designer to change or remove items from the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner)
PostFilterEvents(IDictionary)	Allows a designer to change or remove items from the set of events that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner)
PostFilterProperties(IDictionary)	Allows a designer to change or remove items from the set of properties that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner)
PreFilterAttributes(IDictionary)	Allows a designer to add to the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner)
PreFilterEvents(IDictionary)	Sets the list of events that are exposed at design-time for the TypeDescriptor object for the component. (Inherited from HtmlControlDesigner)
PreFilterProperties(IDictionary)	Adds properties to or removes properties from the Properties grid in a design host at design time or provides new design-time properties that might correspond to properties on the associated control. (Inherited from ControlDesigner)
RaiseComponentChanged(MemberDescriptor, Object, Object)	Notifies the IComponentChangeService that this component has been changed. (Inherited from ComponentDesigner)
RaiseComponentChanging(MemberDescriptor)	Notifies the IComponentChangeService that this component is about to be changed. (Inherited from ComponentDesigner)
RaiseResizeEvent()	Obsolete. Raises the OnControlResize() event. (Inherited from ControlDesigner)
RegisterClone(Object, Object)	Registers internal data in a cloned control. (Inherited from ControlDesigner)
SetEditableDesignerRegionContent(EditableDesignerRegion, String)	Sets the content for the editable region of the control at design time. (Inherited from ContainerControlDesigner)
SetRegionContent(EditableDesignerRegion, String)	Specifies the content for an editable region in the design-time view of the control. (Inherited from ControlDesigner)
SetViewFlags(ViewFlags, Boolean)	Assigns the specified bitwise ViewFlags enumeration to the specified flag value. (Inherited from ControlDesigner)
ToString()	Returns a string that represents the current object. (Inherited from Object)
UpdateDesignTimeHtml()	Refreshes the design-time HTML markup for the associated Web server control by calling the GetDesignTimeHtml method. (Inherited from ControlDesigner)

Explicit Interface Implementations

IDesignerFilter.PostFilterAttributes(IDictionary)	For a description of this member, see the PostFilterAttributes(IDictionary) method. (Inherited from ComponentDesigner)
IDesignerFilter.PostFilterEvents(IDictionary)	For a description of this member, see the PostFilterEvents(IDictionary) method. (Inherited from ComponentDesigner)
IDesignerFilter.PostFilterProperties(IDictionary)	For a description of this member, see the PostFilterProperties(IDictionary) method. (Inherited from ComponentDesigner)
IDesignerFilter.PreFilterAttributes(IDictionary)	For a description of this member, see the PreFilterAttributes(IDictionary) method. (Inherited from ComponentDesigner)
IDesignerFilter.PreFilterEvents(IDictionary)	For a description of this member, see the PreFilterEvents(IDictionary) method. (Inherited from ComponentDesigner)
IDesignerFilter.PreFilterProperties(IDictionary)	For a description of this member, see the PreFilterProperties(IDictionary) method. (Inherited from ComponentDesigner)
ITreeDesigner.Children	For a description of this member, see the Children property. (Inherited from ComponentDesigner)
ITreeDesigner.Parent	For a description of this member, see the Parent property. (Inherited from ComponentDesigner)

See also

• Panel
• ContainerControlDesigner
• ControlDesigner
• HtmlControlDesigner
• ComponentDesigner
• Introduction to ASP.NET Control Designers
• Walkthrough: Creating a Basic Control Designer for a Web Server Control