DesignerAutoFormat Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Proporciona la clase base abstracta para crear formatos que se pueden aplicar en tiempo de diseño a un control de servidor Web personalizado.
public ref class DesignerAutoFormat abstractpublic abstract class DesignerAutoFormattype DesignerAutoFormat = classPublic MustInherit Class DesignerAutoFormat- Herencia
-
DesignerAutoFormat
Ejemplos
En el ejemplo de código siguiente se muestra cómo implementar el formato automático en un diseñador de controles personalizados. El diseñador de controles derivado implementa la AutoFormats propiedad agregando tres instancias de un formato automático personalizado derivado de la DesignerAutoFormat clase .
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
Comentarios
DesignerAutoFormatproporciona una clase base que se puede heredar de y extender para mostrar un control de servidor web personalizado con formato en tiempo de diseño en una herramienta de diseñador visual, como Visual Studio 2005.
Un desarrollador de controles proporciona formato automático para ayudar a los desarrolladores que usan el control para seleccionar una pantalla preferida. Un objeto personalizado funciona con un diseñador de controles personalizado DesignerAutoFormat para proporcionar formato automático en tiempo de diseño para un control personalizado. Por ejemplo, el Calendar control proporciona una variedad de formatos que un desarrollador puede aplicar en tiempo de diseño.
Para implementar el formato automático para un control personalizado:
Cree el control personalizado.
Derive una clase de diseñador de la ControlDesigner clase u otra clase de diseñador que sea adecuada para el control, como TextControlDesigner.
Derive una clase de formato de la DesignerAutoFormat clase que da formato al control personalizado reemplazando el Apply método .
En la clase de diseñador, rellene la AutoFormats propiedad , que es un DesignerAutoFormatCollection objeto , con una instancia de la clase de formato para cada formato con nombre que pueda aplicar el diseñador.
La DesignerAutoFormat clase proporciona los siguientes miembros para admitir el formato automático en tiempo de diseño:
El Apply método , que aplica el formato con nombre al control especificado.
El GetPreviewControl método , que proporciona una copia del control para obtener una vista previa en un cuadro de diálogo Autoformato de un diseñador visual como Visual Studio 2005.
La Name propiedad , que proporciona el texto que se va a mostrar en una lista de formatos en un diseñador visual.
Notas a los implementadores
Cuando hereda de la DesignerAutoFormat clase , debe invalidar el Apply(Control) método para obtener una vista previa de un control con formato y aplicar el formato seleccionado al control.
Constructores
| DesignerAutoFormat(String) |
Inicializa una nueva instancia de la clase DesignerAutoFormat. |
Propiedades
| Name |
Obtiene el nombre de un objeto DesignerAutoFormat. |
| Style |
Obtiene un objeto DesignerAutoFormatStyle que el objeto DesignerAutoFormat utiliza para representar una vista previa en tiempo de diseño del control asociado. |
Métodos
| Apply(Control) |
Aplica el formato asociado al control especificado. |
| Equals(Object) |
Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object) |
| GetHashCode() |
Sirve como la función hash predeterminada. (Heredado de Object) |
| GetPreviewControl(Control) |
Devuelve una copia del control asociado para proporcionar una vista previa antes de aplicar el formato al control. |
| GetType() |
Obtiene el Type de la instancia actual. (Heredado de Object) |
| MemberwiseClone() |
Crea una copia superficial del Object actual. (Heredado de Object) |
| ToString() |
Devuelve una cadena que representa el actual objeto DesignerAutoFormat. |