EditorPart クラス

定義

名前空間:: System.Web.UI.WebControls.WebParts

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

EditorZoneBase ゾーンに存在し、WebPart コントロールの編集に使用されるコントロールの基本クラスとして機能します。

public ref class EditorPart abstract : System::Web::UI::WebControls::WebParts::Part

[System.ComponentModel.Bindable(false)]
public abstract class EditorPart : System.Web.UI.WebControls.WebParts.Part

[<System.ComponentModel.Bindable(false)>]
type EditorPart = class
    inherit Part

Public MustInherit Class EditorPart
Inherits Part

継承: Object

Control

WebControl

Panel

Part
EditorPart

派生: System.Web.UI.WebControls.WebParts.AppearanceEditorPart

System.Web.UI.WebControls.WebParts.BehaviorEditorPart

System.Web.UI.WebControls.WebParts.LayoutEditorPart

System.Web.UI.WebControls.WebParts.PropertyGridEditorPart

属性: BindableAttribute

例

次のコード例は、 EditorPart コントロールの宣言型およびプログラムによる使用を示しています。このコード例には、次の 4 つの部分があります。

Web パーツページの表示モードを変更できるユーザーコントロール。
EditorZone コントロールを含む Web ページ。ゾーンで宣言された Web パーツコントロールセットのEditorPart コントロールのいくつかと、カスタム WebPart コントロールへの参照が含まれます。
カスタム WebPart コントロールと、EditorPart コントロールのプロパティを編集するためのカスタム WebPart コントロールを含むクラス。
ブラウザーでページを読み込むときにこの例がどのように機能するかの説明。

このコード例の最初の部分は、ユーザーが Web ページの表示モードを変更できるようにするユーザーコントロールです。表示モードの詳細と、このコントロールのソースコードの説明については、「チュートリアル: Web パーツページでの表示モードの変更」を参照してください。

<%@ control language="C#" classname="DisplayModeMenuCS"%>

<script runat="server">
  
 // Use a field to reference the current WebPartManager.
  WebPartManager _manager;

  void Page_Init(object sender, EventArgs e)
  {
    Page.InitComplete += new EventHandler(InitComplete);
  }  

  void InitComplete(object sender, System.EventArgs e)
  {
    _manager = WebPartManager.GetCurrentWebPartManager(Page);

    String browseModeName = WebPartManager.BrowseDisplayMode.Name;

    // Fill the dropdown with the names of supported display modes.
    foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)
    {
      String modeName = mode.Name;
      // Make sure a mode is enabled before adding it.
      if (mode.IsEnabled(_manager))
      {
        ListItem item = new ListItem(modeName + " Mode", modeName);
        DisplayModeDropdown.Items.Add(item);
      }
    }

  }
 
  // Change the page to the selected display mode.
  void DisplayModeDropdown_SelectedIndexChanged(object sender, 
    EventArgs e)
  {
    String selectedMode = DisplayModeDropdown.SelectedValue;

    WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];
    if (mode != null)
      _manager.DisplayMode = mode;

  }

  void Page_PreRender(object sender, EventArgs e)
  {
    DisplayModeDropdown.SelectedValue = _manager.DisplayMode.Name;
  }
  
</script>
<div>
  <asp:DropDownList ID="DisplayModeDropdown" 
    runat="server"  
    AutoPostBack="true" 
    OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
</div>

<%@ control language="vb" classname="DisplayModeMenuVB"%>

<script runat="server">
  
' Use a field to reference the current WebPartManager.
Dim _manager As WebPartManager


Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs) 
    AddHandler Page.InitComplete, AddressOf InitComplete

End Sub 


Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs) 
    _manager = WebPartManager.GetCurrentWebPartManager(Page)
    
    Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name
    
    ' Fill the dropdown with the names of supported display modes.
    Dim mode As WebPartDisplayMode
    For Each mode In  _manager.SupportedDisplayModes
        Dim modeName As String = mode.Name
        ' Make sure a mode is enabled before adding it.
        If mode.IsEnabled(_manager) Then
            Dim item As New ListItem(modeName + " Mode", modeName)
            DisplayModeDropdown.Items.Add(item)
        End If
    Next mode

End Sub 
 

' Change the page to the selected display mode.
Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs) 
    Dim selectedMode As String = DisplayModeDropdown.SelectedValue
    
    Dim mode As WebPartDisplayMode = _manager.SupportedDisplayModes(selectedMode)
    If Not (mode Is Nothing) Then
        _manager.DisplayMode = mode
    End If
 
End Sub 


Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs) 
    DisplayModeDropdown.SelectedValue = _manager.DisplayMode.Name

End Sub 

</script>
<div>
  <asp:DropDownList ID="DisplayModeDropdown" 
    runat="server"  
    AutoPostBack="true" 
    OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
</div>

コード例の 2 番目の部分は Web ページです。これには、 EditorZone コントロールへの宣言型参照が含まれています。子 <zonetemplate> 要素には、2 つの Web パーツコントロールセット EditorPart コントロールへの宣言型参照が含まれています。このページでは、アセンブリのWebPart ディレクティブと、コントロールの Register 要素を使用して、カスタム <aspSample:TextDisplayWebPart> コントロールも参照します。

<%@ page language="c#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenu" 
  Src="DisplayModecs.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.CS.Controls" 
  Assembly="TextDisplayWebPartCS" %>

