EditorPartDesigner Klass

Definition

public ref class EditorPartDesigner : System::Web::UI::Design::WebControls::WebParts::PartDesigner

public class EditorPartDesigner : System.Web.UI.Design.WebControls.WebParts.PartDesigner

type EditorPartDesigner = class
    inherit PartDesigner

Public Class EditorPartDesigner
Inherits PartDesigner

Arv

Object

ComponentDesigner

HtmlControlDesigner

ControlDesigner

CompositeControlDesigner

PartDesigner

EditorPartDesigner

Exempel

I följande kodexempel skapas en enkel anpassad EditorPart kontroll som gör att användaren kan ändra egenskapen för ToolTip målkontrollen. Den associerade EditorPartDesigner verifierar kontrollen och ersätter textrutan för användarens indata vid designtillfället med en etikett som förklarar att den är dold.

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

/// <summary>
/// SecretEditorPart is a custom EditorPart control that
/// allows the end user to change the ToolTip property of
/// a control by typing the value into a TextBox. 
/// SecretEditorPartDesigner hides the TextBox at design
/// time via the view control and replaces it with the 
/// words "The textbox is now hidden."
/// </summary>
namespace Samples.AspNet.CS.Controls
{
    [Designer(typeof(SecretEditorPartDesigner))]
    public class SecretEditorPart : EditorPart
    {
        public CheckBox UseCustom = new CheckBox();
        public TextBox TTTextBox = new TextBox();

        protected override void CreateChildControls()
        {
            base.CreateChildControls();
            Controls.Add(UseCustom);
            Literal lApply = new Literal();
            lApply.Text = "Apply custom ToolTip<br />";
            Controls.Add(lApply);
            Controls.Add(TTTextBox);
        }

        public override bool ApplyChanges()
        {
            EnsureChildControls();
            try
            {
                WebPartToEdit.ToolTip = TTTextBox.Text;
            }
            catch
            {
                return false;
            }
            return true;
        }

        public override void SyncChanges()
        {
            // Abstract method not implemented for this example
            return;
        }
    }

    public class SecretEditorPartDesigner : EditorPartDesigner
    {
        public override void Initialize(IComponent component)
        {
            // Validate the associated control
            if (!(component is SecretEditorPart))
            {
                string msg = "The associated control must be of type 'SecretEditorPart'";
                throw new ArgumentException(msg);
            }
            base.Initialize(component);
        }

        public override string GetDesignTimeHtml()
        {
            // Access the view control.
            SecretEditorPart sep = (SecretEditorPart)ViewControl;
           
            // Hide the textbox.
            sep.TTTextBox.Visible = false;

            // Now generate the base rendering.
            string designTimeHtml = base.GetDesignTimeHtml();

            // Insert some text.
            string segment = "</div>";
            designTimeHtml = designTimeHtml.Replace(segment, 
                "The textbox is now hidden." + segment);
            
            // Return the modified rendering.
            return designTimeHtml;
        }
    }
}

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

' SecretEditorPart is a custom EditorPart control that
' allows the end user to change the ToolTip property of
' a control by typing the value into a TextBox. 
' SecretEditorPartDesigner hides the TextBox at design
' time via the view control and replaces it with the 
' words "The textbox is now hidden."
Namespace Samples.AspNet.VB.Controls
    <Designer(GetType(SecretEditorPartDesigner))> _
    Public Class SecretEditorPart
        Inherits EditorPart
        Public UseCustom As New CheckBox()
        Public TTTextBox As New TextBox()

        Protected Overrides Sub CreateChildControls()
            MyBase.CreateChildControls()
            Controls.Add(UseCustom)
            Dim lApply As New Literal()
            lApply.Text = "Apply custom ToolTip<br />"
            Controls.Add(lApply)
            Controls.Add(TTTextBox)
        End Sub

        Public Overrides Function ApplyChanges() As Boolean
            EnsureChildControls()
            Try
                WebPartToEdit.ToolTip = TTTextBox.Text
            Catch
                Return False
            End Try
            Return True
        End Function

        Public Overrides Sub SyncChanges()
            ' Abstract method not implemented for this example
            Return
        End Sub
    End Class

    Public Class SecretEditorPartDesigner
        Inherits EditorPartDesigner
        Public Overrides Sub Initialize(component As IComponent)
            ' Validate the associated control
            If Not (TypeOf component Is SecretEditorPart) Then
                Dim msg As String = "The associated control must be of type 'SecretEditorPart'"
                Throw New ArgumentException(msg)
            End If
            MyBase.Initialize(component)
        End Sub

        Public Overrides Function GetDesignTimeHtml() As String
            ' Access the view control.
            Dim sep As SecretEditorPart = DirectCast(ViewControl, SecretEditorPart)

            ' Hide the textbox.
            sep.TTTextBox.Visible = False

            ' Now generate the base rendering.
            Dim designTimeHtml As String = MyBase.GetDesignTimeHtml()

            ' Insert some text.
            Dim segment As String = "</div>"
            designTimeHtml = designTimeHtml.Replace(segment, "The textbox is now hidden." & segment)

            ' Return the modified rendering.
            Return designTimeHtml
        End Function
    End Class
