SupportsPreviewControlAttribute Klasse

Definition

public ref class SupportsPreviewControlAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class SupportsPreviewControlAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class)>]
type SupportsPreviewControlAttribute = class
    inherit Attribute

Public NotInheritable Class SupportsPreviewControlAttribute
Inherits Attribute

Vererbung

Object

Attribute

SupportsPreviewControlAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie ein Steuerelement-Designer mit dem SupportsPreviewControlAttribute Attribut markiert wird. Im Codebeispiel wird ein ASP.NET Serversteuerelement von der Label Klasse abgeleitet und das ASP.NET Serversteuerelement einer implementierung des benutzerdefinierten Steuerelements des Steuerelements zugeordnet. Die Deklaration der Steuerelement-Designer-Klasse ist mit dem Attribut gekennzeichnet, auf das SupportsPreviewControl festgelegt trueist. Der Steuerelement-Designer überschreibt die GetDesignTimeHtml Methode und schließt den Entwurfszeit-HTML für das Steuerelement in kursiv formatierte Tags ein.

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

namespace ControlDesignerSamples.CS
{
    // Define a simple designer associated with a 
    // simple text web control.
    
    // Mark the designer with the SupportsPreviewControlAttribute set
    // to true.  This means the base.UsePreviewControl returns true,
    // and base.ViewControl returns a temporary preview copy of the control.
    [SupportsPreviewControl(true)]
    public class SimpleTextControlDesigner : TextControlDesigner
    {		
        // Override the base GetDesignTimeHtml method to display 
        // the design time text in italics.
        public override string GetDesignTimeHtml()
        {
            string html = String.Empty;
 
            try
            {
                // Initialize the return string to the default
                // design time html of the base TextControlDesigner.
                html = base.GetDesignTimeHtml();

                // Get the ViewControl for the associated control.
                Label ctrl = (Label)ViewControl;

                ctrl.Style.Add(HtmlTextWriterStyle.FontStyle, "Italic");
                html = base.GetDesignTimeHtml();
            }
            catch (System.Exception e)
            {
               if (String.IsNullOrEmpty(html))
               {
                   html = GetErrorDesignTimeHtml(e);
               }
            }
            
            return html;
        }
    }

    // Derive a simple Web control from Label to render a text string.
    // Associate this control with the SimpleTextControlDesigner.
    [DesignerAttribute("ControlDesignerSamples.CS.SimpleTextControlDesigner"),
    ToolboxData("<{0}:MyLabelControl Runat=\"Server\"><{0}:MyLabelControl>")]
    public class MyLabelControl : Label
    {
        // Use the Label control implementation, but associate
        // the derived class with the custom control designer.
    }
}

Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Web.UI
Imports System.Web.UI.Design
Imports System.Web.UI.Design.WebControls
Imports System.Web.UI.WebControls
Imports System.Reflection

Namespace ControlDesignerSamples.VB

    ' Derive a simple Web control from Label to render a text string.
    ' Associate this control with the SimpleTextControlDesigner.
    <DesignerAttribute("ControlDesignerSamples.CS.SimpleTextControlDesigner"), _
    ToolboxData("<{0}:MyLabelControl Runat=""Server""><{0}:MyLabelControl>")> _
    Public Class MyLabelControl
        Inherits Label

        ' Use the Label control implementation, but associate
        ' the derived class with the custom control designer.
    End Class


    ' Mark the designer with the SupportsPreviewControlAttribute set
    ' to true.  This means the base.UsePreviewControl returns true,
    ' and base.ViewControl returns a temporary preview copy of the control.
    <SupportsPreviewControl(True)> _
    Public Class SimpleTextControlDesigner
        Inherits TextControlDesigner

        ' Override the base GetDesignTimeHtml method to display 
        ' the design time text in italics.
        Public Overrides Function GetDesignTimeHtml() As String
            Dim html As String = String.Empty

            Try
                ' Get the ViewControl for the associated control.
                Dim ctrl As Label = CType(ViewControl, Label)

                ' Set the default text, if necessary
                If ctrl.Text.Length = 0 Then
                    ctrl.Text = "Sample Text"
                End If

                ' Set the style to italic
                ctrl.Style.Add(HtmlTextWriterStyle.FontStyle, "italic")

                ' Let the base class create the HTML markup
                html = MyBase.GetDesignTimeHtml()
            Catch ex As Exception
                If String.IsNullOrEmpty(html) Then
                    ' Display the exception message
                    html = GetErrorDesignTimeHtml(ex)
                End If
            End Try

            Return html
        End Function

    End Class
End Namespace

Hinweise

Wenden Sie das SupportsPreviewControlAttribute Attribut auf eine Steuerelement-Designerklasse an, um den Typ des Vorschausteuerelements anzugeben, das vom Steuerelement-Designer unterstützt wird. Verwenden Sie dieses Attribut, um ein Vorschausteuerelement für das Entwurfszeitrendering zu ändern, ohne dass sich die tatsächliche beibehaltene Instanz des zugehörigen Steuerelements auswirkt.

Normalerweise geben Sie die SupportsPreviewControlAttribute Beim Deklarieren einer benutzerdefinierten Designerklasse an, die von der ControlDesigner Klasse abgeleitet wird. Der Wert der SupportsPreviewControl Eigenschaft für das SupportsPreviewControlAttribute Attribut bestimmt das Verhalten für die UsePreviewControl elemente ViewControl in der Basisklasse ControlDesigner .

Legen Sie die SupportsPreviewControl Eigenschaft so true fest, dass der Designer eine temporäre Kopie des zugeordneten Steuerelements verwendet, um den Entwurfszeit-HTML-Code zu generieren. Änderungen am temporären Steuerelement werden nicht beibehalten.

Legen Sie die SupportsPreviewControl Eigenschaft fest, um false anzugeben, dass der Designer die Steuerelementinstanz, insbesondere die Component Eigenschaft, aus der ViewControl Methode zurückgibt. Änderungen am Steuerelementobjekt werden beibehalten.

Beispielsweise wird die CalendarDesigner Klasse mit dem SupportsPreviewControlAttribute Satz auf true. Der Designer verwendet das Vorschausteuerelement mit der Aufgabe für die automatische Formatformatierung, mit der der Benutzer eine Vorschau verschiedener Autoformatformate anzeigen kann, die auf den Kalender angewendet werden können. Wenn der Benutzer unterschiedliche Formatvorlagen in der Benutzeroberfläche auswählt, wird das ausgewählte Formatschema auf das Vorschausteuerelement angewendet. Das Anwenden einer neuen Formatvorlage auf das Vorschausteuerelement ändert nicht das Schema, das auf die Instanz des Calendar Steuerelements im Designer angewendet wird.

Wenn dies SupportsPreviewControlAttribute in der Steuerelement-Designer-Deklaration nicht angegeben ist, entspricht das ControlDesigner Verhalten dem Angeben des SupportsPreviewControl Werts als false.

Allgemeine Informationen zur Verwendung von Attributen finden Sie unter "Attributes Overview " und "Attributes". Weitere Informationen zu Entwurfszeitattributen finden Sie unter Attribute und Design-Time Support.

Konstruktoren

Felder

Eigenschaften

Methoden

Explizite Schnittstellenimplementierungen

Gilt für

Siehe auch

• UsePreviewControl
• ViewControl
• PreviewControlDesigner
• Attribute und Entwurfszeitunterstützung