<!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>
      Text Display WebPart with EditorPart
    </title>
  </head>
  <body>
    <form id="form1" runat="server">
      <asp:webpartmanager id="WebPartManager1" runat="server" />
      <uc1:DisplayModeMenu ID="DisplayModeMenu1" runat="server" />
      <asp:webpartzone id="zone1" runat="server" 
        CloseVerb-Enabled="false">
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" />          
        </zonetemplate>
      </asp:webpartzone> 
      <asp:EditorZone ID="EditorZone1" runat="server">
        <ZoneTemplate>
          <asp:AppearanceEditorPart ID="AppearanceEditorPart1" 
            runat="server" />
          <asp:LayoutEditorPart ID="LayoutEditorPart1" 
            runat="server" />
        </ZoneTemplate>      
      </asp:EditorZone>
    </form>
  </body>
</html>

<%@ page language="vb" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenu" 
  Src="DisplayModevb.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.VB.Controls" 
  Assembly="TextDisplayWebPartVB" %>

<!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 id="Head1" runat="server">
    <title>
      Text Display WebPart with EditorPart
    </title>
  </head>
  <body>
    <form id="form1" runat="server">
      <asp:webpartmanager id="WebPartManager1" runat="server" />
      <uc1:DisplayModeMenu ID="DisplayModeMenu1" runat="server" />
      <asp:webpartzone id="zone1" runat="server" 
        CloseVerb-Enabled="false">
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" />          
        </zonetemplate>
      </asp:webpartzone> 
      <asp:EditorZone ID="EditorZone1" runat="server">
        <ZoneTemplate>
          <asp:AppearanceEditorPart ID="AppearanceEditorPart1" 
            runat="server" />
          <asp:LayoutEditorPart ID="LayoutEditorPart1" 
            runat="server" />
        </ZoneTemplate>      
      </asp:EditorZone>
    </form>
  </body>
</html>

コード例の 3 番目の部分は、WebPartという名前のカスタム TextDisplayWebPart クラスです。このクラスは、 IWebEditable インターフェイスを実装します。このクラス内には、EditorPart クラスに関連付けられたプライベート TextDisplayWebPart クラスのコードと名前付きTextDisplayEditorPartを含む、入れ子になったプライベートクラスがあります。実行時に、TextDisplayWebPart コントロールは編集モードに入ると、TextDisplayWebPart.CreateEditorParts メソッドでTextDisplayEditorPart クラスのインスタンスを作成し、他のEditorZone コントロールと共にEditorPart コントロールに表示します。

using System;
using System.Collections;
using System.ComponentModel;
using System.Drawing;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class TextDisplayWebPart : WebPart
  {
    private String _contentText = null;
    private String _fontStyle = null;
    TextBox input;
    Label DisplayContent;
    Literal lineBreak;

    public override EditorPartCollection CreateEditorParts()
    {
      ArrayList editorArray = new ArrayList();
      TextDisplayEditorPart edPart = new TextDisplayEditorPart();
      edPart.ID = this.ID + "_editorPart1";
      editorArray.Add(edPart);
      EditorPartCollection editorParts = 
        new EditorPartCollection(editorArray);
      return editorParts;
    }

    public override object WebBrowsableObject
    {
      get { return this; }
    }

    [Personalizable(), WebBrowsable]
    public String ContentText
    {
      get { return _contentText; }
      set { _contentText = value; }
    }

    [Personalizable(), WebBrowsable()]
    public String FontStyle
    {
      get { return _fontStyle; }
      set { _fontStyle = value; }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      DisplayContent.BackColor = Color.LightBlue;
      DisplayContent.Text = this.ContentText;
      if (FontStyle == null)
        FontStyle = "None";
      SetFontStyle(DisplayContent, FontStyle);
      this.Controls.Add(DisplayContent);

      lineBreak = new Literal();
      lineBreak.Text = @"<br />";
      Controls.Add(lineBreak);

      input = new TextBox();
      this.Controls.Add(input);
      Button update = new Button();
      update.Text = "Set Label Content";
      update.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(update);
    }

    private void submit_Click(object sender, EventArgs e)
    {
      // Update the label string.
      if (!string.IsNullOrEmpty(input.Text))
      {
        _contentText = input.Text + @"<br />";
        input.Text = String.Empty;
        DisplayContent.Text = this.ContentText;
      }
    }

    private void SetFontStyle(Label label, String selectedStyle)
    {
      if (selectedStyle == "Bold")
      {
        label.Font.Bold = true;
        label.Font.Italic = false;
        label.Font.Underline = false;
      }
      else if (selectedStyle == "Italic")
      {
        label.Font.Italic = true;
        label.Font.Bold = false;
        label.Font.Underline = false;
      }
      else if (selectedStyle == "Underline")
      {
        label.Font.Underline = true;
        label.Font.Bold = false;
        label.Font.Italic = false;
      }
      else
      {
        label.Font.Bold = false;
        label.Font.Italic = false;
        label.Font.Underline = false;
      }
    }

    // Create a custom EditorPart to edit the WebPart control.
    [AspNetHostingPermission(SecurityAction.Demand,
      Level = AspNetHostingPermissionLevel.Minimal)]
    private class TextDisplayEditorPart : EditorPart
    {
      DropDownList _partContentFontStyle;

      public TextDisplayEditorPart()
      {
        Title = "Font Face";
      }

      public override bool ApplyChanges()
      {
        TextDisplayWebPart part = 
          (TextDisplayWebPart)WebPartToEdit;
        // Update the custom WebPart control with the font style.
        part.FontStyle = PartContentFontStyle.SelectedValue;

        return true;
      }

      public override void SyncChanges()
      {
        TextDisplayWebPart part = 
          (TextDisplayWebPart)WebPartToEdit;
        String currentStyle = part.FontStyle;

        // Select the current font style in the drop-down control.
        foreach (ListItem item in PartContentFontStyle.Items)
        {
          if (item.Value == currentStyle)
          {
            item.Selected = true;
            break;
          }
        }
      }

      protected override void CreateChildControls()
      {
        Controls.Clear();

        // Add a set of font styles to the dropdown list.
        _partContentFontStyle = new DropDownList();
        _partContentFontStyle.Items.Add("Bold");
        _partContentFontStyle.Items.Add("Italic");
        _partContentFontStyle.Items.Add("Underline");
        _partContentFontStyle.Items.Add("None");

        Controls.Add(_partContentFontStyle);
      }

      protected override void RenderContents(HtmlTextWriter writer)
      {
        writer.Write("<b>Text Content Font Style</b>");
        writer.WriteBreak();
        writer.Write("Select a font style.");
        writer.WriteBreak();
        _partContentFontStyle.RenderControl(writer);
        writer.WriteBreak();
      }

      // Access the drop-down control through a property.
      private DropDownList PartContentFontStyle
      {
        get 
        {
          EnsureChildControls();
          return _partContentFontStyle;
        }
      }
    }
  }
}

