DesignerAutoFormat Klasa

Definicja

Przestrzeń nazw:

System.Web.UI.Design

Zestaw:

System.Design.dll

Udostępnia abstrakcyjną klasę bazową do tworzenia formatów, które można zastosować do niestandardowej kontrolki serwera sieci Web w czasie projektowania.

public ref class DesignerAutoFormat abstract

public abstract class DesignerAutoFormat

type DesignerAutoFormat = class

Public MustInherit Class DesignerAutoFormat

Dziedziczenie

Object

DesignerAutoFormat

Przykłady

Poniższy przykład kodu przedstawia sposób implementowania automatycznego formatowania w niestandardowym projektancie kontrolek. Pochodny projektant kontrolek implementuje AutoFormats właściwość przez dodanie trzech wystąpień niestandardowego formatu automatycznego, które pochodzą z DesignerAutoFormat klasy.

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

Uwagi

DesignerAutoFormatudostępnia klasę bazową, którą można dziedziczyć i rozszerzać w celu wyświetlenia sformatowanej niestandardowej kontroli serwera sieci Web w czasie projektowania w narzędziu projektanta wizualnego, takim jak Visual Studio 2005.

Deweloper kontroli zapewnia automatyczne formatowanie w celu ułatwienia deweloperom korzystającym z kontrolki wybierania preferowanego ekranu. Obiekt niestandardowy DesignerAutoFormat współpracuje z niestandardowym projektantem kontrolek w celu zapewnienia automatycznego formatowania w czasie projektowania dla kontrolki niestandardowej. Na przykład kontrolka Calendar udostępnia różne formaty, które mogą być stosowane przez dewelopera w czasie projektowania.

Aby zaimplementować automatyczne formatowanie dla kontrolki niestandardowej:

1. Utwórz kontrolkę niestandardową.

2. Tworzenie klasy projektanta ControlDesigner z klasy lub innej klasy projektanta, która jest odpowiednia dla kontrolki, takiej jak TextControlDesigner.

3. Utwórz klasę formatu z DesignerAutoFormat klasy, która formatuje kontrolkę niestandardową, przesłaniając metodę Apply .

4. W klasie projektanta wypełnij AutoFormats właściwość , która jest obiektem DesignerAutoFormatCollection , z jednym wystąpieniem klasy formatu dla każdego nazwanego formatu, który może zastosować projektant.

Klasa DesignerAutoFormat udostępnia następujące elementy członkowskie do obsługi automatycznego formatowania w czasie projektowania:

• Metoda Apply , która stosuje nazwany format do określonej kontrolki.

• MetodaGetPreviewControl, która udostępnia kopię kontrolki do wyświetlania podglądu w oknie dialogowym Autoformatowania projektanta wizualizacji, takiego jak Visual Studio 2005.

• Właściwość Name , która udostępnia tekst do wyświetlenia na liście formatów w projektancie wizualizacji.

Uwagi dotyczące implementowania

Po dziedziczeniu DesignerAutoFormat z klasy należy przesłonić Apply(Control) metodę, aby wyświetlić podgląd sformatowanej kontrolki i zastosować wybrany format do kontrolki.

Konstruktory

DesignerAutoFormat(String)

Inicjuje nowe wystąpienie klasy DesignerAutoFormat.

Właściwości

Name	Pobiera nazwę DesignerAutoFormat obiektu.
Style	DesignerAutoFormatStyle Pobiera obiekt, który jest używany przez DesignerAutoFormat obiekt do renderowania podglądu czasu projektowania skojarzonej kontrolki.

Metody

Apply(Control)	Stosuje skojarzone formatowanie do określonej kontrolki.
Equals(Object)	Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetPreviewControl(Control)	Zwraca kopię skojarzonej kontrolki w celu udostępnienia podglądu przed zastosowaniem formatu do kontrolki.
GetType()	Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący DesignerAutoFormat obiekt.

Zobacz też

• DesignerAutoFormatCollection
• DesignerAutoFormatStyle
• AutoFormats
• ControlDesigner
• Projektantów kontrolek ASP.NET — omówienie