Export (0) Print
Expand All

ControlDesigner Class

Provides a base control designer class for extending the design-mode behavior of a Web server control.

Namespace:  System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)

[SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public class ControlDesigner : HtmlControlDesigner

The ControlDesigner type exposes the following members.

  NameDescription
Public methodControlDesignerInitializes a new instance of the ControlDesigner class.
Top

  NameDescription
Public propertyActionListsGets the action list collection for the control designer. (Overrides ComponentDesigner.ActionLists.)
Public propertyAllowResizeGets a value indicating whether the control can be resized in the design-time environment.
Public propertyAssociatedComponentsGets the collection of components associated with the component managed by the designer. (Inherited from ComponentDesigner.)
Public propertyAutoFormatsGets the collection of predefined automatic formatting schemes to display in the Auto Format dialog box for the associated control at design time.
Public propertyBehavior Obsolete. Gets or sets the DHTML behavior that is associated with the designer. (Inherited from HtmlControlDesigner.)
Public propertyComponentGets the component this designer is designing. (Inherited from ComponentDesigner.)
Public propertyDataBindingsGets the data bindings collection for the current control. (Inherited from HtmlControlDesigner.)
Protected propertyDataBindingsEnabledGets a value indicating whether data binding is supported by the containing region for the associated control.
Protected propertyDesignerStateGets an object that is used to persist data for the associated control at design time.
Protected propertyDesignTimeElement Obsolete. Gets the design-time object representing the control that is associated with the HtmlControlDesigner object on the design surface. (Inherited from HtmlControlDesigner.)
Protected propertyDesignTimeElementView Obsolete. Gets the view-control object for the control designer.
Public propertyDesignTimeHtmlRequiresLoadComplete Obsolete. Gets a value indicating whether the design host must finish loading before the GetDesignTimeHtml method can be called.
Public propertyExpressionsGets the expression bindings for the current control at design time. (Inherited from HtmlControlDesigner.)
Protected propertyHidePropertiesInTemplateModeInfrastructure. Gets a value indicating whether the properties of the associated control are hidden when the control is in template mode.
Public propertyIDGets or sets the ID string for the control.
Protected propertyInheritanceAttributeGets an attribute that indicates the type of inheritance of the associated component. (Inherited from ComponentDesigner.)
Protected propertyInheritedGets a value indicating whether this component is inherited. (Inherited from ComponentDesigner.)
Protected propertyInTemplateModeGets a value indicating whether the control is in either template viewing or editing mode in the design host. The InTemplateMode property is read-only.
Public propertyIsDirty Obsolete. Gets or sets a value indicating whether the Web server control has been marked as changed.
Protected propertyParentComponentGets the parent component for this designer. (Inherited from ComponentDesigner.)
Public propertyReadOnly Obsolete. Gets or sets a value indicating whether the properties of the control are read-only at design time.
Protected propertyRootDesignerGets the control designer for the Web Forms page that contains the associated control.
Protected propertyShadowPropertiesGets a collection of property values that override user settings. (Inherited from ComponentDesigner.)
Public propertyShouldCodeSerialize 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.)
Protected propertyTagGets an object representing the HTML markup element for the associated control.
Public propertyTemplateGroupsGets a collection of template groups, each containing one or more template definitions.
Protected propertyUsePreviewControlGets a value indicating whether the control designer uses a temporary preview control to generate the design-time HTML markup.
Public propertyVerbsGets the design-time verbs supported by the component that is associated with the designer. (Inherited from ComponentDesigner.)
Public propertyViewControlGets or sets a Web server control that can be used for previewing the design-time HTML markup.
Public propertyViewControlCreatedGets or sets a value indicating whether a View control has been created for display on the design surface.
Protected propertyVisibleGets a value that indicates whether the control is visible at design time.
Top

  NameDescription
