WebControl.AddAttributesToRender メソッド

.NET Framework クラス ライブラリ リファレンス

WebControl.AddAttributesToRender メソッド

指定した HtmlTextWriterTag に表示する必要のある HTML 属性およびスタイルを追加します。このメソッドは、主にコントロールの開発者によって使用されます。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Protected Overridable Sub
 AddAttributesToRender ( _
    writer As HtmlTextWriter _
)

Visual Basic (使用法)

Dim writer As HtmlTextWriter

Me.AddAttributesToRender(writer)

C#

protected virtual void AddAttributesToRender
 (
    HtmlTextWriter writer
)

C++

protected:
virtual void AddAttributesToRender (
    HtmlTextWriter^ writer
)

J#

protected void AddAttributesToRender (
    HtmlTextWriter writer
)

JScript

protected function AddAttributesToRender (
    writer : HtmlTextWriter
)

パラメータ

writer

HTML コンテンツをクライアントに表示する出力ストリームを表す HtmlTextWriter。

解説

Web サーバー コントロールの属性とスタイルをクライアントに表示するには、通常、AddAttribute メソッドと System.Web.UI.HtmlTextWriter.AddStyleAttribute メソッドを呼び出して、各属性とスタイルを HtmlTextWriter 出力ストリームに個別に挿入します。このメソッドは、プロセスを簡略化するために、Web サーバー コントロールに関連付けられたすべての属性とスタイルに対する System.Web.UI.HtmlTextWriter.AddAttribute メソッドと System.Web.UI.HtmlTextWriter.AddStyleAttribute メソッドへのすべての呼び出しをカプセル化します。すべての属性およびスタイルが、1 回のメソッドの呼び出しで HtmlTextWriter 出力ストリームに挿入されます。このメソッドは、通常、クラスの HtmlTextWriter 出力ストリームに適切な属性およびスタイルを挿入するために、コントロールの開発者によって派生クラスでオーバーライドされます。

メモ
AddAttributesToRender メソッドを使用してクライアント スクリプトを挿入することはできません。クライアント スクリプトを使用するには、ClientScriptManager クラスのトピックを参照してください。

使用例

WebControl クラスから派生したクラスを作成する方法の例を次に示します。AddAttributesToRender メソッドの基本実装は、HtmlTextWriter 出力ストリームの派生クラスに適切な属性を追加するためにオーバーライドされます。

Visual Basic

Imports System
Imports System.Web.UI
Imports System.Web.UI.WebControls

Namespace ControlTest
   
   ' Renders the following HTML: 
   ' <span onclick="alert('Hello');" style="color:Red;">Custom
 Contents</span>
   Public Class MyWebControl
      Inherits WebControl
      
      
      Public Sub New()
         MyBase.New(HtmlTextWriterTag.Span)
      End Sub 'New      
      
      <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand,
 Name:="FullTrust")> _
      Protected Overrides Sub
 AddAttributesToRender(writer As HtmlTextWriter)
         
         writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');")
         writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red")
         MyBase.AddAttributesToRender(writer)

      End Sub 'AddAttributesToRender
       

      <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand,
 Name:="FullTrust")> _
      Protected Overrides Sub
 RenderContents(writer As HtmlTextWriter)
         writer.Write("Custom Contents")
         MyBase.RenderContents(writer)
      End Sub 'RenderContents

   End Class 'MyWebControl

End Namespace 'ControlTest

C#

namespace ControlTest 
{
   using System;
   using System.Web.UI;
   using System.Web.UI.WebControls;

   // Renders the following HTML: 
   // <span onclick="alert('Hello');" style="color:Red;">Custom
 Contents</span>

   public class MyWebControl: WebControl {

      public MyWebControl() : base(HtmlTextWriterTag.Span)
 
      { }

      [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand,
 Name="FullTrust")] 
      protected override void AddAttributesToRender(HtmlTextWriter
 writer) 
      {

         writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');");
         writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red");
         base.AddAttributesToRender(writer);

      }

      [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand,
 Name="FullTrust")] 
      protected override void RenderContents(HtmlTextWriter
 writer) 
      {
         writer.Write("Custom Contents");
         base.RenderContents(writer);
      }
   }
}

J#

package ControlTest; 
import System.*;
import System.Web.UI.*;
import System.Web.UI.WebControls.*;

// Renders the following HTML: 
// <span onclick="alert('Hello');" style="color:Red;">Custom
 Contents</span>
public class MyWebControl extends WebControl
{
    public MyWebControl()
    {
         super(HtmlTextWriterTag.Span);
    } //MyWebControl

    protected void AddAttributesToRender(HtmlTextWriter
 writer)
    {
        writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');");
        writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red");
        super.AddAttributesToRender(writer);
    } //AddAttributesToRender

    /** @attribute System.Security.Permissions.PermissionSet(System.Security.
        Permissions.SecurityAction.Demand, Name = "FullTrust")
     */
    protected void RenderContents(HtmlTextWriter
 writer)
    {
        writer.Write("Custom Contents");
        super.RenderContents(writer);
    } //RenderContents
} //MyWebControl

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
WebControl クラス
WebControl メンバ
System.Web.UI.WebControls 名前空間
System.Web.UI.HtmlTextWriter.AddAttribute
System.Web.UI.HtmlTextWriter.AddStyleAttribute
HtmlTextWriter
その他の技術情報
Web サーバー コントロール構文
ASP.NET カスタム サーバー コントロールの開発