WebPartDesigner クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
WebPart コントロールのデザイン時のビジュアル サポートを提供します。
public ref class WebPartDesigner : System::Web::UI::Design::WebControls::WebParts::PartDesigner
public class WebPartDesigner : System.Web.UI.Design.WebControls.WebParts.PartDesigner
type WebPartDesigner = class
inherit PartDesigner
Public Class WebPartDesigner
Inherits PartDesigner
- 継承
例
次のコード例は、コントロールとそれに関連付けられている WebPartDesignerの間の相互作用をWebPart示しています。 WebPartコントロールには、エンド ユーザーが誕生日をCalendar選択するコントロール、Button選択内容を送信するコントロール、およびLabelユーザーの誕生日にメッセージを表示するコントロールが含まれます。 は WebPartDesigner 、関連付けられているコントロールが想定される型であることを確認し、そのコントロールのデザイン時レンダリングをカスタマイズします。 デザイナーの視覚的なカスタマイズはデザイン時にのみ表示されますが、関連付けられているコントロールのカスタマイズは実行時とデザイン時の両方で表示されることに注意してください。
この例でオーバーライドされたすべてのメソッドは、 ControlDesigner 基底クラスから派生します。 その他の使用可能なメンバーとその使用方法については、「」を参照してください System.Web.UI.Design.ControlDesigner。
using System;
using System.Security.Permissions;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.Design.WebControls.WebParts;
using System.ComponentModel;
/// <summary>
/// BirthdayPart demonstrates some of the most
/// common overrides of members of the WebPart
/// class. BirthdayPartDesigner shows how to
/// customize the rendering of a custom WebPart
/// control.
/// </summary>
namespace Samples.AspNet.CS.Controls
{
[AspNetHostingPermission(SecurityAction.Demand,
Level=AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level=AspNetHostingPermissionLevel.Minimal)]
[Designer(typeof(BirthdayPartDesigner))]
public class BirthdayPart : WebPart
{
private DateTime birthDate;
Calendar input;
Label displayContent;
public BirthdayPart()
{
this.AllowClose = false;
this.Title = "Enter your birthday";
}
[
Personalizable(PersonalizationScope.User, true),
WebBrowsable()
]
public DateTime BirthDate
{
get { return birthDate; }
set { birthDate = value; }
}
// Set the appearance of the control at run time.
protected override void CreateChildControls()
{
Controls.Clear();
input = new Calendar();
this.Controls.Add(input);
Button update = new Button();
update.Text = "Submit";
update.Click += new EventHandler(this.submit_Click);
this.Controls.Add(update);
displayContent = new Label();
displayContent.BackColor =
System.Drawing.Color.LightBlue;
Literal br = new Literal();
br.Text = "<br />";
if ((this.birthDate.Day == DateTime.Now.Day)
&& (this.birthDate.Month == DateTime.Now.Month))
{
displayContent.Text = "Happy Birthday!";
this.Controls.Add(br);
this.Controls.Add(displayContent);
}
}
private void submit_Click(object sender, EventArgs e)
{
this.birthDate = input.SelectedDate;
}
}
public class BirthdayPartDesigner : WebPartDesigner
{
public override void Initialize(IComponent component)
{
// Verify that the associated control is a BirthdayPart.
if (!typeof(BirthdayPart).IsInstanceOfType(component))
{
throw new ArgumentException("The specified control is not of type 'BirthdayPart'", "component");
}
base.Initialize(component);
}
// Here is where you make customizations
// to design time appearance that will not
// be visible to the end user.
public override string GetDesignTimeHtml()
{
string designTimeHtml = null;
try
{
designTimeHtml = base.GetDesignTimeHtml();
string s = "<hr /><hr />I just added these lines to the"
+ " bottom of the control.<hr /><hr /></div>";
designTimeHtml = designTimeHtml.Replace("</div>", s);
}
catch (Exception ex)
{
designTimeHtml = GetErrorDesignTimeHtml(ex);
}
finally
{
// undo any changes in the try block
}
if ((designTimeHtml == null) || (designTimeHtml.Length == 0))
{
designTimeHtml = GetEmptyDesignTimeHtml();
}
return designTimeHtml;
}
// This method normally returns a blank string.
// Override to return a meaningful message.
protected override string GetEmptyDesignTimeHtml()
{
return CreatePlaceHolderDesignTimeHtml(
"<hr />If the page developer forgot to fill in a " +
"required property you could tell them here.<hr />");
}
// Add specific text to the generic error message.
protected override string GetErrorDesignTimeHtml(Exception e)
{
string s = "<hr />The control failed to render.";
return(s + e.Message + "<hr />");
}
}
}
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Imports System.Web.UI.Design.WebControls.WebParts
Imports System.ComponentModel
' BirthdayPart demonstrates some of the most
' common overrides of members of the WebPart
' class. BirthdayPartDesigner shows how to
' customize the rendering of a custom WebPart
' control.
Namespace Samples.AspNet.VB.Controls
<AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, Level:=AspNetHostingPermissionLevel.Minimal)> _
<Designer(GetType(BirthdayPartDesigner))> _
Public Class BirthdayPart
Inherits WebPart
Private m_birthDate As DateTime
Private input As Calendar
Private displayContent As Label
Public Sub New()
Me.AllowClose = False
Me.Title = "Enter your birthday"
End Sub
<Personalizable(PersonalizationScope.User, True), WebBrowsable()> _
Public Property BirthDate() As DateTime
Get
Return m_birthDate
End Get
Set(value As DateTime)
m_birthDate = value
End Set
End Property
' Set the appearance of the control at run time.
Protected Overrides Sub CreateChildControls()
Controls.Clear()
input = New Calendar()
Me.Controls.Add(input)
Dim update As New Button()
update.Text = "Submit"
AddHandler update.Click, New EventHandler(AddressOf Me.submit_Click)
Me.Controls.Add(update)
displayContent = New Label()
displayContent.BackColor = System.Drawing.Color.LightBlue
Dim br As New Literal()
br.Text = "<br />"
If (Me.m_birthDate.Day = DateTime.Now.Day) AndAlso (Me.m_birthDate.Month = DateTime.Now.Month) Then
displayContent.Text = "Happy Birthday!"
Me.Controls.Add(br)
Me.Controls.Add(displayContent)
End If
End Sub
Private Sub submit_Click(sender As Object, e As EventArgs)
Me.m_birthDate = input.SelectedDate
End Sub
End Class
Public Class BirthdayPartDesigner
Inherits WebPartDesigner
Public Overrides Sub Initialize(component As IComponent)
' Verify that the associated control is a BirthdayPart.
If Not GetType(BirthdayPart).IsInstanceOfType(component) Then
Throw New ArgumentException("The specified control is not of type 'BirthdayPart'", "component")
End If
MyBase.Initialize(component)
End Sub
' Here is where you make customizations
' to design time appearance that will not
' be visible to the end user.
Public Overrides Function GetDesignTimeHtml() As String
Dim designTimeHtml As String = Nothing
Try
designTimeHtml = MyBase.GetDesignTimeHtml()
Dim s As String = "<hr /><hr />I just added these lines to the" & " bottom of the control.<hr /><hr /></div>"
designTimeHtml = designTimeHtml.Replace("</div>", s)
Catch ex As Exception
designTimeHtml = GetErrorDesignTimeHtml(ex)
' undo any changes in the try block
Finally
End Try
If (designTimeHtml Is Nothing) OrElse (designTimeHtml.Length = 0) Then
designTimeHtml = GetEmptyDesignTimeHtml()
End If
Return designTimeHtml
End Function
' This method normally returns a blank string.
' Override to return a meaningful message.
Protected Overrides Function GetEmptyDesignTimeHtml() As String
Return CreatePlaceHolderDesignTimeHtml("<hr />If the page developer forgot to fill in a " & "required property you could tell them here.<hr />")
End Function
' Add specific text to the generic error message.
Protected Overrides Function GetErrorDesignTimeHtml(e As Exception) As String
Dim s As String = "<hr />The control failed to render."
Return (s & e.Message & "<hr />")
End Function
End Class
End Namespace
注釈
クラスは WebPartDesigner 、デザイン時にコントロールの WebPart 視覚的表現を提供します。 これは クラスから派生し、検証を PartDesigner 追加して、関連付けられているコントロールが WebPart コントロールまたは派生型であることを確認します。
WebPartDesigner は、常に UsePreviewControl に設定されているプロパティを親から継承します true
。 これにより、ビジュアル デザイン環境で、 の一時的な View コピー WebPart をデザインサーフェイスに保持するコントロールが生成されます。このコピーはマークアップに永続化されます。 プロパティをオーバーライドして を UsePreviewControl 返 false
すと、ビジュアル デザイン環境は実際 WebPart のコントロールから直接マークアップを生成します。
Web パーツ デザイナーは通常のコントロール デザイナーとよく似ています。デザイン時の外観を設定するためのプリンシパル メソッドは、 ControlDesigner クラスから派生します。 具体的には、 メソッドを GetDesignTimeHtml オーバーライドして、コントロールに関連付けられているデザイン時マークアップを変更できます。 同様に、 メソッドと GetEmptyDesignTimeHtml メソッドをGetErrorDesignTimeHtmlオーバーライドして、それぞれエラーと空の文字列 ("") を処理できます。
コンストラクター
WebPartDesigner() |
WebPartDesigner クラスの新しいインスタンスを初期化します。 |
プロパティ
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 |
WebPart コントロールのデザイン時のビジュアル サポートを提供します。 (継承元 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() |
デザイン サーフェイスで表示または描画するために関連付けられているコントロールのコピーを返します。 (継承元 ControlDesigner) |
Dispose() |
ComponentDesigner によって使用されているすべてのリソースを解放します。 (継承元 ComponentDesigner) |
Dispose(Boolean) |
HtmlControlDesigner オブジェクトによって使用されているアンマネージド リソースを解放します。オプションでマネージド リソースも解放できます。 (継承元 HtmlControlDesigner) |
DoDefaultAction() |
コンポーネントの既定イベントに対するメソッド シグネチャをソース コード ファイル内に作成し、コード内のその位置にカーソルを移動します。 (継承元 ComponentDesigner) |
Equals(Object) |
指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object) |
GetBounds() |
デザイン サーフェイスに表示されるコントロールの境界を表す四角形の座標を取得します。 (継承元 ControlDesigner) |
GetDesignTimeHtml() |
デザイン時にコントロールを表すために使用される HTML を取得します。 (継承元 CompositeControlDesigner) |
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) |
デザイナーをコントロールにバインドし、コントロールが WebPart コントロールであることを検証します。 |
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