Protected methodCreateErrorDesignTimeHtml(String)Creates HTML markup to display a specified error message at design time.
Protected methodCreateErrorDesignTimeHtml(String, Exception)Creates the HTML markup to display a specified exception error message at design time.
Protected methodCreatePlaceHolderDesignTimeHtml()Provides a simple rectangular placeholder representation that displays the type and ID of the control.
Protected methodCreatePlaceHolderDesignTimeHtml(String)Provides a simple rectangular placeholder representation that displays the type and ID of the control, and also additional specified instructions or information.
Protected methodCreateViewControlReturns a copy of the associated control for viewing or rendering on the design surface.
Public methodDispose()Releases all resources used by the ComponentDesigner. (Inherited from ComponentDesigner.)
Protected methodDispose(Boolean)Releases the unmanaged resources that are used by the HtmlControlDesigner object and optionally releases the managed resources. (Inherited from HtmlControlDesigner.)
Public methodDoDefaultActionCreates 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.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAttempts to free resources by calling Dispose(false) before the object is reclaimed by garbage collection. (Inherited from ComponentDesigner.)
Public methodGetBoundsRetrieves the coordinates of the rectangle representing the boundaries for the control as displayed on the design surface.
Public methodGetDesignTimeHtml()Retrieves the HTML markup that is used to represent the control at design time.
Public methodGetDesignTimeHtml(DesignerRegionCollection)Retrieves the HTML markup to display the control and populates the collection with the current control designer regions.
Public methodStatic memberGetDesignTimeResourceProviderFactoryReturns an appropriate resource provider factory, depending on the globalization settings in the configuration file for the site.
Public methodGetEditableDesignerRegionContentReturns the content for an editable region of the design-time view of the associated control.
Protected methodGetEmptyDesignTimeHtmlRetrieves the HTML markup to represent a Web server control at design time that will have no visual representation at run time.
Protected methodGetErrorDesignTimeHtmlRetrieves the HTML markup that provides information about the specified exception.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetPersistenceContentRetrieves the persistable inner HTML markup of the control at design time.
Public methodGetPersistInnerHtml Obsolete. Retrieves the persistable inner HTML markup of the control.
Protected methodGetServiceAttempts to retrieve the specified type of service from the design mode site of the designer's component. (Inherited from ComponentDesigner.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetViewRendering()Retrieves an object that contains the design-time markup for the content and regions of the associated control.
Public methodStatic memberGetViewRendering(Control)Retrieves an object that contains the design-time markup for the content and regions of the specified control.
Public methodStatic memberGetViewRendering(ControlDesigner)Retrieves an object that contains the design-time markup for the content and regions of the associated control for the specified control designer.
Public methodInitializeInitializes the control designer and loads the specified component. (Overrides HtmlControlDesigner.Initialize(IComponent).)
Public methodInitializeExistingComponentReinitializes an existing component. (Inherited from ComponentDesigner.)
Public methodInitializeNewComponentInitializes a newly created component. (Inherited from ComponentDesigner.)
Public methodInitializeNonDefault Obsolete. Initializes the settings for an imported component that is already initialized to settings other than the defaults. (Inherited from ComponentDesigner.)
Public methodInvalidate()Invalidates the whole area of the control that is displayed on the design surface and signals the control designer to redraw the control.
Public methodInvalidate(Rectangle)Invalidates the specified area of the control that is displayed on the design surface and signals the control designer to redraw the control.
Protected methodInvokeGetInheritanceAttributeGets the InheritanceAttribute of the specified ComponentDesigner. (Inherited from ComponentDesigner.)
Public methodStatic memberInvokeTransactedChange(IComponent, TransactedChangeCallback, Object, String)Wraps a series of changes into a transaction, using the specified parameters that can be rolled back as a unit with the undo functionality of the design host.
Public methodStatic memberInvokeTransactedChange(IComponent, TransactedChangeCallback, Object, String, MemberDescriptor)Wraps a series of changes into a transaction, using the specified parameters that can be rolled back as a unit with the undo functionality of the design host.
Public methodStatic memberInvokeTransactedChange(IServiceProvider, IComponent, TransactedChangeCallback, Object, String, MemberDescriptor)Wraps a series of changes into a transaction, using the specified parameters that can be rolled back as a unit with the undo functionality of the design host.
Public methodIsPropertyBound Obsolete. Retrieves a value indicating whether the specified property on the associated control is data-bound.
Public methodLocalizeUses the provided resource writer to persist the localizable properties of the associated control to a resource in the design host.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnAutoFormatAppliedCalled when a predefined, automatic formatting scheme has been applied to the associated control.
Protected methodOnBehaviorAttached Obsolete. Called when a behavior is associated with the element. (Inherited from HtmlControlDesigner.)
Protected methodOnBehaviorDetaching Obsolete. Called when a behavior disassociates from the element. (Inherited from HtmlControlDesigner.)
Protected methodOnBindingsCollectionChanged Obsolete. Called when the data-binding collection changes. (Overrides HtmlControlDesigner.OnBindingsCollectionChanged(String).)
Protected methodOnClickCalled by the design host when the user clicks the associated control at design time.
Public methodOnComponentChangedCalled when the associated control changes.
Public methodOnComponentChangingRepresents the method that will handle the ComponentChanging event for the associated control.
Protected methodOnControlResize Obsolete. Called when the associated Web server control has been resized in the design host at design time.
Protected methodOnPaintCalled when the control designer draws the associated control on the design surface, if the CustomPaint value is true.
Public methodOnSetComponentDefaults Obsolete. Sets the default properties for the component. (Inherited from ComponentDesigner.)
Public methodOnSetParentProvides a way to perform additional processing when the associated control is attached to a parent control. (Inherited from HtmlControlDesigner.)
Protected methodPostFilterAttributesAllows a designer to change or remove items from the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
Protected methodPostFilterEventsAllows a designer to change or remove items from the set of events that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
Protected methodPostFilterPropertiesAllows a designer to change or remove items from the set of properties that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
Protected methodPreFilterAttributesAllows a designer to add to the set of attributes that it exposes through a TypeDescriptor. (Inherited from ComponentDesigner.)
Protected methodPreFilterEventsSets the list of events that are exposed at design-time for the TypeDescriptor object for the component. (Inherited from HtmlControlDesigner.)
Protected methodPreFilterPropertiesAdds 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. (Overrides HtmlControlDesigner.PreFilterProperties(IDictionary).)
Protected methodRaiseComponentChangedNotifies the IComponentChangeService that this component has been changed. (Inherited from ComponentDesigner.)
Protected methodRaiseComponentChangingNotifies the IComponentChangeService that this component is about to be changed. (Inherited from ComponentDesigner.)
Public methodRaiseResizeEvent Obsolete. Raises the OnControlResize event.
Public methodRegisterCloneRegisters internal data in a cloned control.
Public methodSetEditableDesignerRegionContentSpecifies the content for an editable region of the control at design time.
Protected methodSetRegionContentSpecifies the content for an editable region in the design-time view of the control.
Protected methodSetViewFlagsAssigns the specified bitwise ViewFlags enumeration to the specified flag value.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUpdateDesignTimeHtmlRefreshes the design-time HTML markup for the associated Web server control by calling the GetDesignTimeHtml method.
Top

  NameDescription
