ControlDesigner.ViewControl Свойство

Определение

Получает или задает серверный веб-элемент управления, который может быть использован для предварительного просмотра разметки HTML времени разработки.Gets or sets a Web server control that can be used for previewing the design-time HTML markup.

public:
 property System::Web::UI::Control ^ ViewControl { System::Web::UI::Control ^ get(); void set(System::Web::UI::Control ^ value); };
public System.Web.UI.Control ViewControl { get; set; }
member this.ViewControl : System.Web.UI.Control with get, set
Public Property ViewControl As Control

Значение свойства

Объект Control, используемый базовым классом для формирования разметки HTML времени разработки.A Control object used by the base class to generate design-time HTML markup.

Примеры

В следующем примере кода показано, как пометить конструктор элементов управления атрибутом SupportsPreviewControlAttribute.The following code example demonstrates how to mark a control designer with the SupportsPreviewControlAttribute attribute. Пример кода извлекает серверный веб-элемент управления из класса Label и связывает элемент управления с реализацией пользовательского конструктора элемента управления.The code example derives a Web server control from the Label class and associates the control with a custom control designer implementation. Объявление класса конструктора элементов управления помечается атрибутом SupportsPreviewControl, для которого задано значение true.The control designer class declaration is marked with the SupportsPreviewControl attribute set to true. Конструктор элементов управления переопределяет метод GetDesignTimeHtml, а затем отображает свойство Text элемента управления курсивом во время разработки.The control designer overrides the GetDesignTimeHtml method, and then displays the Text property of the control in italic at design time.

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

Комментарии

Свойство ViewControl использует свойство UsePreviewControl для определения его возвращаемого значения.The ViewControl property uses the UsePreviewControl property to determine its return value.

Если свойство UsePreviewControl имеет значение true, свойство ViewControl возвращает временную копию элемента управления.If the UsePreviewControl property is true, the ViewControl property returns a temporary copy of the control. Изменения временного элемента управления не сохраняются.Changes to the temporary control are not persisted.

Если свойство UsePreviewControl имеет значение false, свойство ViewControl возвращает экземпляр свойства Component для элемента управления.If the UsePreviewControl property is false, the ViewControl property returns an instance of the Component property for the control. Изменения в экземпляре элемента управления сохраняются.Changes to the instance of the control are persisted.

Параметр SupportsPreviewControl в объекте SupportsPreviewControlAttribute используется для задания значения свойства UsePreviewControl.The SupportsPreviewControl setting in the SupportsPreviewControlAttribute object is used to set the value of the UsePreviewControl property. Таким образом, параметр SupportsPreviewControl определяет тип элемента управления, возвращаемого свойством ViewControl в базовом ControlDesigner классе.Therefore, the SupportsPreviewControl setting determines the type of control that is returned by the ViewControl property in the base ControlDesigner class. Если SupportsPreviewControlAttribute не указано в объявлении конструктора элементов управления, поведение объекта ControlDesigner эквивалентно указанию свойства SupportsPreviewControl как false.If the SupportsPreviewControlAttribute is not specified in the control designer declaration, the ControlDesigner object behavior is equivalent to specifying the SupportsPreviewControl property as false.

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

Дополнительно