SupportsPreviewControlAttribute Класс

Определение

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

Наследование

Object

Attribute

SupportsPreviewControlAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере кода показано, как пометить конструктор элементов управления атрибутом SupportsPreviewControlAttribute . Пример кода является производным от класса серверным элементом управления ASP.NET и связывает серверный элемент управления Label ASP.NET с реализацией пользовательского конструктора элементов управления. Объявление класса конструктора элементов управления помечается атрибутом, равным SupportsPreviewControl true. Конструктор элементов управления переопределяет метод и заключает GetDesignTimeHtml HTML-код времени разработки для элемента управления в курсивные теги.

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

Комментарии

Примените SupportsPreviewControlAttribute атрибут к классу конструктора элементов управления, чтобы указать тип элемента управления предварительного просмотра, поддерживаемый конструктором элементов управления. Этот атрибут используется для изменения элемента управления предварительного просмотра для отрисовки во время разработки, не затрагивая фактический сохраненный экземпляр связанного элемента управления.

Как правило, указывается SupportsPreviewControlAttribute при объявлении пользовательского класса конструктора, производного от ControlDesigner класса. Значение свойства атрибута SupportsPreviewControl SupportsPreviewControlAttribute определяет поведение для UsePreviewControl и ViewControl членов базового ControlDesigner класса.

SupportsPreviewControl Задайте для свойства значение, указывающееtrue, что конструктор использует временную копию связанного элемента управления для создания HTML-кода во время разработки. Изменения во временном элементе управления не сохраняются.

SupportsPreviewControl Задайте свойство, чтобы false указать, что конструктор возвращает экземпляр элемента управления, в частности Component свойство, из ViewControl метода. Изменения в объекте элемента управления сохраняются.

Например, CalendarDesigner класс помечается набором SupportsPreviewControlAttribute true. Конструктор использует элемент управления предварительного просмотра с задачей автоматического форматирования стилей, что позволяет пользователю просматривать различные стили автоформата, которые можно применить к календарю. Когда пользователь выбирает различные стили автоформата в пользовательском интерфейсе, выбранная схема стиля применяется к элементу управления предварительного просмотра. Применение нового стиля к элементу управления предварительного просмотра не изменяет схему, применяемую к экземпляру Calendar элемента управления в конструкторе.

Если значение SupportsPreviewControlAttribute не указано в объявлении конструктора элементов управления, ControlDesigner поведение эквивалентно указанию SupportsPreviewControl как false.

Общие сведения об использовании атрибутов см. в разделе "Обзор атрибутов " и "Атрибуты". Дополнительные сведения об атрибутах времени разработки см. в разделе "Атрибуты" и Design-Time поддержки.

Конструкторы

Поля

Свойства

Методы

Явные реализации интерфейса

Применяется к

См. также раздел

• UsePreviewControl
• ViewControl
• PreviewControlDesigner
• Атрибуты и поддержка во время разработки