Explicit interface implemetationPrivate methodIDesignerFilter.PostFilterAttributesFor a description of this member, see the IDesignerFilter.PostFilterAttributes method. (Inherited from ComponentDesigner.)
Explicit interface implemetationPrivate methodIDesignerFilter.PostFilterEventsFor a description of this member, see the IDesignerFilter.PostFilterEvents method. (Inherited from ComponentDesigner.)
Explicit interface implemetationPrivate methodIDesignerFilter.PostFilterPropertiesFor a description of this member, see the IDesignerFilter.PostFilterProperties method. (Inherited from ComponentDesigner.)
Explicit interface implemetationPrivate methodIDesignerFilter.PreFilterAttributesFor a description of this member, see the IDesignerFilter.PreFilterAttributes method. (Inherited from ComponentDesigner.)
Explicit interface implemetationPrivate methodIDesignerFilter.PreFilterEventsFor a description of this member, see the IDesignerFilter.PreFilterEvents method. (Inherited from ComponentDesigner.)
Explicit interface implemetationPrivate methodIDesignerFilter.PreFilterPropertiesFor a description of this member, see the IDesignerFilter.PreFilterProperties method. (Inherited from ComponentDesigner.)
Explicit interface implemetationPrivate propertyITreeDesigner.ChildrenFor a description of this member, see the ITreeDesigner.Children property. (Inherited from ComponentDesigner.)
Explicit interface implemetationPrivate propertyITreeDesigner.ParentFor a description of this member, see the ITreeDesigner.Parent property. (Inherited from ComponentDesigner.)
Top