Imports System.Collections
Imports System.ComponentModel
Imports System.Drawing
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls
  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class TextDisplayWebPart
    Inherits WebPart
    Private _contentText As String = Nothing
    Private _fontStyle As String = Nothing
    Private input As TextBox
    Private DisplayContent As Label
    Private lineBreak As Literal

    Public Overrides Function CreateEditorParts() _
                                As EditorPartCollection
      Dim editorArray As New ArrayList()
      Dim edPart as New TextDisplayEditorPart()
      edPart.ID = Me.ID & "_editorPart1"
      editorArray.Add(edPart)
      Dim editorParts As New EditorPartCollection(editorArray)
      Return editorParts

    End Function

    Public Overrides ReadOnly Property WebBrowsableObject() _
                                        As Object
      Get
        Return Me
      End Get
    End Property

    <Personalizable(), WebBrowsable()> _
    Public Property ContentText() As String
      Get
        Return _contentText
      End Get
      Set(ByVal value As String)
        _contentText = Value
      End Set
    End Property

    <Personalizable(), WebBrowsable()> _
    Public Property FontStyle() As String
      Get
        Return _fontStyle
      End Get
      Set(ByVal value As String)
        _fontStyle = Value
      End Set
    End Property

    Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      DisplayContent = New Label()
      DisplayContent.BackColor = Color.LightBlue
      DisplayContent.Text = Me.ContentText
      If FontStyle Is Nothing Then
        FontStyle = "None"
      End If
      SetFontStyle(DisplayContent, FontStyle)
      Me.Controls.Add(DisplayContent)

      lineBreak = New Literal()
      lineBreak.Text = "<br />"
      Controls.Add(lineBreak)

      input = New TextBox()
      Me.Controls.Add(input)
      Dim update As New Button()
      update.Text = "Set Label Content"
      AddHandler update.Click, AddressOf Me.submit_Click
      Me.Controls.Add(update)

    End Sub

    Private Sub submit_Click(ByVal sender As Object, _
                             ByVal e As EventArgs)
      ' Update the label string.
      If input.Text <> String.Empty Then
        _contentText = input.Text + "<br />"
        input.Text = String.Empty
        DisplayContent.Text = Me.ContentText
      End If

    End Sub

    Private Sub SetFontStyle(ByVal label As Label, _
                             ByVal selectedStyle As String)
      If selectedStyle = "Bold" Then
        label.Font.Bold = True
        label.Font.Italic = False
        label.Font.Underline = False
      ElseIf selectedStyle = "Italic" Then
        label.Font.Italic = True
        label.Font.Bold = False
        label.Font.Underline = False
      ElseIf selectedStyle = "Underline" Then
        label.Font.Underline = True
        label.Font.Bold = False
        label.Font.Italic = False
      Else
        label.Font.Bold = False
        label.Font.Italic = False
        label.Font.Underline = False
      End If

    End Sub

    ' Create a custom EditorPart to edit the WebPart control.
    <AspNetHostingPermission(SecurityAction.Demand, _
      Level:=AspNetHostingPermissionLevel.Minimal)> _
    Private Class TextDisplayEditorPart
      Inherits EditorPart
      Private _partContentFontStyle As DropDownList

      Public Sub New()
        Title = "Font Face"
      End Sub

      Public Overrides Function ApplyChanges() As Boolean
        Dim part As TextDisplayWebPart = CType(WebPartToEdit, _
                                               TextDisplayWebPart)
        ' Update the custom WebPart control with the font style.
        part.FontStyle = PartContentFontStyle.SelectedValue

        Return True

      End Function

      Public Overrides Sub SyncChanges()
        Dim part As TextDisplayWebPart = CType(WebPartToEdit, _
                                               TextDisplayWebPart)
        Dim currentStyle As String = part.FontStyle

        ' Select the current font style in the drop-down control.
        Dim item As ListItem
        For Each item In PartContentFontStyle.Items
          If item.Value = currentStyle Then
            item.Selected = True
            Exit For
          End If
        Next item

      End Sub

      Protected Overrides Sub CreateChildControls()
        Controls.Clear()

        ' Add a set of font styles to the dropdown list.
        _partContentFontStyle = New DropDownList()
        _partContentFontStyle.Items.Add("Bold")
        _partContentFontStyle.Items.Add("Italic")
        _partContentFontStyle.Items.Add("Underline")
        _partContentFontStyle.Items.Add("None")

        Controls.Add(_partContentFontStyle)

      End Sub

      Protected Overrides Sub RenderContents(ByVal writer _
                                             As HtmlTextWriter)
        writer.Write("<b>Text Content Font Style</b>")
        writer.WriteBreak()
        writer.Write("Select a font style.")
        writer.WriteBreak()
        _partContentFontStyle.RenderControl(writer)
        writer.WriteBreak()

      End Sub

      ' Access the drop-down control through a property.
      Private ReadOnly Property PartContentFontStyle() As DropDownList
        Get
          EnsureChildControls()
          Return _partContentFontStyle
        End Get
      End Property

    End Class

  End Class

