ControlDesigner.ViewControl プロパティ

定義

名前空間:

System.Web.UI.Design

アセンブリ:

System.Design.dll

デザイン時 HTML マークアップのプレビュー用に使用できる Web サーバー コントロールを取得または設定します。

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 マークアップを生成するために基本クラスが使用する Control オブジェクト。

例

次のコード例は、コントロール デザイナーに属性をマークする方法を SupportsPreviewControlAttribute 示しています。 コード例では、クラスから Web サーバー コントロールを Label 派生させ、コントロールをカスタム コントロール デザイナーの実装に関連付けます。 コントロール デザイナー クラス宣言は、属性trueが SupportsPreviewControl . コントロール デザイナーはメソッドを GetDesignTimeHtml オーバーライドし、デザイン時に Text コントロールのプロパティを斜体で表示します。

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 使用して戻り値を決定します。

プロパティが指定されているUsePreviewControl場合、ViewControlプロパティはtrueコントロールの一時コピーを返します。 一時コントロールへの変更は保持されません。

プロパティが指定されているUsePreviewControl場合、ViewControlプロパティはfalseコントロールのプロパティのインスタンスをComponent返します。 コントロールのインスタンスに対する変更は保持されます。

オブジェクトのSupportsPreviewControlAttribute設定はSupportsPreviewControl、プロパティのUsePreviewControl値を設定するために使用されます。 したがって、このSupportsPreviewControl設定は、基底ControlDesignerクラスのプロパティによって返されるコントロールのViewControl型を決定します。 コントロール デザイナーのSupportsPreviewControlAttribute宣言で指定されていない場合、オブジェクトのControlDesigner動作はプロパティを次のようにfalse指定することとSupportsPreviewControl同じです。

こちらもご覧ください

• SupportsPreviewControlAttribute
• UsePreviewControl
• GetViewRendering
• PreviewControlDesigner
• ASP.NET コントロール デザイナーの概要