The ControlDesigner class provides a base control designer class that can be inherited from and extended to provide design-time support for a Web server control in a design host, such as Visual Studio 2005.

The object model for working with design-time rendering is improved over earlier versions, with the following new base classes to provide access to the simplified object model:

Automatic Formatting

You can create a variety of automatic and pre-defined formats that can simplify the process of page developers who are applying complex style changes to custom Web server controls. For example, the TableDesigner control, which derives from the ControlDesigner class, provides many automatic formats from which to choose. To implement and provide automatic formatting in your custom controls, use the following features:

Action Lists (Smart Tags)

Action lists are menus of important or widely used tasks that a page developer who uses a control can perform in a design-time user interface (UI), such as Visual Studio 2005. For example, the design-time view of your control could provide a menu of available tasks. This includes a task to format the control automatically. To learn about action lists, start with the following features:

Control Designer Regions

Regions are editable areas in the design-time view of a Web server control. This feature offers WYSIWYG-like editing of the template content, inner controls, and properties at design time. You can have the control designer create controls in regions or you can use the Toolbox to drag and drop controls into regions. Regions are managed with the following features:

Templates

The model for creating a UI for design-time editing of templated controls, such as the GridView control, has been greatly improved from earlier versions. You can create complex custom controls that include templates for various parts of the control, and your custom control designer can help page developers who are modifying templates with the following features:

Design-Time Rendering

The ControlDesigner class has the following methods to support design-time rendering of the Web server control. Most of these methods are the same as in earlier versions:

The following code example demonstrates how to create a simple designer class that derives from the ControlDesigner class. This control designer supports a custom TextControl class and provides a command to change the text size of a control at design time. The control designer is associated with the control by specifying the control designer in a DesignerAttribute object declaration on the TextControl class. The key to persisting property changes from the control designer to the HTML markup is found in the ToggleTextSize method of the custom ActionList class.

To try the example, add a reference to the System.Design.dll assembly and compile the code.


using System;
using System.Web.UI;
using System.Drawing;
using System.Web.UI.Design;
using System.Web.UI.WebControls;
using System.ComponentModel;
using System.ComponentModel.Design;

namespace ASPNet.Design.Samples.CS
{
    // Simple text Web control renders a text string.
    // This control is associated with the TextSizeWebControlDesigner.
    [DesignerAttribute(typeof(TextSizeWebControlDesigner)),
    ToolboxData("<{0}:TextControl runat=\"server\"></{0}:TextControl>")]
    public class TextControl : Label
    {
        private bool _largeText = true;

        // Constructor
        public TextControl()
        {
            Text = "Test Phrase";
            SetSize();
        }

        // Determines whether the text is large or small
        [Bindable(true), Category("Appearance"), DefaultValue("true")]
        public bool LargeText
        {
            get { return _largeText; }
            set
            {
                _largeText = value;
                SetSize();
            }
        }

        // Applies the LargeText property to the control
        private void SetSize()
        {
            if (LargeText)
                this.Font.Size = FontUnit.XLarge;
            else
                this.Font.Size = FontUnit.Small;
        }
    }

    // This control designer offers DesignerActionList commands
    // that can alter the design time html of the associated control.
    public class TextSizeWebControlDesigner : ControlDesigner
    {
        private DesignerActionListCollection _actionLists = null;

        // Do not allow direct resizing of the control
        public override bool AllowResize
        {
            get { return false; }
        }

        // Return a custom ActionList collection
        public override DesignerActionListCollection ActionLists
        {
            get
            {
                if (_actionLists == null)
                {
                    _actionLists = new DesignerActionListCollection();
                    _actionLists.AddRange(base.ActionLists);

                    // Add a custom DesignerActionList
                    _actionLists.Add(new ActionList(this));
                }
                return _actionLists;
            }
        }

        public class ActionList : DesignerActionList
        {
            private TextSizeWebControlDesigner _parent;
            private DesignerActionItemCollection _items;