End Namespace

ブラウザーでページを読み込み、[ 表示モード ] コントロールで [編集モード ] を選択して編集モードに切り替えます。 TextDisplayWebPart コントロールのタイトルバーにある動詞メニュー (下向き矢印) をクリックし、[編集] をクリックしてコントロールを編集します。編集 UI が表示されると、EditorPart プロパティを編集できるカスタムコントロールを含む 3 つのTextDisplayWebPart.FontStyle コントロールが表示されます。編集 UI で変更を加えて [ 適用 ] ボタンをクリックすると、ドロップダウンリストコントロールを使用してページを参照モードに戻し、編集の変更の効果をすべて確認できます。

注釈

EditorPart クラスは、Web パーツコントロールセットとカスタム EditorPart コントロールによって提供される派生EditorPart コントロールによって使用されるプロパティとメソッドの基本セットを提供します。 EditorPart コントロールを使用すると、ユーザーは、そのレイアウト、外観、プロパティ、動作、またはその他の特性を変更することによって、関連付けられているWebPart コントロールを編集できます。

EditorZoneBase コントロールを含むEditorPartゾーンで構成される編集ユーザーインターフェイス (UI) は、Web ページが編集モードになった後に表示されます。

Note

EditorPart コントロールは、EditorZoneBase コントロールなど、EditorZone クラスから派生したゾーン内でのみ使用できます。

ページが編集モードになった後、ユーザーは、選択したコントロールの動詞メニューの編集動詞をクリックして、編集する WebPart コントロールを選択できます。一度に編集できる WebPart コントロールは 1 つだけです。

次の表に示すように、Web パーツコントロールセットには、いくつかの派生 EditorPart コントロールが用意されています。これらのコントロールは、ほとんどのアプリケーションに必要なすべての編集機能を提供します。 Web パーツページでこれらのコントロールを使用する一般的な方法は、 <zonetemplate> 要素内でページ永続化形式で宣言することです。ここで、 <zonetemplate> は <asp:editorzone> 要素の子要素です。コード例については、このトピックの「例」セクションを参照してください。

コントロールの種類	Description
AppearanceEditorPart	タイトルテキスト、高さ、幅、罫線属性などのプロパティを含む、関連付けられたコントロールの外観を編集します。
BehaviorEditorPart	関連付けられているコントロールの特定の動作 (編集できるかどうか、閉じることができるかどうか、別のゾーンに移動できるかどうかなど) を編集します。このコントロールは、共有パーソナル化スコープでコントロールが編集されている場合にのみ、ページに表示されます。
LayoutEditorPart	関連付けられているコントロールのレイアウト属性を編集します。たとえば、コントロールが通常の状態か最小化 (折りたたまれている状態) か、配置されているゾーンなどです。
PropertyGridEditorPart	関連付けられたコントロールのプロパティを編集します(これらのプロパティがソースコードで `WebBrowsable` 属性で宣言されている場合)。

Note

アクセシビリティを向上させるために、Web パーツコントロールセットで提供されるすべての EditorPart コントロールは、 <fieldset> 要素内にレンダリングされます。 <fieldset>要素は、特定のEditorPart コントロールでの編集に使用される関連するコントロールのセットをグループ化し、ビジュアルユーザーエージェント (通常の Web ブラウザーなど) と音声指向ユーザーエージェント (画面読み取りソフトウェアなど) の両方のコントロール間のタブナビゲーションを容易にします。

注意 (実装者)

カスタム EditorPart コントロールを作成するには、2 つの重要なメソッドをオーバーライドする必要があります。 ApplyChanges() メソッドは、エディターコントロールで行われた変更を、編集中のWebPart コントロールに適用します。 SyncChanges() メソッドは、編集中のWebPart コントロールの現在の値を取得し、エディターコントロールで編集できるようにします。これら 2 つの重要なメソッドを使用して、カスタム EditorPart コントロールと編集中の WebPart コントロールの間で値を取得および設定します。

EditorPart クラスから派生してカスタムエディターコントロールを作成する場合は、EditorZoneBase コントロール、ユーザーコントロール、またはサーバーコントロールにIWebEditable インターフェイスを実装することで、カスタムコントロールを WebPart ゾーンに追加できます。詳細とコード例については、 IWebEditable クラスの概要を参照してください。また、「例」セクションのコード例では、カスタム IWebEditable コントロールにWebPartを実装する方法を示します。

コンストラクター

名前	説明
EditorPart()	継承されたクラスインスタンスで使用するクラスを初期化します。このコンストラクターは、継承されたクラスによってのみ呼び出すことができます。

プロパティ