End Namespace

För att den anpassade kontrollen ska kunna återges måste sidan ha en kontroll, en WebPartManagerEditorZone med en ZoneTemplate för kontrollen som ska finnas i och en WebPartZone som innehåller en kontroll för den anpassade EditorPart att agera på, som du ser i följande kodexempel.

<%@ Page Language="C#" AutoEventWireup="true"  CodeFile="Default.aspx.cs" Inherits="_Default" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<%@ Register TagPrefix="ccl" Namespace="Samples.AspNet.CS.Controls" %>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>EditorPartDesigner Sample</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:WebPartManager ID="WebPartManager1" runat="server">
        </asp:WebPartManager><br />
        <asp:EditorZone ID="EditorZone1" runat="server" Enabled="true" >
            <ZoneTemplate>
                <ccl:SecretEditorPart ID="SEPart1" runat="server" />
            </ZoneTemplate>
        </asp:EditorZone>
        <asp:WebPartZone ID="WebPartZone1" runat="server">
            <ZoneTemplate>
                <asp:Button ID="Button1" runat="server" Height="24px" Text="Button" />
            </ZoneTemplate>
        </asp:WebPartZone><br />
    </div>
    </form>
</body>
</html>

<%@ Page Language="VB" AutoEventWireup="true"  CodeFile="Default.aspx.vb" Inherits="_Default" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<%@ Register TagPrefix="ccl" Namespace="Samples.AspNet.VB.Controls" %>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>EditorPartDesigner Sample</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <asp:WebPartManager ID="WebPartManager1" runat="server">
        </asp:WebPartManager><br />
        <asp:EditorZone ID="EditorZone1" runat="server" Enabled="true" >
            <ZoneTemplate>
                <ccl:SecretEditorPart ID="SEPart1" runat="server" />
            </ZoneTemplate>
        </asp:EditorZone>
        <asp:WebPartZone ID="WebPartZone1" runat="server">
            <ZoneTemplate>
                <asp:Button ID="Button1" runat="server" Height="24px" Text="Button" />
            </ZoneTemplate>
        </asp:WebPartZone><br />
    </div>
    </form>
</body>
</html>

EditorPart För att kunna användas vid körning måste redigeringsläget vara aktiverat på sidan. I följande kodexempel visas hur du gör det med en kod bakom fil.

using System;
using System.Web.UI.WebControls.WebParts;

public partial class _Default : System.Web.UI.Page 
{
    protected void Page_Load(object sender, EventArgs e)
    {
        {
            // Make the 'Edit' verb available so the EditorZone can render
            WebPartManager mgr = WebPartManager.GetCurrentWebPartManager(Page);
            mgr.DisplayMode = mgr.SupportedDisplayModes["Edit"];
        }
    }
}

Imports System.Web.UI.WebControls.WebParts

Public Partial Class _Default
    Inherits System.Web.UI.Page
    Protected Sub Page_Load(sender As Object, e As EventArgs)
        If True Then
            ' Make the 'Edit' verb available so the EditorZone can render
            Dim mgr As WebPartManager = WebPartManager.GetCurrentWebPartManager(Page)
            mgr.DisplayMode = mgr.SupportedDisplayModes("Edit")
        End If
    End Sub
End Class

Kommentarer

EditorPartDesigner är en offentlig implementering av PartDesigner basklassen i syfte att återge EditorPart kontroller vid designtillfället. Den lägger till funktionen för att transportera zoninformation från den associerade kontrollen i designvyn, men ändrar annars inte funktionen för den överordnade kontrollen.

Precis som med andra kontrolldesigners kan du ändra designtidsåtergivningen av anpassade EditorPart kontroller genom att ärva från EditorPartDesigner och åsidosätta GetDesignTimeHtml metoden. Om du vill åsidosätta CreateViewControl metoden måste du inkludera basimplementeringen för att behålla zoninformation.

Se även

• ControlDesigner
• EditorPart
• WebPartDesigner
• ASP.NET webbdelskontroller
• översikt över ASP.NET Control Designers