EditorPartDesigner クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
EditorPart コントロールのデザイン時サポートを提供します。
public ref class EditorPartDesigner : System::Web::UI::Design::WebControls::WebParts::PartDesigner
public class EditorPartDesigner : System.Web.UI.Design.WebControls.WebParts.PartDesigner
type EditorPartDesigner = class
inherit PartDesigner
Public Class EditorPartDesigner
Inherits PartDesigner
- 継承
-
EditorPartDesigner
例
次のコード例では、ユーザーがターゲット コントロールの プロパティを変更ToolTipできるようにする単純なカスタム EditorPart コントロールを作成します。 関連付けられた EditorPartDesigner はコントロールを検証し、デザイン時にユーザー入力テキスト ボックスを非表示であることを説明するラベルに置き換えます。
using System;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.ComponentModel;
using System.Security.Permissions;
using System.Web.UI.Design.WebControls.WebParts;
/// <summary>
/// SecretEditorPart is a custom EditorPart control that
/// allows the end user to change the ToolTip property of
/// a control by typing the value into a TextBox.
/// SecretEditorPartDesigner hides the TextBox at design
/// time via the view control and replaces it with the
/// words "The textbox is now hidden."
/// </summary>
namespace Samples.AspNet.CS.Controls
{
[Designer(typeof(SecretEditorPartDesigner))]
public class SecretEditorPart : EditorPart
{
public CheckBox UseCustom = new CheckBox();
public TextBox TTTextBox = new TextBox();
protected override void CreateChildControls()
{
base.CreateChildControls();
Controls.Add(UseCustom);
Literal lApply = new Literal();
lApply.Text = "Apply custom ToolTip<br />";
Controls.Add(lApply);
Controls.Add(TTTextBox);
}
public override bool ApplyChanges()
{
EnsureChildControls();
try
{
WebPartToEdit.ToolTip = TTTextBox.Text;
}
catch
{
return false;
}
return true;
}
public override void SyncChanges()
{
// Abstract method not implemented for this example
return;
}
}
public class SecretEditorPartDesigner : EditorPartDesigner
{
public override void Initialize(IComponent component)
{
// Validate the associated control
if (! (component is SecretEditorPart))
{
string msg = "The associated control must be of type 'SecretEditorPart'";
throw new ArgumentException(msg);
}
base.Initialize(component);
}
public override string GetDesignTimeHtml()
{
// Access the view control.
SecretEditorPart sep = (SecretEditorPart)ViewControl;
// Hide the textbox.
sep.TTTextBox.Visible = false;
// Now generate the base rendering.
string designTimeHtml = base.GetDesignTimeHtml();
// Insert some text.
string segment = "</div>";
designTimeHtml = designTimeHtml.Replace(segment,
"The textbox is now hidden." + segment);
// Return the modified rendering.
return designTimeHtml;
}
}
}
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Imports System.ComponentModel
Imports System.Security.Permissions
Imports System.Web.UI.Design.WebControls.WebParts
' SecretEditorPart is a custom EditorPart control that
' allows the end user to change the ToolTip property of
' a control by typing the value into a TextBox.
' SecretEditorPartDesigner hides the TextBox at design
' time via the view control and replaces it with the
' words "The textbox is now hidden."
Namespace Samples.AspNet.VB.Controls
<Designer(GetType(SecretEditorPartDesigner))> _
Public Class SecretEditorPart
Inherits EditorPart
Public UseCustom As New CheckBox()
Public TTTextBox As New TextBox()
Protected Overrides Sub CreateChildControls()
MyBase.CreateChildControls()
Controls.Add(UseCustom)
Dim lApply As New Literal()
lApply.Text = "Apply custom ToolTip<br />"
Controls.Add(lApply)
Controls.Add(TTTextBox)
End Sub
Public Overrides Function ApplyChanges() As Boolean
EnsureChildControls()
Try
WebPartToEdit.ToolTip = TTTextBox.Text
Catch
Return False
End Try
Return True
End Function
Public Overrides Sub SyncChanges()
' Abstract method not implemented for this example
Return
End Sub
End Class
Public Class SecretEditorPartDesigner
Inherits EditorPartDesigner
Public Overrides Sub Initialize(component As IComponent)
' Validate the associated control
If Not (TypeOf component Is SecretEditorPart) Then
Dim msg As String = "The associated control must be of type 'SecretEditorPart'"
Throw New ArgumentException(msg)
End If
MyBase.Initialize(component)
End Sub
Public Overrides Function GetDesignTimeHtml() As String
' Access the view control.
Dim sep As SecretEditorPart = DirectCast(ViewControl, SecretEditorPart)
' Hide the textbox.
sep.TTTextBox.Visible = False
' Now generate the base rendering.
Dim designTimeHtml As String = MyBase.GetDesignTimeHtml()
' Insert some text.
Dim segment As String = "</div>"
designTimeHtml = designTimeHtml.Replace(segment, "The textbox is now hidden." & segment)
' Return the modified rendering.
Return designTimeHtml
End Function
End Class
End Namespace
カスタム コントロールをレンダリングするには、次のコード例に示すように、ページに WebPartManager コントロール、 EditorZone コントロールを配置するための を持つ ZoneTemplate と、 WebPartZone カスタム EditorPart が動作するためのコントロールを含む が必要です。
<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<%@ Register TagPrefix="ccl" Namespace="Samples.AspNet.CS.Controls" %>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>EditorPartDesigner Sample</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:WebPartManager ID="WebPartManager1" runat="server">
</asp:WebPartManager><br />
<asp:EditorZone ID="EditorZone1" runat="server" Enabled="true" >
<ZoneTemplate>
<ccl:SecretEditorPart ID="SEPart1" runat="server" />
</ZoneTemplate>
</asp:EditorZone>
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:Button ID="Button1" runat="server" Height="24px" Text="Button" />
</ZoneTemplate>
</asp:WebPartZone><br />
</div>
</form>
</body>
</html>
<%@ Page Language="VB" AutoEventWireup="true" CodeFile="Default.aspx.vb" Inherits="_Default" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<%@ Register TagPrefix="ccl" Namespace="Samples.AspNet.VB.Controls" %>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>EditorPartDesigner Sample</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:WebPartManager ID="WebPartManager1" runat="server">
</asp:WebPartManager><br />
<asp:EditorZone ID="EditorZone1" runat="server" Enabled="true" >
<ZoneTemplate>
<ccl:SecretEditorPart ID="SEPart1" runat="server" />
</ZoneTemplate>
</asp:EditorZone>
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<asp:Button ID="Button1" runat="server" Height="24px" Text="Button" />
</ZoneTemplate>
</asp:WebPartZone><br />
</div>
</form>
</body>
</html>
を EditorPart 実行時に使用できるようにするには、ページで編集モードを有効にする必要があります。 次のコード例では、分離コード ファイルを使用してこれを行う方法を示します。
using System;
using System.Web.UI.WebControls.WebParts;
public partial class _Default : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
{
// Make the 'Edit' verb available so the EditorZone can render
WebPartManager mgr = WebPartManager.GetCurrentWebPartManager(Page);
mgr.DisplayMode = mgr.SupportedDisplayModes["Edit"];
}
}
}
Imports System.Web.UI.WebControls.WebParts
Public Partial Class _Default
Inherits System.Web.UI.Page
Protected Sub Page_Load(sender As Object, e As EventArgs)
If True Then
' Make the 'Edit' verb available so the EditorZone can render
Dim mgr As WebPartManager = WebPartManager.GetCurrentWebPartManager(Page)
mgr.DisplayMode = mgr.SupportedDisplayModes("Edit")
End If
End Sub
End Class
注釈
EditorPartDesigner は、デザイン時にコントロールを PartDesigner レンダリング EditorPart するための基底クラスのパブリック実装です。 関連付けられたコントロールからデザイン ビューにゾーン情報を伝達する機能が追加されますが、それ以外の場合は親コントロールの機能は変更されません。
他のコントロール デザイナーと同様に、 メソッドをEditorPartDesigner継承してオーバーライドすることで、カスタム EditorPart コントロールのデザイン時のレンダリングをGetDesignTimeHtml変更できます。 メソッドをオーバーライド CreateViewControl する場合は、ゾーン情報を保持するように基本実装を含めるようにしてください。
コンストラクター
EditorPartDesigner() |
EditorPartDesigner クラスの新しいインスタンスを初期化します。 |
プロパティ
ActionLists |
コントロール デザイナーのアクション リスト コレクションを取得します。 (継承元 ControlDesigner) |
AllowResize |
デザイン時環境でコントロールのサイズを変更できるかどうかを示す値を取得します。 (継承元 ControlDesigner) |
AssociatedComponents |
デザイナーで管理されているコンポーネントに関連付けられているコンポーネントのコレクションを取得します。 (継承元 ComponentDesigner) |
AutoFormats |
関連付けられたコントロールの [オートフォーマット] ダイアログ ボックスにデザイン時に表示される定義済みの自動書式指定スキームのコレクションを取得します。 (継承元 ControlDesigner) |
Behavior |
古い.
デザイナーに関連付けられている DHTML 動作を取得または設定します。 (継承元 HtmlControlDesigner) |
Component |
デザイナーがデザインするコンポーネントを取得します。 (継承元 ComponentDesigner) |
DataBindings |
現在のコントロールのデータ バインディング コレクションを取得します。 (継承元 HtmlControlDesigner) |
DataBindingsEnabled |
関連付けられているコントロールの格納先の領域がデータ バインディングをサポートするかどうかを示す値を取得します。 (継承元 ControlDesigner) |
DesignerState |
デザイン時に関連付けられているコントロールのデータを永続化するために使用するオブジェクトを取得します。 (継承元 ControlDesigner) |
DesignTimeElement |
古い.
デザイン サーフェイスの HtmlControlDesigner オブジェクトと関連付けられているコントロールを表すデザイン時オブジェクトを取得します。 (継承元 HtmlControlDesigner) |
DesignTimeElementView |
古い.
コントロール デザイナーのビュー コントロール オブジェクトを取得します。 (継承元 ControlDesigner) |
DesignTimeHtmlRequiresLoadComplete |
古い.
デザイン ホストが読み込みを完了しないと GetDesignTimeHtml メソッドを呼び出すことができないかどうかを示す値を取得します。 (継承元 ControlDesigner) |
Expressions |
現在のコントロールの式バインディングをデザイン時に取得します。 (継承元 HtmlControlDesigner) |
HidePropertiesInTemplateMode |
コントロールがテンプレート モードのときに関連付けられているコントロールのプロパティが非表示に設定されるかどうかを示す値を取得します。 (継承元 ControlDesigner) |
ID |
コントロールの ID 文字列を取得または設定します。 (継承元 ControlDesigner) |
InheritanceAttribute |
関連付けられているコンポーネントの継承の種類を示す属性を取得します。 (継承元 ComponentDesigner) |
Inherited |
コンポーネントが継承されているかどうかを示す値を取得します。 (継承元 ComponentDesigner) |
InTemplateMode |
デザイン ホストでコントロールがテンプレート表示モードまたは編集モードのいずれかであるかどうかを示す値を取得します。 InTemplateMode プロパティは読み取り専用です。 (継承元 ControlDesigner) |
IsDirty |
古い.
Web サーバー コントロールが変更済みとしてマークされているかどうかを示す値を取得または設定します。 (継承元 ControlDesigner) |
ParentComponent |
このデザイナーの親コンポーネントを取得します。 (継承元 ComponentDesigner) |
ReadOnly |
古い.
コントロールのプロパティがデザイン時に読み取り専用かどうかを示す値を取得または設定します。 (継承元 ControlDesigner) |
RootDesigner |
関連付けられているコントロールを含む Web フォーム ページのコントロール デザイナーを取得します。 (継承元 ControlDesigner) |
SetTextualDefaultProperty |
EditorPart コントロールのデザイン時サポートを提供します。 (継承元 ComponentDesigner) |
ShadowProperties |
ユーザー設定値をオーバーライドするプロパティ値のコレクションを取得します。 (継承元 ComponentDesigner) |
ShouldCodeSerialize |
古い.
シリアル化中に、現在のデザイン ドキュメントの分離コード ファイル内でコントロールのフィールド宣言を作成するかどうかを示す値を取得または設定します。 (継承元 HtmlControlDesigner) |
Tag |
関連付けられているコントロールの HTML マークアップ要素を表すオブジェクトを取得します。 (継承元 ControlDesigner) |
TemplateGroups |
それぞれが 1 つまたは複数のテンプレート定義を含む、テンプレート グループのコレクションを取得します。 (継承元 ControlDesigner) |
UsePreviewControl |
デザイン時のマークアップを生成するときに、デザイナーに関連付けられた実際のコントロールではなく、一時的なコピーをデザイナーで使用するかどうかを示す値を取得します。 (継承元 PartDesigner) |
Verbs |
デサイナに関連付けられているコンポーネントがサポートしているデザイン時の動詞を取得します。 (継承元 ComponentDesigner) |
ViewControl |
デザイン時 HTML マークアップのプレビュー用に使用できる Web サーバー コントロールを取得または設定します。 (継承元 ControlDesigner) |
ViewControlCreated |
|
Visible |
コントロールがデザイン時に表示されるかどうかを示す値を取得します。 (継承元 ControlDesigner) |
メソッド
CreateChildControls() |
対象の CompositeControl コントロールの子コントロールを作成します。 (継承元 CompositeControlDesigner) |
CreateErrorDesignTimeHtml(String) |
指定したエラー メッセージをデザイン時に表示するための HTML マークアップを作成します。 (継承元 ControlDesigner) |
CreateErrorDesignTimeHtml(String, Exception) |
指定した例外エラー メッセージをデザイン時に表示するための HTML マークアップを作成します。 (継承元 ControlDesigner) |
CreatePlaceHolderDesignTimeHtml() |
コントロールの種類と ID を表示する単純な四角形のプレースホルダー表示を提供します。 (継承元 ControlDesigner) |
CreatePlaceHolderDesignTimeHtml(String) |
コントロールの種類と ID を表示する単純な四角形のプレースホルダー表示を提供します。指定された追加指示または追加情報も提供します。 (継承元 ControlDesigner) |
CreateViewControl() |
デザイン時に表示する、関連付けられている EditorPart コントロールのコピーを作成します。 |
Dispose() |
ComponentDesigner によって使用されているすべてのリソースを解放します。 (継承元 ComponentDesigner) |
Dispose(Boolean) |
HtmlControlDesigner オブジェクトによって使用されているアンマネージド リソースを解放します。オプションでマネージド リソースも解放できます。 (継承元 HtmlControlDesigner) |
DoDefaultAction() |
コンポーネントの既定イベントに対するメソッド シグネチャをソース コード ファイル内に作成し、コード内のその位置にカーソルを移動します。 (継承元 ComponentDesigner) |
Equals(Object) |
指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object) |
GetBounds() |
デザイン サーフェイスに表示されるコントロールの境界を表す四角形の座標を取得します。 (継承元 ControlDesigner) |
GetDesignTimeHtml() |
型が EditorZoneBase のゾーンにコントロールがあることを検証した後、デザイン時にコントロールを表すために使用するマークアップを取得します。 |
GetDesignTimeHtml(DesignerRegionCollection) |
コントロールを表示する HTML マークアップを取得し、現在のコントロール デザイナー領域をコレクションに設定します。 (継承元 ControlDesigner) |
GetEditableDesignerRegionContent(EditableDesignerRegion) |
関連付けられたコントロールのデザイン時ビューの編集可能領域の内容を返します。 (継承元 ControlDesigner) |
GetEmptyDesignTimeHtml() |
実行時には視覚的な表示がない Web サーバー コントロールをデザイン時に表すための HTML マークアップを取得します。 (継承元 ControlDesigner) |
GetErrorDesignTimeHtml(Exception) |
指定された例外に関する情報を提供する HTML マークアップを取得します。 (継承元 ControlDesigner) |
GetHashCode() |
既定のハッシュ関数として機能します。 (継承元 Object) |
GetPersistenceContent() |
コントロールの永続化できる内部 HTML マークアップをデザイン時に取得します。 (継承元 ControlDesigner) |
GetPersistInnerHtml() |
古い.
コントロールの永続化できる内部 HTML マークアップを取得します。 (継承元 ControlDesigner) |
GetService(Type) |
デザイナーのコンポーネントのデザイン モード サイトから、指定した型のサービスの取得を試みます。 (継承元 ComponentDesigner) |
GetType() |
現在のインスタンスの Type を取得します。 (継承元 Object) |
GetViewRendering() |
関連付けられているコントロールの内容および領域のデザイン時マークアップを格納しているオブジェクトを取得します。 (継承元 ControlDesigner) |
Initialize(IComponent) |
関連付けられている EditorPart コントロールにデザイナーをバインドします。 |
InitializeExistingComponent(IDictionary) |
既存のコンポーネントを再初期化します。 (継承元 ComponentDesigner) |
InitializeNewComponent(IDictionary) |
新たに作成されたコンポーネントを初期化します。 (継承元 ComponentDesigner) |
InitializeNonDefault() |
古い.
古い.
既定値以外の値に既に初期化されている、インポートされたコンポーネントの設定値を初期化します。 (継承元 ComponentDesigner) |
Invalidate() |
デザイン サーフェイスに表示されたコントロールの領域全体を無効化し、コントロールを再描画するようにコントロール デザイナーに通知します。 (継承元 ControlDesigner) |
Invalidate(Rectangle) |
デザイン サーフェイスに表示されたコントロールの指定された領域を無効化し、コントロールを再描画するようにコントロール デザイナーに通知します。 (継承元 ControlDesigner) |
InvokeGetInheritanceAttribute(ComponentDesigner) |
指定した InheritanceAttribute の ComponentDesigner を取得します。 (継承元 ComponentDesigner) |
IsPropertyBound(String) |
古い.
関連付けられているコントロールの指定されたプロパティがデータ バインドされているかどうかを示す値を取得します。 (継承元 ControlDesigner) |
Localize(IDesignTimeResourceWriter) |
提供されたリソース ライターを使用して、関連付けられているコントロールのローカライズ可能なプロパティをデザイン ホストのリソースに永続化します。 (継承元 ControlDesigner) |
MemberwiseClone() |
現在の Object の簡易コピーを作成します。 (継承元 Object) |
OnAutoFormatApplied(DesignerAutoFormat) |
定義済みのオートフォーマット スキームが関連付けられているコントロールに適用されているときに呼び出されます。 (継承元 ControlDesigner) |
OnBehaviorAttached() |
コントロール デザイナーが Behavior オブジェクトにアタッチされていると、呼び出されます。 (継承元 ControlDesigner) |
OnBehaviorDetaching() |
古い.
動作と要素の関連付けが解除されたときに呼び出されます。 (継承元 HtmlControlDesigner) |
OnBindingsCollectionChanged(String) |
古い.
データ バインディング コレクションが変更されると、呼び出されます。 (継承元 ControlDesigner) |
OnClick(DesignerRegionMouseEventArgs) |
関連付けられているコントロールをデザイン時にユーザーがクリックすると、デザイン ホストによって呼び出されます。 (継承元 ControlDesigner) |
OnComponentChanged(Object, ComponentChangedEventArgs) |
関連付けられているコントロールが変更されたときに呼び出されます。 (継承元 ControlDesigner) |
OnComponentChanging(Object, ComponentChangingEventArgs) |
関連付けられているコントロールの ComponentChanging イベントを処理するメソッドを表します。 (継承元 ControlDesigner) |
OnControlResize() |
古い.
関連付けられている Web サーバー コントロールのサイズがデザイン時にデザイン ホストで変更された場合に呼び出されます。 (継承元 ControlDesigner) |
OnPaint(PaintEventArgs) |
CustomPaint 値が |
OnSetComponentDefaults() |
古い.
古い.
コンポーネントの既定のプロパティを設定します。 (継承元 ComponentDesigner) |
OnSetParent() |
関連付けられたコントロールが親コントロールに結び付けられている場合に追加処理を実行する手段を提供します。 (継承元 HtmlControlDesigner) |
PostFilterAttributes(IDictionary) |
デザイナーが、TypeDescriptor を通じて公開する一連の属性から、項目を変更または削除できるようにします。 (継承元 ComponentDesigner) |
PostFilterEvents(IDictionary) |
デザイナーが、TypeDescriptor を通じて公開する一連のイベントから、項目を変更または削除できるようにします。 (継承元 ComponentDesigner) |
PostFilterProperties(IDictionary) |
デザイナーが、TypeDescriptor を通じて公開する一連のプロパティから、項目を変更または削除できるようにします。 (継承元 ComponentDesigner) |
PreFilterAttributes(IDictionary) |
デザイナーが、TypeDescriptor を通じて公開する一連の属性に項目を追加できるようにします。 (継承元 ComponentDesigner) |
PreFilterEvents(IDictionary) |
デザイン時にコンポーネントの TypeDescriptor オブジェクトに公開されているイベントのリストを設定します。 (継承元 HtmlControlDesigner) |
PreFilterProperties(IDictionary) |
デザイン時にデザイン ホストのプロパティ グリッドを対象にプロパティの追加や削除を行ったり、関連付けられたコントロール上のプロパティに対応する新しいデザイン時プロパティを提供したりします。 (継承元 ControlDesigner) |
RaiseComponentChanged(MemberDescriptor, Object, Object) |
コンポーネントが変更されたことを IComponentChangeService に通知します。 (継承元 ComponentDesigner) |
RaiseComponentChanging(MemberDescriptor) |
コンポーネントが変更されようとしていることを IComponentChangeService に通知します。 (継承元 ComponentDesigner) |
RaiseResizeEvent() |
古い.
OnControlResize() イベントを発生させます。 (継承元 ControlDesigner) |
RegisterClone(Object, Object) |
複製が作成されたコントロールの内部データを登録します。 (継承元 ControlDesigner) |
SetEditableDesignerRegionContent(EditableDesignerRegion, String) |
デザイン時にコントロールの編集可能領域の内容を指定します。 (継承元 ControlDesigner) |
SetRegionContent(EditableDesignerRegion, String) |
コントロールのデザイン時ビューの編集可能領域の内容を指定します。 (継承元 ControlDesigner) |
SetViewFlags(ViewFlags, Boolean) |
指定したビットごとの ViewFlags 列挙体を指定したフラグ値に割り当てます。 (継承元 ControlDesigner) |
ToString() |
現在のオブジェクトを表す文字列を返します。 (継承元 Object) |
UpdateDesignTimeHtml() |
GetDesignTimeHtml メソッドを呼び出して、関連付けられている Web サーバー コントロールのデザイン時 HTML マークアップを更新します。 (継承元 ControlDesigner) |
明示的なインターフェイスの実装
適用対象
こちらもご覧ください
.NET