名前	説明
AccessKey	Web サーバーコントロールにすばやく移動できるアクセスキーを取得または設定します。 (継承元 WebControl)
Adapter	コントロールのブラウザー固有のアダプターを取得します。 (継承元 Control)
AppRelativeTemplateSourceDirectory	このコントロールを含む Page または UserControl オブジェクトのアプリケーション相対仮想ディレクトリを取得または設定します。 (継承元 Control)
Attributes	コントロールのプロパティに対応しない任意の属性のコレクションを取得します (レンダリングのみ)。 (継承元 WebControl)
BackColor	Web サーバーコントロールの背景色を取得または設定します。 (継承元 WebControl)
BackImageUrl	パネルコントロールの背景画像の URL を取得または設定します。 (継承元 Panel)
BindingContainer	このコントロールのデータバインディングを含むコントロールを取得します。 (継承元 Control)
BorderColor	Web コントロールの境界線の色を取得または設定します。 (継承元 WebControl)
BorderStyle	Web サーバーコントロールの境界線スタイルを取得または設定します。 (継承元 WebControl)
BorderWidth	Web サーバーコントロールの境界線の幅を取得または設定します。 (継承元 WebControl)
ChildControlsCreated	サーバーコントロールの子コントロールが作成されているかどうかを示す値を取得します。 (継承元 Control)
ChromeState	パーツコントロールが最小化状態か通常状態かを取得または設定します。 (継承元 Part)
ChromeType	Web パーツコントロールに枠を設定する罫線の種類を取得または設定します。 (継承元 Part)
ClientID	ASP.NET によって生成される HTML マークアップのコントロール ID を取得します。 (継承元 Control)
ClientIDMode	ClientID プロパティの値を生成するために使用するアルゴリズムを取得または設定します。 (継承元 Control)
ClientIDSeparator	ClientID プロパティで使用される区切り文字を表す文字値を取得します。 (継承元 Control)
Context	現在の Web 要求のサーバーコントロールに関連付けられている HttpContext オブジェクトを取得します。 (継承元 Control)
Controls	ユーザーインターフェイス階層内の指定したサーバーコントロールの子コントロールを含む ControlCollection オブジェクトを取得します。 (継承元 Part)
ControlStyle	Web サーバーコントロールのスタイルを取得します。このプロパティは、主にコントロール開発者によって使用されます。 (継承元 WebControl)
ControlStyleCreated	Style プロパティに対してControlStyle オブジェクトが作成されたかどうかを示す値を取得します。このプロパティは、主にコントロール開発者によって使用されます。 (継承元 WebControl)
CssClass	クライアント上の Web サーバーコントロールによってレンダリングされるカスケードスタイルシート (CSS) クラスを取得または設定します。 (継承元 WebControl)
DataItemContainer	名前付けコンテナーが IDataItemContainerを実装する場合は、名前付けコンテナーへの参照を取得します。 (継承元 Control)
DataKeysContainer	名前付けコンテナーが IDataKeysControlを実装する場合は、名前付けコンテナーへの参照を取得します。 (継承元 Control)
DefaultButton	Panel コントロールに含まれる既定のボタンの識別子を取得または設定します。 (継承元 Panel)
Description	パーツコントロールのツールヒントとカタログで使用するために、パーツコントロールの動作を要約する簡単な語句を取得または設定します。 (継承元 Part)
DesignMode	コントロールがデザインサーフェイスで使用されているかどうかを示す値を取得します。 (継承元 Control)
Direction	Panel コントロールにテキストを含むコントロールを表示する方向を取得または設定します。 (継承元 Panel)
Display	関連付けられている WebPart コントロールが編集モードのときにコントロールを表示するかどうかを示す値を取得します。
DisplayTitle	EditorPart コントロールのタイトルバーに表示されるタイトルテキストを含む文字列を取得します。
Enabled	Web サーバーコントロールが有効かどうかを示す値を取得または設定します。 (継承元 WebControl)
EnableTheming	テーマがこのコントロールに適用されるかどうかを示す値を取得または設定します。 (継承元 WebControl)
EnableViewState	サーバーコントロールがそのビューステートを保持するかどうか、およびそれに含まれる子コントロールのビューステートを要求側クライアントに保持するかどうかを示す値を取得または設定します。 (継承元 Control)
Events	コントロールのイベントハンドラーデリゲートの一覧を取得します。このプロパティは読み取り専用です。 (継承元 Control)
Font	Web サーバーコントロールに関連付けられているフォントプロパティを取得します。 (継承元 WebControl)
ForeColor	Web サーバーコントロールの前景色 (通常はテキストの色) を取得または設定します。 (継承元 WebControl)
GroupingText	パネルコントロールに含まれるコントロールのグループのキャプションを取得または設定します。 (継承元 Panel)
HasAttributes	コントロールに属性が設定されているかどうかを示す値を取得します。 (継承元 WebControl)
HasChildViewState	現在のサーバーコントロールの子コントロールに保存されたビューステート設定があるかどうかを示す値を取得します。 (継承元 Control)
Height	Web サーバーコントロールの高さを取得または設定します。 (継承元 WebControl)
HorizontalAlign	パネル内のコンテンツの水平方向の配置を取得または設定します。 (継承元 Panel)
ID	サーバーコントロールに割り当てられたプログラム識別子を取得または設定します。 (継承元 Control)
IdSeparator	コントロール識別子を分離するために使用する文字を取得します。 (継承元 Control)
IsChildControlStateCleared	このコントロール内に含まれるコントロールがコントロールの状態を持っているかどうかを示す値を取得します。 (継承元 Control)
IsEnabled	コントロールが有効かどうかを示す値を取得します。 (継承元 WebControl)
IsTrackingViewState	サーバーコントロールがビューステートへの変更を保存するかどうかを示す値を取得します。 (継承元 Control)
IsViewStateEnabled	このコントロールに対してビューステートが有効かどうかを示す値を取得します。 (継承元 Control)
LoadViewStateByID	インデックスの代わりに ID して、コントロールがビューステートの読み込みに関与するかどうかを示す値を取得します。 (継承元 Control)
NamingContainer	同じ ID プロパティ値を持つサーバーコントロール間で区別するための一意の名前空間を作成する、サーバーコントロールの名前付けコンテナーへの参照を取得します。 (継承元 Control)
Page	サーバーコントロールを含む Page インスタンスへの参照を取得します。 (継承元 Control)
Parent	ページコントロール階層内のサーバーコントロールの親コントロールへの参照を取得します。 (継承元 Control)
RenderingCompatibility	レンダリングされた HTML と互換性のある ASP.NET バージョンを指定する値を取得します。 (継承元 Control)
ScrollBars	Panel コントロール内のスクロールバーの表示/非表示と位置を取得または設定します。 (継承元 Panel)
Site	デザインサーフェイスにレンダリングされるときに、現在のコントロールをホストするコンテナーに関する情報を取得します。 (継承元 Control)
SkinID	コントロールに適用するスキンを取得または設定します。 (継承元 WebControl)
Style	Web サーバーコントロールの外部タグのスタイル属性としてレンダリングされるテキスト属性のコレクションを取得します。 (継承元 WebControl)
SupportsDisabledAttribute	コントロールの`disabled` プロパティがIsEnabledされたときに、レンダリングされた HTML 要素の`false`属性を "無効" に設定する必要があるかどうかを示す値を取得します。 (継承元 Panel)
TabIndex	Web サーバーコントロールのタブインデックスを取得または設定します。 (継承元 WebControl)
TagKey	この Web サーバーコントロールに対応する HtmlTextWriterTag 値を取得します。このプロパティは、主にコントロール開発者によって使用されます。 (継承元 WebControl)
TagName	コントロールタグの名前を取得します。このプロパティは、主にコントロール開発者によって使用されます。 (継承元 WebControl)
TemplateControl	このコントロールを含むテンプレートへの参照を取得または設定します。 (継承元 Control)
TemplateSourceDirectory	現在のサーバーコントロールを含む Page または UserControl の仮想ディレクトリを取得します。 (継承元 Control)
Title	パーツコントロールのタイトルを取得または設定します。 (継承元 Part)
ToolTip	マウスポインターが Web サーバーコントロールの上に置いたときに表示されるテキストを取得または設定します。 (継承元 WebControl)
UniqueID	サーバーコントロールの階層的に修飾された一意の識別子を取得します。 (継承元 Control)
ValidateRequestMode	コントロールがブラウザーからのクライアント入力で潜在的に危険な値をチェックするかどうかを示す値を取得または設定します。 (継承元 Control)
ViewState	同じページに対する複数の要求にわたってサーバーコントロールのビューステートを保存および復元できる状態情報のディクショナリを取得します。 (継承元 Control)
ViewStateIgnoresCase	StateBag オブジェクトで大文字と小文字が区別されないかどうかを示す値を取得します。 (継承元 Control)
ViewStateMode	このコントロールのビューステートモードを取得または設定します。 (継承元 Control)
Visible	サーバーコントロールがページ上の UI としてレンダリングされるかどうかを示す値を取得または設定します。 (継承元 Control)
WebPartManager	現在の Web ページに関連付けられている WebPartManager コントロールへの参照を取得します。
WebPartToEdit	現在編集中の WebPart コントロールへの参照を取得します。
Width	Web サーバーコントロールの幅を取得または設定します。 (継承元 WebControl)
Wrap	コンテンツがパネル内でラップされるかどうかを示す値を取得または設定します。 (継承元 Panel)
Zone	EditorZoneBase コントロールを含むEditorPart ゾーンへの参照を取得します。