            // Constructor
            public ActionList(TextSizeWebControlDesigner parent)
                : base(parent.Component)
            {
                _parent = parent;

            }

            // Create the ActionItem collection and add one command
            public override DesignerActionItemCollection GetSortedActionItems()
            {
                if (_items == null)
                {
                    _items = new DesignerActionItemCollection();
                    _items.Add(new DesignerActionMethodItem(this, "ToggleLargeText", "Toggle Text Size", true));
                }
                return _items;
            }

            // ActionList command to change the text size
            private void ToggleLargeText()
            {
                // Get a reference to the parent designer's associated control
                TextControl ctl = (TextControl)_parent.Component;

                // Get a reference to the control's LargeText property
                PropertyDescriptor propDesc = TypeDescriptor.GetProperties(ctl)["LargeText"];

                // Get the current value of the property
                bool v = (bool)propDesc.GetValue(ctl);

                // Toggle the property value
                propDesc.SetValue(ctl, !v);
            }
        }
    }
}


...


<%@ Page Language="C#" %>
<%@ Register TagPrefix="aspSample" 
    Namespace="ASPNet.Design.Samples.CS" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>

    <aspSample:TextControl ID="TextControl1" runat="server">
    </aspSample:TextControl>


    </div>
    </form>
</body>
</html>


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

System.Object
  System.ComponentModel.Design.ComponentDesigner
    System.Web.UI.Design.HtmlControlDesigner
      System.Web.UI.Design.ControlDesigner
        System.Web.DynamicData.Design.DynamicDataManagerDesigner
        System.Web.UI.Design.ContainerControlDesigner
        System.Web.UI.Design.DataSourceDesigner
        System.Web.UI.Design.ExtenderControlDesigner
        System.Web.UI.Design.HierarchicalDataSourceDesigner
        System.Web.UI.Design.QueryExtenderDesigner
        System.Web.UI.Design.ReadWriteControlDesigner
        System.Web.UI.Design.ScriptManagerDesigner
        System.Web.UI.Design.ScriptManagerProxyDesigner
        System.Web.UI.Design.TemplatedControlDesigner
        System.Web.UI.Design.TextControlDesigner
        System.Web.UI.Design.TimerDesigner
        System.Web.UI.Design.UpdatePanelDesigner
        System.Web.UI.Design.UpdateProgressDesigner
        System.Web.UI.Design.UserControlDesigner
        System.Web.UI.Design.WebControls.BaseDataBoundControlDesigner
        System.Web.UI.Design.WebControls.ButtonDesigner
        System.Web.UI.Design.WebControls.CalendarDesigner
        System.Web.UI.Design.WebControls.ChangePasswordDesigner
        System.Web.UI.Design.WebControls.CheckBoxDesigner
        System.Web.UI.Design.WebControls.CompositeControlDesigner
        System.Web.UI.Design.WebControls.ContentDesigner
        System.Web.UI.Design.WebControls.ContentPlaceHolderDesigner
        System.Web.UI.Design.WebControls.DataPagerDesigner
        System.Web.UI.Design.WebControls.HiddenFieldDesigner
        System.Web.UI.Design.WebControls.LiteralDesigner
        System.Web.UI.Design.WebControls.LoginNameDesigner
        System.Web.UI.Design.WebControls.LoginViewDesigner
        System.Web.UI.Design.WebControls.PasswordRecoveryDesigner
        System.Web.UI.Design.WebControls.PreviewControlDesigner
        System.Web.UI.Design.WebControls.RepeaterDesigner
        System.Web.UI.Design.WebControls.SiteMapPathDesigner
        System.Web.UI.Design.WebControls.SubstitutionDesigner
        System.Web.UI.Design.WebControls.TableDesigner
        System.Web.UI.Design.WebControls.WebParts.ProxyWebPartManagerDesigner
        System.Web.UI.Design.WebControls.WebParts.WebPartManagerDesigner
        System.Web.UI.Design.WebControls.WebParts.WebZoneDesigner
        System.Web.UI.Design.WebControls.XmlDesigner

Community Additions

ADD
Show:
© 2014 Microsoft