DesignerAutoFormat Klasse

Definition

Stellt die abstrakte Basisklasse für das Erstellen von Formaten bereit, die zur Entwurfszeit auf ein benutzerdefiniertes Webserversteuerelement angewendet werden können.Provides the abstract base class for creating formats that can be applied to a custom Web server control at design time.

public ref class DesignerAutoFormat abstract
public abstract class DesignerAutoFormat
type DesignerAutoFormat = class
Public MustInherit Class DesignerAutoFormat
Vererbung
DesignerAutoFormat

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie die automatische Formatierung in einem benutzerdefinierten Steuerelement-Designer implementiert wird.The following code example demonstrates how to implement automatic formatting in a custom control designer. Der abgeleitete Steuerelement-Designer implementiert die- AutoFormats Eigenschaft, indem er drei Instanzen eines benutzerdefinierten automatischen Formats hinzufügt, die von der-Klasse abgeleitet werden DesignerAutoFormat .The derived control designer implements the AutoFormats property by adding three instances of a custom automatic format that are derived from the DesignerAutoFormat class.

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

namespace CustomControls.Design.CS
{
    // A custom Label control whose contents can be indented
    [Designer(typeof(IndentLabelDesigner)), 
        ToolboxData("<{0}:IndentLabel Runat=\"server\"></{0}:IndentLabel>")]
    public class IndentLabel : Label
    {
        private int _indent = 0;

        // Property to indent all text within the label
        [Category("Appearance"), DefaultValue(0), 
            PersistenceMode(PersistenceMode.Attribute)]
        public int Indent
        {
            get { return _indent; }
            set
            {
                _indent = value;
                // Get the number of pixels to indent
                int ind = value * 8;

                //  Add the indent style to the control
                if (ind > 0)
                    this.Style.Add(HtmlTextWriterStyle.MarginLeft, ind.ToString() + "px");
                else
                    this.Style.Remove(HtmlTextWriterStyle.MarginLeft);
            }
        }
    }

    // A design-time ControlDesigner for the IndentLabel control
    [SupportsPreviewControl(true)]
    public class IndentLabelDesigner : LabelDesigner
    {
        private DesignerAutoFormatCollection _autoFormats = null;

        // The collection of AutoFormat objects for the IndentLabel object
        public override DesignerAutoFormatCollection AutoFormats
        {
            get
            {
                if (_autoFormats == null)
                {
                    // Create the collection
                    _autoFormats = new DesignerAutoFormatCollection();

                    // Create and add each AutoFormat object
                    _autoFormats.Add(new IndentLabelAutoFormat("MyClassic"));
                    _autoFormats.Add(new IndentLabelAutoFormat("MyBright"));
                    _autoFormats.Add(new IndentLabelAutoFormat("Default"));
                }
                return _autoFormats;
            }
        }

        // An AutoFormat object for the IndentLabel control
        private class IndentLabelAutoFormat : DesignerAutoFormat
        {
            public IndentLabelAutoFormat(string name) : base(name)
            { }

            // Applies styles based on the Name of the AutoFormat
            public override void Apply(Control inLabel)
            {
                if (inLabel is IndentLabel)
                {
                    IndentLabel ctl = (IndentLabel)inLabel;

                    // Apply formatting according to the Name
                    if (this.Name == "MyClassic")
                    {
                        // For MyClassic, apply style elements directly to the control
                        ctl.ForeColor = Color.Gray;
                        ctl.BackColor = Color.LightGray;
                        ctl.Font.Size = FontUnit.XSmall;
                        ctl.Font.Name = "Verdana,Geneva,Sans-Serif";
                    }
                    else if (this.Name == "MyBright")
                    {
                        // For MyBright, apply style elements to the Style property
                        this.Style.ForeColor = Color.Maroon;
                        this.Style.BackColor = Color.Yellow;
                        this.Style.Font.Size = FontUnit.Medium;

                        // Merge the AutoFormat style with the control's style
                        ctl.MergeStyle(this.Style);
                    }
                    else
                    {
                        // For the Default format, apply style elements to the control
                        ctl.ForeColor = Color.Black;
                        ctl.BackColor = Color.Empty;
                        ctl.Font.Size = FontUnit.XSmall;
                    }
                }
            }
        }
    }
}
Imports System.Drawing
Imports System.Collections
Imports System.ComponentModel
Imports System.Web.UI
Imports System.Web.UI.Design
Imports System.Web.UI.Design.WebControls
Imports System.Web.UI.WebControls