メソッド

名前	説明
AddAttributesToRender(HtmlTextWriter)	背景イメージ、配置、ラップ、および方向に関する情報を、レンダリングする属性の一覧に追加します。 (継承元 Panel)
AddedControl(Control, Int32)	子コントロールがControls オブジェクトのControl コレクションに追加された後に呼び出されます。 (継承元 Control)
AddParsedSubObject(Object)	XML または HTML のいずれかの要素が解析されたことをサーバーコントロールに通知し、その要素をサーバーコントロールの ControlCollection オブジェクトに追加します。 (継承元 Control)
ApplyChanges()	EditorPart コントロール内の値を、関連付けられているWebPart コントロール内の対応するプロパティに保存します。
ApplyStyle(Style)	指定したスタイルの空白以外の要素を Web コントロールにコピーし、コントロールの既存のスタイル要素を上書きします。このメソッドは、主にコントロール開発者によって使用されます。 (継承元 WebControl)
ApplyStyleSheetSkin(Page)	ページスタイルシートで定義されているスタイルプロパティをコントロールに適用します。 (継承元 Control)
BeginRenderTracing(TextWriter, Object)	レンダリングデータのデザイン時トレースを開始します。 (継承元 Control)
BuildProfileTree(String, Boolean)	サーバーコントロールに関する情報を収集し、ページのトレースが有効になっているときに表示される Trace プロパティに渡します。 (継承元 Control)
ClearCachedClientID()	キャッシュされた ClientID 値を `null`に設定します。 (継承元 Control)
ClearChildControlState()	サーバーコントロールの子コントロールのコントロール状態情報を削除します。 (継承元 Control)
ClearChildState()	すべてのサーバーコントロールの子コントロールのビューステート情報とコントロール状態情報を削除します。 (継承元 Control)
ClearChildViewState()	すべてのサーバーコントロールの子コントロールのビューステート情報を削除します。 (継承元 Control)
ClearEffectiveClientIDMode()	現在のコントロールインスタンスと子コントロールの ClientIDMode プロパティを Inheritに設定します。 (継承元 Control)
CopyBaseAttributes(WebControl)	Style オブジェクトによってカプセル化されていないプロパティを、指定した Web サーバーコントロールから、このメソッドが呼び出される Web サーバーコントロールにコピーします。このメソッドは、主にコントロール開発者によって使用されます。 (継承元 WebControl)
CreateChildControls()	ASP.NET ページフレームワークによって呼び出され、コンポジションベースの実装を使用して、ポストバックまたはレンダリングの準備として含まれる子コントロールを作成するサーバーコントロールに通知します。 (継承元 Control)
CreateControlCollection()	サーバーコントロールの子コントロール (リテラルとサーバーの両方) を保持する新しい ControlCollection オブジェクトを作成します。 (継承元 Control)
CreateControlStyle()	すべてのスタイル関連プロパティを実装するために、 Panel コントロールによって内部的に使用されるスタイルオブジェクトを作成します。 (継承元 Panel)
DataBind()	呼び出されたサーバーコントロールとそのすべての子コントロールにデータソースをバインドします。 (継承元 Part)
DataBind(Boolean)	DataBinding イベントを発生させるオプションを使用して、呼び出されたサーバーコントロールとそのすべての子コントロールにデータソースをバインドします。 (継承元 Control)
DataBindChildren()	データソースをサーバーコントロールの子コントロールにバインドします。 (継承元 Control)
Dispose()	サーバーコントロールがメモリから解放される前に、最終的なクリーンアップを実行できるようにします。 (継承元 Control)
EndRenderTracing(TextWriter, Object)	レンダリングデータのデザイン時トレースを終了します。 (継承元 Control)
EnsureChildControls()	サーバーコントロールに子コントロールが含まれているかどうかを判断します。そうでない場合は、子コントロールが作成されます。 (継承元 Control)
EnsureID()	識別子が割り当てられないコントロールの識別子を作成します。 (継承元 Control)
Equals(Object)	指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
FindControl(String, Int32)	`id` パラメーターで指定された、指定した`pathOffset`と整数を持つサーバーコントロールの現在の名前付けコンテナーを検索します。これは、検索に役立ちます。このバージョンの FindControl メソッドはオーバーライドしないでください。 (継承元 Control)
FindControl(String)	指定した `id` パラメーターを使用して、サーバーコントロールの現在の名前付けコンテナーを検索します。 (継承元 Control)
Focus()	入力フォーカスをコントロールに設定します。 (継承元 Control)
GetDesignModeState()	EditorPart コントロールの親ゾーンの現在の状態を取得します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetRouteUrl(Object)	ルートパラメーターのセットに対応する URL を取得します。 (継承元 Control)
GetRouteUrl(RouteValueDictionary)	ルートパラメーターのセットに対応する URL を取得します。 (継承元 Control)
GetRouteUrl(String, Object)	ルートパラメーターとルート名のセットに対応する URL を取得します。 (継承元 Control)
GetRouteUrl(String, RouteValueDictionary)	ルートパラメーターとルート名のセットに対応する URL を取得します。 (継承元 Control)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
GetUniqueIDRelativeTo(Control)	指定したコントロールの UniqueID プロパティのプレフィックス部分を返します。 (継承元 Control)
HasControls()	サーバーコントロールに子コントロールが含まれているかどうかを判断します。 (継承元 Control)
HasEvents()	コントロールまたは子コントロールのイベントが登録されているかどうかを示す値を返します。 (継承元 Control)
IsLiteralContent()	サーバーコントロールがリテラルコンテンツのみを保持するかどうかを決定します。 (継承元 Control)
LoadControlState(Object)	SaveControlState() メソッドによって保存された前のページ要求から制御状態情報を復元します。 (継承元 Control)
LoadViewState(Object)	SaveViewState() メソッドで保存された以前の要求からビューステート情報を復元します。 (継承元 WebControl)
MapPathSecure(String)	仮想パス (絶対パスまたは相対パス) がマップされる物理パスを取得します。 (継承元 Control)
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
MergeStyle(Style)	指定したスタイルの空白以外の要素を Web コントロールにコピーしますが、コントロールの既存のスタイル要素は上書きしません。このメソッドは、主にコントロール開発者によって使用されます。 (継承元 WebControl)
OnBubbleEvent(Object, EventArgs)	サーバーコントロールのイベントがページの UI サーバーコントロール階層に渡されるかどうかを判断します。 (継承元 Control)
OnDataBinding(EventArgs)	DataBinding イベントを発生させます。 (継承元 Control)
OnInit(EventArgs)	Init イベントを発生させます。 (継承元 Control)
OnLoad(EventArgs)	Load イベントを発生させます。 (継承元 Control)
OnPreRender(EventArgs)	PreRender イベントを発生させます。
OnUnload(EventArgs)	Unload イベントを発生させます。 (継承元 Control)
OpenFile(String)	ファイルの読み取りに使用する Stream を取得します。 (継承元 Control)
RaiseBubbleEvent(Object, EventArgs)	イベントのソースとその情報をコントロールの親に割り当てます。 (継承元 Control)
RemovedControl(Control)	Controls オブジェクトのControl コレクションから子コントロールが削除された後に呼び出されます。 (継承元 Control)
Render(HtmlTextWriter)	指定した HTML ライターにコントロールをレンダリングします。 (継承元 WebControl)
RenderBeginTag(HtmlTextWriter)	Panel コントロールの HTML 開始タグを指定したライターにレンダリングします。 (継承元 Panel)
RenderChildren(HtmlTextWriter)	指定した HtmlTextWriter オブジェクトにサーバーコントロールの子のコンテンツを出力します。このオブジェクトは、クライアントにレンダリングされるコンテンツを書き込みます。 (継承元 Control)
RenderContents(HtmlTextWriter)	コントロールの内容を指定したライターにレンダリングします。このメソッドは、主にコントロール開発者によって使用されます。 (継承元 WebControl)
RenderControl(HtmlTextWriter, ControlAdapter)	指定されたHtmlTextWriter オブジェクトを使用して、指定されたControlAdapter オブジェクトにサーバーコントロールのコンテンツを出力します。 (継承元 Control)
RenderControl(HtmlTextWriter)	指定された HtmlTextWriter オブジェクトにサーバーコントロールの内容を出力し、トレースが有効になっている場合は、コントロールに関するトレース情報を格納します。 (継承元 Control)
RenderEndTag(HtmlTextWriter)	Panel コントロールの HTML 終了タグを指定されたライターにレンダリングします。 (継承元 Panel)
ResolveAdapter()	指定したコントロールのレンダリングを担当するコントロールアダプターを取得します。 (継承元 Control)
ResolveClientUrl(String)	ブラウザーで使用できる URL を取得します。 (継承元 Control)
ResolveUrl(String)	URL を、要求側クライアントで使用できる URL に変換します。 (継承元 Control)
SaveControlState()	ページがサーバーにポストバックされた時刻以降に発生したすべてのサーバー制御状態の変更を保存します。 (継承元 Control)
SaveViewState()	TrackViewState() メソッドが呼び出された後に変更されたすべての状態を保存します。 (継承元 WebControl)
SetDesignModeState(IDictionary)	デザインモード状態の特性を、EditorZoneBase コントロールを含む現在のEditorPart ゾーンに適用します。
SetRenderMethodDelegate(RenderMethod)	サーバーコントロールとそのコンテンツを親コントロールにレンダリングするイベントハンドラーデリゲートを割り当てます。 (継承元 Control)
SetTraceData(Object, Object, Object)	トレースオブジェクト、トレースデータキー、およびトレースデータ値を使用して、レンダリングデータのデザイン時トレース用のトレースデータを設定します。 (継承元 Control)
SetTraceData(Object, Object)	トレースデータキーとトレースデータ値を使用して、レンダリングデータのデザイン時トレース用のトレースデータを設定します。 (継承元 Control)
SyncChanges()	関連付けられているWebPart コントロールのEditorPart コントロールからプロパティ値を取得します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
TrackViewState()	コントロールがビューステートの変更を追跡し、オブジェクトの ViewState プロパティに格納できるようにします。 (継承元 WebControl)

