EditableDesignerRegion 類別
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
表示關聯控制項之設計階段標記內的可編輯內容區域。
public ref class EditableDesignerRegion : System::Web::UI::Design::DesignerRegion
public class EditableDesignerRegion : System.Web.UI.Design.DesignerRegion
type EditableDesignerRegion = class
inherit DesignerRegion
Public Class EditableDesignerRegion
Inherits DesignerRegion
- 繼承
- 衍生
範例
此範例示範如何建立具有兩個可點選區域的控件,以及具有兩個 EditableDesignerRegion 檢視或範本的物件。 編譯專案,然後在可視化設計工具中開啟頁面,然後切換到設計 (WYSIWYG) 檢視。 有兩個可點選的檢視: View1 和 View2。 按兩下 [檢視1 ],並將頁面下半部的控件拖曳 CheckBox 到空白設計工具區域,就在可點選區域下方。 按兩下 [檢視2 ],並將 RadioButton 控件拖曳至空的設計工具區域。 再次按兩下 [檢視1 ],然後重新出現區域 CheckBox 。 按兩下 [檢視2 ] 和重新出現的區域 RadioButton 。 切換回來源檢視,以查看您的變更如何保存在 HTML 標記中
注意
您的項目必須具有 System.Design.dll 元件的參考。
using System;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Drawing;
using System.Web.UI;
using System.Web.UI.Design;
using System.Web.UI.Design.WebControls;
using System.Web.UI.WebControls;
namespace Samples.ASPNet.ControlDesigners_CS
{
[
Designer(typeof(MyMultiRegionControlDesigner)),
ToolboxData("<{0}:MyMultiRegionControl runat=\"server\" width=\"200\"></{0}:MyMultiRegionControl>")
]
public class MyMultiRegionControl : CompositeControl
{
// Define the templates that represent 2 views on the control
private ITemplate _view1;
private ITemplate _view2;
// Create persistable inner properties
// for the two editable views
[PersistenceMode(PersistenceMode.InnerProperty), DefaultValue(null)]
public virtual ITemplate View1
{
get { return _view1; }
set { _view1 = value; }
}
[PersistenceMode(PersistenceMode.InnerProperty), DefaultValue(null)]
public virtual ITemplate View2
{
get { return _view2; }
set { _view2 = value; }
}
// The current view on the control; 0 = view1, 1 = view2
private int _currentView = 0;
public int CurrentView
{
get { return _currentView; }
set { _currentView = value; }
}
// Create a simple table with a row of two clickable,
// readonly headers and a row with a single column, which
// is the 'container' to which we'll be adding controls.
protected override void CreateChildControls()
{
// Always start with a clean form
Controls.Clear();
// Create a table using the control's declarative properties
Table t = new Table();
t.CellSpacing = 1;
t.BorderStyle = BorderStyle;
t.Width = this.Width;
t.Height = this.Height;
// Create the header row
TableRow tr = new TableRow();
tr.HorizontalAlign = HorizontalAlign.Center;
tr.BackColor = Color.LightBlue;
// Create the first cell in the header row
TableCell tc = new TableCell();
tc.Text = "View 1";
tc.Width = new Unit("50%");
tr.Cells.Add(tc);
// Create the second cell in the header row
tc = new TableCell();
tc.Text = "View 2";
tc.Width = new Unit("50%");
tr.Cells.Add(tc);
t.Rows.Add(tr);
// Create the second row for content
tr = new TableRow();
tr.HorizontalAlign = HorizontalAlign.Center;
// This cell represents our content 'container'
tc = new TableCell();
tc.ColumnSpan = 2;
// Add the current view content to the cell
// at run-time
if (!DesignMode)
{
Control containerControl = new Control();
switch (CurrentView)
{
case 0:
if (View1 != null)
View1.InstantiateIn(containerControl);
break;
case 1:
if (View2 != null)
View2.InstantiateIn(containerControl);
break;
}
tc.Controls.Add(containerControl);
}
tr.Cells.Add(tc);
t.Rows.Add(tr);
// Add the finished table to the Controls collection
Controls.Add(t);
}
}
//---------------------------------------------------------
// Region-based control designer for the above web control,
// derived from CompositeControlDesigner.
public class MyMultiRegionControlDesigner : CompositeControlDesigner
{
private MyMultiRegionControl myControl;
public override void Initialize(IComponent component)
{
base.Initialize(component);
myControl = (MyMultiRegionControl)component;
}
// Make this control resizeable on the design surface
public override bool AllowResize
{
get
{
return true;
}
}
// Use the base to create child controls, then add region markers
protected override void CreateChildControls() {
base.CreateChildControls();
// Get a reference to the table, which is the first child control
Table t = (Table)myControl.Controls[0];
// Add design time markers for each of the three regions
if (t != null)
{
// View1
t.Rows[0].Cells[0].Attributes[DesignerRegion.DesignerRegionAttributeName] = "0";
// View2
t.Rows[0].Cells[1].Attributes[DesignerRegion.DesignerRegionAttributeName] = "1";
// Editable region
t.Rows[1].Cells[0].Attributes[DesignerRegion.DesignerRegionAttributeName] = "2";
}
}
// Handler for the Click event, which provides the region in the arguments.
protected override void OnClick(DesignerRegionMouseEventArgs e)
{
if (e.Region == null)
return;
// If the clicked region is not a header, return
if (e.Region.Name.IndexOf("Header") != 0)
return;
// Switch the current view if required
if (e.Region.Name.Substring(6, 1) != myControl.CurrentView.ToString())
{
myControl.CurrentView = int.Parse(e.Region.Name.Substring(6, 1));
base.UpdateDesignTimeHtml();
}
}
// Create the regions and design-time markup. Called by the designer host.
public override String GetDesignTimeHtml(DesignerRegionCollection regions) {
// Create 3 regions: 2 clickable headers and an editable row
regions.Add(new DesignerRegion(this, "Header0"));
regions.Add(new DesignerRegion(this, "Header1"));
// Create an editable region and add it to the regions
EditableDesignerRegion editableRegion =
new EditableDesignerRegion(this,
"Content" + myControl.CurrentView, false);
regions.Add(editableRegion);
// Set the highlight for the selected region
regions[myControl.CurrentView].Highlight = true;
// Use the base class to render the markup
return base.GetDesignTimeHtml();
}
// Get the content string for the selected region. Called by the designer host?
public override string GetEditableDesignerRegionContent(EditableDesignerRegion region)
{
// Get a reference to the designer host
IDesignerHost host = (IDesignerHost)Component.Site.GetService(typeof(IDesignerHost));
if (host != null)
{
ITemplate template = myControl.View1;
if (region.Name == "Content1")
template = myControl.View2;
// Persist the template in the design host
if (template != null)
return ControlPersister.PersistTemplate(template, host);
}
return String.Empty;
}
// Create a template from the content string and
// put it in the selected view.
public override void SetEditableDesignerRegionContent(EditableDesignerRegion region, string content)
{
if (content == null)
return;
// Get a reference to the designer host
IDesignerHost host = (IDesignerHost)Component.Site.GetService(typeof(IDesignerHost));
if (host != null)
{
// Create a template from the content string
ITemplate template = ControlParser.ParseTemplate(host, content);
// Determine which region should get the template
// Either 'Content0' or 'Content1'
if (region.Name.EndsWith("0"))
myControl.View1 = template;
else if (region.Name.EndsWith("1"))
myControl.View2 = template;
}
}
}
}
Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Drawing
Imports System.Web.UI
Imports System.Web.UI.Design
Imports System.Web.UI.Design.WebControls
Imports System.Web.UI.WebControls
Namespace Samples.ASPNet.ControlDesigners_VB
< _
Designer(GetType(MyMultiRegionControlDesigner)), _
ToolboxData("<{0}:MyMultiRegionControl runat=""server"" width=""200""></{0}:MyMultiRegionControl>") _
> _
Public Class MyMultiRegionControl
Inherits CompositeControl
' Define the templates that represent 2 views on the control
Private _view1 As ITemplate
Private _view2 As ITemplate
' The current view on the control; 0 = view1, 1 = view2
Private _currentView As Integer = 0
' Create persistable inner properties
<PersistenceMode(PersistenceMode.InnerProperty), DefaultValue(CType(Nothing, ITemplate))> _
Public Overridable Property View1() As ITemplate
Get
Return _view1
End Get
Set(ByVal value As ITemplate)
_view1 = value
End Set
End Property
<PersistenceMode(PersistenceMode.InnerProperty), DefaultValue(CType(Nothing, ITemplate))> _
Public Overridable Property View2() As ITemplate
Get
Return _view2
End Get
Set(ByVal value As ITemplate)
_view2 = value
End Set
End Property
Public Property CurrentView() As Integer
Get
Return _currentView
End Get
Set(ByVal value As Integer)
_currentView = value
End Set
End Property
' Create a simple table with a row of two clickable,
' readonly headers and a row with a single column, which
' is the 'container' to which we'll be adding controls.
Protected Overrides Sub CreateChildControls()
' Start with a clean form
Controls.Clear()
' Create a table
Dim t As New Table()
t.CellSpacing = 1
t.BorderStyle = BorderStyle
t.Width = Me.Width
t.Height = Me.Height
' Create the header row
Dim tr As New TableRow()
tr.HorizontalAlign = HorizontalAlign.Center
tr.BackColor = Color.LightBlue
' Create the first cell in the header row
Dim tc As New TableCell()
tc.Text = "View 1"
tc.Width = New Unit("50%")
tr.Cells.Add(tc)
' Create the second cell in the header row
tc = New TableCell()
tc.Text = "View 2"
tc.Width = New Unit("50%")
tr.Cells.Add(tc)
t.Rows.Add(tr)
' Create the second row for content
tr = New TableRow()
tr.HorizontalAlign = HorizontalAlign.Center
' This cell represents our content 'container'
tc = New TableCell()
tc.ColumnSpan = 2
' Add the current view content to the cell
' at run-time
If Not DesignMode Then
Dim containerControl As New Control()
Select Case CurrentView
Case 0
If Not (View1 Is Nothing) Then
View1.InstantiateIn(containerControl)
End If
Case 1
If Not (View2 Is Nothing) Then
View2.InstantiateIn(containerControl)
End If
End Select
tc.Controls.Add(containerControl)
End If
tr.Cells.Add(tc)
t.Rows.Add(tr)
' Add the finished table to the Controls collection
Controls.Add(t)
End Sub
End Class
' Region-based control designer for the above web control.
' This is derived from CompositeControlDesigner.
Public Class MyMultiRegionControlDesigner
Inherits CompositeControlDesigner
Private myControl As MyMultiRegionControl
Public Overrides Sub Initialize(ByVal component As IComponent)
MyBase.Initialize(component)
myControl = CType(component, MyMultiRegionControl)
End Sub
' Make this control resizeable on the design surface
Public Overrides ReadOnly Property AllowResize() As Boolean
Get
Return True
End Get
End Property
' Use the base to create child controls, then add region markers
Protected Overrides Sub CreateChildControls()
MyBase.CreateChildControls()
' Get a reference to the table, which is the first child control
Dim t As Table
t = CType(myControl.Controls(0), Table)
' Add design time markers for each of the three regions
If Not IsNothing(t) Then
' View1
t.Rows(0).Cells(0).Attributes(DesignerRegion.DesignerRegionAttributeName) = "0"
' View2
t.Rows(0).Cells(1).Attributes(DesignerRegion.DesignerRegionAttributeName) = "1"
' Editable region
t.Rows(1).Cells(0).Attributes(DesignerRegion.DesignerRegionAttributeName) = "2"
End If
End Sub
' Handler for the Click event, which provides the region in the arguments.
Protected Overrides Sub OnClick(ByVal e As DesignerRegionMouseEventArgs)
If IsNothing(e.Region) Then
Return
End If
' If the clicked region is not a header, return
If e.Region.Name.IndexOf("Header") <> 0 Then
Return
End If
' Switch the current view if required
If e.Region.Name.Substring(6, 1) <> myControl.CurrentView.ToString() Then
myControl.CurrentView = Integer.Parse(e.Region.Name.Substring(6, 1))
MyBase.UpdateDesignTimeHtml()
End If
End Sub
' Create the regions and design-time markup. Called by the designer host.
Public Overrides Function GetDesignTimeHtml(ByVal regions As DesignerRegionCollection) As String
' Create 3 regions: 2 clickable headers and an editable row
regions.Add(New DesignerRegion(Me, "Header0"))
regions.Add(New DesignerRegion(Me, "Header1"))
' Create an editable region and add it to the regions
Dim editableRegion As EditableDesignerRegion = _
New EditableDesignerRegion(Me, _
"Content" & myControl.CurrentView, False)
regions.Add(editableRegion)
' Set the highlight for the selected region
regions(myControl.CurrentView).Highlight = True
' Use the base class to render the markup
Return MyBase.GetDesignTimeHtml()
End Function
' Get the content string for the selected region. Called by the designer host?
Public Overrides Function GetEditableDesignerRegionContent(ByVal region As EditableDesignerRegion) As String
' Get a reference to the designer host
Dim host As IDesignerHost = CType(Component.Site.GetService(GetType(IDesignerHost)), IDesignerHost)
If Not IsNothing(host) Then
Dim template As ITemplate = myControl.View1
If region.Name = "Content1" Then
template = myControl.View2
End If
' Persist the template in the design host
If Not IsNothing(template) Then
Return ControlPersister.PersistTemplate(template, host)
End If
End If
Return String.Empty
End Function
' Create a template from the content string and put it
' in the selected view. Called by the designer host?
Public Overrides Sub SetEditableDesignerRegionContent(ByVal region As EditableDesignerRegion, ByVal content As String)
If IsNothing(content) Then
Return
End If
' Get a reference to the designer host
Dim host As IDesignerHost = CType(Component.Site.GetService(GetType(IDesignerHost)), IDesignerHost)
If Not IsNothing(host) Then
' Create a template from the content string
Dim template As ITemplate = ControlParser.ParseTemplate(host, content)
' Determine which region should get the template
If region.Name.EndsWith("0") Then
myControl.View1 = template
ElseIf region.Name.EndsWith("1") Then
myControl.View2 = template
End If
End If
End Sub
End Class
End Namespace
<%@ Page Language="C#" %>
<%@ Register TagPrefix="aspSample"
Assembly="Samples.ASPNet.ControlDesigners_CS"
Namespace="Samples.ASPNet.ControlDesigners_CS" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Designers Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<aspSample:MyMultiRegionControl ID="myCtl" Runat=Server Width=200 Height=75 BorderStyle=solid >
</aspSample:MyMultiRegionControl><br />
<asp:CheckBox ID="CheckBox1" runat="server" />
<asp:RadioButton ID="RadioButton1" runat="server" />
</div>
</form>
</body>
</html>
<%@ Page Language="VB" %>
<%@ Register TagPrefix="aspSample"
Assembly="Samples.ASPNet.ControlDesigners_VB"
Namespace="Samples.ASPNet.ControlDesigners_VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Designers Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<aspSample:MyMultiRegionControl ID="myCtl" Runat=Server Width=200 Height=75 BorderStyle=solid >
</aspSample:MyMultiRegionControl><br />
<asp:CheckBox ID="CheckBox1" runat="server" />
<asp:RadioButton ID="RadioButton1" runat="server" />
</div>
</form>
</body>
</html>
備註
使用 類別 EditableDesignerRegion 有助於在設計時間管理範本。 ControlDesigner將會使用這個類別的實例及其 GetEditableDesignerRegionContent 方法來產生區域內容的 HTML 標記。
建構函式
EditableDesignerRegion(ControlDesigner, String) |
使用指定的擁有者和名稱,初始化 EditableDesignerRegion 類別的新執行個體。 |
EditableDesignerRegion(ControlDesigner, String, Boolean) |
使用指定的擁有者和名稱,以及 EditableDesignerRegion 屬性的初始值,建立 ServerControlsOnly 類別的新執行個體。 |
屬性
Content |
取得或設定區域內容的 HTML 標記。 |
Description |
取得或設定設計工具區域的描述。 (繼承來源 DesignerRegion) |
Designer |
取得關聯的設計工具元件。 (繼承來源 DesignerObject) |
DisplayName |
取得或設定設計工具區域的易記顯示名稱。 (繼承來源 DesignerRegion) |
EnsureSize |
取得或設定值,指出設計主應用程式是否將在設計工具區域上明確設定區域大小。 (繼承來源 DesignerRegion) |
Highlight |
取得或設定值,指出是否要反白顯示設計介面上的設計工具區域。 (繼承來源 DesignerRegion) |
Name |
取得物件的名稱。 (繼承來源 DesignerObject) |
Properties |
取得物件的屬性。 (繼承來源 DesignerObject) |
Selectable |
取得或設定值,指出使用者是否可以在設計介面上選取設計工具區域。 (繼承來源 DesignerRegion) |
Selected |
取得或設定值,指出目前是否已在設計介面上選取了設計工具區域。 (繼承來源 DesignerRegion) |
ServerControlsOnly |
取得或設定值,指出區域是否只接受 Web 伺服器控制項。 |
SupportsDataBinding |
取得或設定值,指出區域是否可以繫結至資料來源。 |
UserData |
取得或設定要與設計工具區域關聯的選擇性使用者資料。 (繼承來源 DesignerRegion) |
方法
Equals(Object) |
判斷指定的物件是否等於目前的物件。 (繼承來源 Object) |
GetBounds() |
擷取設計介面上設計工具區域的大小。 (繼承來源 DesignerRegion) |
GetChildViewRendering(Control) |
傳回 ViewRendering 物件,包含指定之控制項的設計階段 HTML 標記。 |
GetHashCode() |
做為預設雜湊函式。 (繼承來源 Object) |
GetService(Type) |
從設計主應用程式取得服務,由所提供的型別識別。 (繼承來源 DesignerObject) |
GetType() |
取得目前執行個體的 Type。 (繼承來源 Object) |
MemberwiseClone() |
建立目前 Object 的淺層複製。 (繼承來源 Object) |
ToString() |
傳回代表目前物件的字串。 (繼承來源 Object) |
明確介面實作
IServiceProvider.GetService(Type) |
如需這個成員的說明,請參閱 GetService(Type)。 (繼承來源 DesignerObject) |