Namespace CustomControls.Design

    ' A custom Label control whose contents can be indented
    <Designer(GetType(IndentLabelDesigner)), _
        ToolboxData("<{0}:IndentLabel Runat=""server""></{0}:IndentLabel>")> _
    Public Class IndentLabel
        Inherits System.Web.UI.WebControls.Label

        Dim _indent As Integer = 0

        <Category("Appearance"), DefaultValue(0), _
            PersistenceMode(PersistenceMode.Attribute)> _
        Property Indent() As Integer
            Get
                Return _indent
            End Get
            Set(ByVal Value As Integer)
                _indent = Value

                ' Get the number of pixels to indent
                Dim ind As Integer = _indent * 8

                ' Add the indent style to the control
                If ind > 0 Then
                    Me.Style.Add(HtmlTextWriterStyle.MarginLeft, ind.ToString() & "px")
                Else
                    Me.Style.Remove(HtmlTextWriterStyle.MarginLeft)
                End If
            End Set
        End Property

    End Class

    ' A design-time ControlDesigner for the IndentLabel control
    Public Class IndentLabelDesigner
        Inherits LabelDesigner

        Private _autoFormats As DesignerAutoFormatCollection = Nothing
        ' The collection of AutoFormat objects for the IndentLabel object
        Public Overrides ReadOnly Property AutoFormats() As DesignerAutoFormatCollection
            Get
                If _autoFormats Is Nothing Then
                    ' Create the collection
                    _autoFormats = New DesignerAutoFormatCollection()

                    ' Create and add each AutoFormat object
                    _autoFormats.Add(New IndentLabelAutoFormat("MyClassic"))
                    _autoFormats.Add(New IndentLabelAutoFormat("MyBright"))
                    _autoFormats.Add(New IndentLabelAutoFormat("Default"))
                End If

                Return _autoFormats
            End Get
        End Property

        ' An AutoFormat object for the IndentLabel control
        Public Class IndentLabelAutoFormat
            Inherits DesignerAutoFormat

            Public Sub New(ByVal name As String)
                MyBase.New(name)
            End Sub

            ' Applies styles based on the Name of the AutoFormat
            Public Overrides Sub Apply(ByVal inLabel As Control)
                If TypeOf inLabel Is IndentLabel Then
                    Dim ctl As IndentLabel = CType(inLabel, IndentLabel)

                    ' Apply formatting according to the Name
                    If Me.Name.Equals("MyClassic") Then
                        ' For MyClassic, apply style elements directly to the control
                        ctl.ForeColor = Color.Gray
                        ctl.BackColor = Color.LightGray
                        ctl.Font.Size = FontUnit.XSmall
                        ctl.Font.Name = "Verdana,Geneva,Sans-Serif"
                    ElseIf Me.Name.Equals("MyBright") Then
                        ' For MyBright, apply style elements to the Style object
                        Me.Style.ForeColor = Color.Maroon
                        Me.Style.BackColor = Color.Yellow
                        Me.Style.Font.Size = FontUnit.Medium

                        ' Merge the AutoFormat style with the control's style
                        ctl.MergeStyle(Me.Style)
                    Else
                        ' For the Default format, apply style elements to the control
                        ctl.ForeColor = Color.Black
                        ctl.BackColor = Color.Empty
                        ctl.Font.Size = FontUnit.XSmall
                    End If
                End If
            End Sub
        End Class
    End Class

End Namespace

Hinweise

DesignerAutoFormat stellt eine Basisklasse bereit, die von geerbt und erweitert werden kann, um zur Entwurfszeit ein formatiertes benutzerdefiniertes Webserver Steuerelement in einem visuellen Designer Tool wie Visual Studio 2005 anzuzeigen.DesignerAutoFormat provides a base class that can be inherited from and extended to display a formatted custom Web server control at design time in a visual designer tool such as Visual Studio 2005.