イベント

名前	説明
DataBinding	サーバーコントロールがデータソースにバインドされるときに発生します。 (継承元 Control)
Disposed	サーバーコントロールがメモリから解放されたときに発生します。これは、ASP.NET ページが要求されたときに、サーバーコントロールライフサイクルの最後のステージです。 (継承元 Control)
Init	サーバーコントロールが初期化されるときに発生します。これは、そのライフサイクルの最初のステップです。 (継承元 Control)
Load	サーバーコントロールが Page オブジェクトに読み込まれるときに発生します。 (継承元 Control)
PreRender	Control オブジェクトが読み込まれた後、レンダリングの前に発生します。 (継承元 Control)
Unload	サーバーコントロールがメモリからアンロードされるときに発生します。 (継承元 Control)

明示的なインターフェイスの実装

名前	説明
IAttributeAccessor.GetAttribute(String)	指定した名前の Web コントロールの属性を取得します。 (継承元 WebControl)
IAttributeAccessor.SetAttribute(String, String)	Web コントロールの属性を指定した名前と値に設定します。 (継承元 WebControl)
ICompositeControlDesignerAccessor.RecreateChildControls()	複合パーツコントロールのデザイナーの開発者が、デザインサーフェイスでコントロールの子コントロールを再作成できるようにします。 (継承元 Part)
IControlBuilderAccessor.ControlBuilder	このメンバーの説明については、 ControlBuilderを参照してください。 (継承元 Control)
IControlDesignerAccessor.GetDesignModeState()	このメンバーの説明については、 GetDesignModeState()を参照してください。 (継承元 Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)	このメンバーの説明については、 SetDesignModeState(IDictionary)を参照してください。 (継承元 Control)
IControlDesignerAccessor.SetOwnerControl(Control)	このメンバーの説明については、 SetOwnerControl(Control)を参照してください。 (継承元 Control)
IControlDesignerAccessor.UserData	このメンバーの説明については、 UserDataを参照してください。 (継承元 Control)
IDataBindingsAccessor.DataBindings	このメンバーの説明については、 DataBindingsを参照してください。 (継承元 Control)
IDataBindingsAccessor.HasDataBindings	このメンバーの説明については、 HasDataBindingsを参照してください。 (継承元 Control)
IExpressionsAccessor.Expressions	このメンバーの説明については、 Expressionsを参照してください。 (継承元 Control)
IExpressionsAccessor.HasExpressions	このメンバーの説明については、 HasExpressionsを参照してください。 (継承元 Control)
IParserAccessor.AddParsedSubObject(Object)	このメンバーの説明については、 AddParsedSubObject(Object)を参照してください。 (継承元 Control)

