EditorPartDesigner Classe

Définition

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

Héritage

Object

ComponentDesigner

HtmlControlDesigner

ControlDesigner

CompositeControlDesigner

PartDesigner

EditorPartDesigner

Exemples

L’exemple de code suivant crée un contrôle personnalisé EditorPart simple qui permet à l’utilisateur de modifier la ToolTip propriété du contrôle cible. Le associé EditorPartDesigner valide le contrôle et remplace la zone de texte d’entrée utilisateur au moment de la conception par une étiquette expliquant qu’elle est masquée.

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

Pour que le contrôle personnalisé soit rendu, la page doit avoir un contrôle, un WebPartManagerEditorZone avec un ZoneTemplate pour que le contrôle réside et un WebPartZone contenant un contrôle sur lequel le personnalisé EditorPart peut agir, comme illustré dans l’exemple de code suivant.

<%@ 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>

Pour que le EditorPart soit utilisable au moment de l’exécution, le mode d’édition doit être activé sur la page. L’exemple de code suivant montre comment le faire avec un fichier code-behind.

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

Remarques

EditorPartDesigner est une implémentation publique de la PartDesigner classe de base à des fins de rendu EditorPart des contrôles au moment de la conception. Il ajoute la possibilité de transporter les informations de zone du contrôle associé en mode création, mais ne modifie pas les fonctionnalités du contrôle parent.

Comme avec d’autres concepteurs de EditorPartDesigner contrôles, vous pouvez modifier le rendu au moment de la conception des contrôles personnalisés EditorPart en hériter et en remplaçant la GetDesignTimeHtml méthode. Si vous souhaitez remplacer la CreateViewControl méthode, veillez à inclure l’implémentation de base afin de conserver les informations de zone.

Constructeurs

Propriétés

Méthodes

Implémentations d’interfaces explicites

S’applique à

Voir aussi

• ControlDesigner
• EditorPart
• WebPartDesigner
• contrôles de composants WebPart ASP.NET
• vue d’ensemble des concepteurs de contrôle ASP.NET