Ein Steuerelement Entwickler stellt eine automatische Formatierung bereit, um Entwicklern zu helfen, die das Steuerelement verwenden, um eine bevorzugte Anzeige auszuwählen.A control developer provides automatic formatting in order to help developers who use the control to select a preferred display. Ein benutzerdefiniertes- DesignerAutoFormat Objekt funktioniert mit einem benutzerdefinierten Steuerelement-Designer, um zur Entwurfszeit für ein benutzerdefiniertes Steuerelement automatische FormatierungA custom DesignerAutoFormat object works with a custom control designer to provide automatic formatting at design time for a custom control. Das-Steuerelement Calendar stellt z. b. eine Vielzahl von Formaten bereit, die von einem Entwickler zur Entwurfszeit angewendet werden können.For example, the Calendar control provides a variety of formats that can be applied by a developer at design time.

So implementieren Sie die automatische Formatierung für ein benutzerdefiniertes SteuerelementTo implement automatic formatting for a custom control:

  1. Erstellen Sie das benutzerdefinierte Steuerelement.Create the custom control.

  2. Leiten Sie eine Designer Klasse von der- ControlDesigner Klasse oder einer anderen Designer Klasse ab, die für Ihr Steuerelement geeignet ist, z TextControlDesigner . b..Derive a designer class from the ControlDesigner class or another designer class that is appropriate for your control, such as the TextControlDesigner.

  3. Leiten Sie eine Formatklasse von der Klasse ab, die das DesignerAutoFormat benutzerdefinierte Steuerelement durch Überschreiben der Methode formatiert Apply .Derive a format class from the DesignerAutoFormat class that formats your custom control by overriding the Apply method.

  4. Füllen Sie in der Designer-Klasse die- AutoFormats Eigenschaft, bei der es sich um ein- DesignerAutoFormatCollection Objekt handelt, mit einer Instanz Ihrer Formatklasse für jedes benannte Format auf, das der Designer anwenden kann.In your designer class, populate the AutoFormats property, which is a DesignerAutoFormatCollection object, with one instance of your format class for each named format that your designer can apply.

Die- DesignerAutoFormat Klasse stellt die folgenden Member bereit, um die automatische Formatierung zur Entwurfszeit zu unterstützen:The DesignerAutoFormat class provides the following members to support automatic formatting at design time:

  • Die- Apply Methode, die das benannte Format auf das angegebene Steuerelement anwendet.The Apply method, which applies the named format to the specified control.

  • Die- GetPreviewControl Methode, die eine Kopie des Steuer Elements für die Vorschau in einem Dialogfeld " Auto Format " eines visuellen Designers (z. b. Visual Studio 2005) bereitstellt.The GetPreviewControl method, which provides a copy of the control for previewing in an AutoFormat dialog box of a visual designer such as Visual Studio 2005.

  • Die- Name Eigenschaft, die den Text bereitstellt, der in einer Liste von Formaten in einem visuellen Designer angezeigt werden soll.The Name property, which provides the text to display in a list of formats in a visual designer.

Hinweise für Ausführende

Wenn Sie von der- DesignerAutoFormat Klasse erben, müssen Sie die Apply(Control) -Methode überschreiben, um ein formatiertes Steuerelement in der Vorschau anzuzeigen und das ausgewählte Format auf das Steuerelement anzuwenden.When you inherit from the DesignerAutoFormat class, you must override the Apply(Control) method to preview a formatted control and to apply the selected format to your control.

Konstruktoren

DesignerAutoFormat(String)

Initialisiert eine neue Instanz der DesignerAutoFormat-Klasse.Initializes a new instance of the DesignerAutoFormat class.

Eigenschaften

Name

Ruft den Namen eines DesignerAutoFormat-Objekts ab.Gets the name of a DesignerAutoFormat object.

Style

Ruft ein DesignerAutoFormatStyle-Objekt ab, das vom DesignerAutoFormat-Objekt für eine Entwurfszeitvorschau des zugeordneten Steuerelements verwendet wird.Gets a DesignerAutoFormatStyle object that is used by the DesignerAutoFormat object to render a design-time preview of the associated control.

Methoden

Apply(Control)

Wendet die zugeordnete Formatierung auf das angegebene Steuerelement an.Applies the associated formatting to the specified control.

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetPreviewControl(Control)

Gibt eine Kopie des zugeordneten Steuerelements zurück, um vor dem Anwenden des Formats auf das Steuerelement eine Vorschau bereitzustellen.Returns a copy of the associated control in order to provide a preview before applying the format to the control.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle DesignerAutoFormat-Objekt darstellt.Returns a string that represents the current DesignerAutoFormat object.

Gilt für:

Siehe auch