拡張メソッド

名前	説明
EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>)	指定したデータコントロールの動的データ動作を有効にします。
EnableDynamicData(INamingContainer, Type, Object)	指定したデータコントロールの動的データ動作を有効にします。
EnableDynamicData(INamingContainer, Type)	指定したデータコントロールの動的データ動作を有効にします。
FindDataSourceControl(Control)	指定したコントロールのデータコントロールに関連付けられているデータソースを返します。
FindFieldTemplate(Control, String)	指定したコントロールの名前付けコンテナー内の指定した列のフィールドテンプレートを返します。
FindMetaTable(Control)	格納されているデータコントロールのメタテーブルオブジェクトを返します。
GetDefaultValues(INamingContainer)	指定したデータコントロールの既定値のコレクションを取得します。
GetMetaTable(INamingContainer)	指定したデータコントロールのテーブルメタデータを取得します。
SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>)	指定したデータコントロールのテーブルメタデータと既定値のマッピングを設定します。
SetMetaTable(INamingContainer, MetaTable, Object)	指定したデータコントロールのテーブルメタデータと既定値のマッピングを設定します。
SetMetaTable(INamingContainer, MetaTable)	指定したデータコントロールのテーブルメタデータを設定します。
TryGetMetaTable(INamingContainer, MetaTable)	テーブルメタデータを使用できるかどうかを判断します。

適用対象

こちらもご覧ください

フィードバック

このページはお役に立ちましたか?