ChtmlTextWriter.OnAttributeRender メソッド

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

ChtmlTextWriter.OnAttributeRender メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定した cHTML 属性とその値を要求側のページに表示するかどうかを決定します。ChtmlTextWriter クラスの派生クラスで、cHTML 対応デバイスに表示しない属性を除外するように OnAttributeRender メソッドをオーバーライドできます。

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

Visual Basic (宣言)

Protected Overrides Function
 OnAttributeRender ( _
    name As String, _
    value As String, _
    key As HtmlTextWriterAttribute _
) As Boolean

Visual Basic (使用法)

Dim name As String
Dim value As String
Dim key As HtmlTextWriterAttribute
Dim returnValue As Boolean

returnValue = Me.OnAttributeRender(name, value, key)

C#

protected override bool OnAttributeRender (
    string name,
    string value,
    HtmlTextWriterAttribute key
)

C++

protected:
virtual bool OnAttributeRender (
    String^ name, 
    String^ value, 
    HtmlTextWriterAttribute key
) override

J#

protected boolean OnAttributeRender (
    String name, 
    String value, 
    HtmlTextWriterAttribute key
)

JScript

protected override function OnAttributeRender
 (
    name : String, 
    value : String, 
    key : HtmlTextWriterAttribute
) : boolean

パラメータ

name

表示する cHTML 属性。

value

name に代入する値。

key

name に関連付けられた HtmlTextWriterAttribute。

戻り値
ChtmlTextWriter 出力ストリームにその属性と値を書き込む場合は true。それ以外の場合は false。

解説

既定では、OnAttributeRender メソッドは、GlobalSuppressedAttributes プロパティのリストに含まれているグローバル非表示属性と、SuppressedAttributes プロパティのリストに含まれている要素固有非表示属性を出力ストリームに書き込まないようにします。ChtmlTextWriter クラスの派生クラスで OnAttributeRender メソッドの動作をオーバーライドできます。

使用例

bgcolor 属性を cHTML 出力ストリームに書き込まないように OnAttributeRender メソッドをオーバーライドするカスタム クラスの使用方法を次のコード例に示します。次に、基本 OnAttributeRender メソッドによって提供される機能も ChtmlTextWriter クラスから呼び出し、その既定の動作が使用されるようにします。

このコード例は、ChtmlTextWriter クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

' Override the OnAttributeRender method to
' not render the bgcolor attribute, which is 
' not supported in CHTML.
Protected Overrides Function
 OnAttributeRender(ByVal name As String,
 ByVal value As String, ByVal key As HtmlTextWriterAttribute) As
 Boolean
    If (String.Equals("bgcolor",
 name)) Then
        Return False
    End If

    ' Call the ChtmlTextWriter version of 
    ' the OnAttributeRender method.
    MyBase.OnAttributeRender(name, value, key)

End Function

C#

// Override the OnAttributeRender method to
// not render the bgcolor attribute, which is
// not supported in CHTML.
protected override bool OnAttributeRender(string
 name, string value, HtmlTextWriterAttribute key)
{
    if (String.Equals("bgcolor", name))
    {
        return false;
    }
    
    // Call the ChtmlTextWriter version of the
    // the OnAttributeRender method.
    return base.OnAttributeRender(name, value,
 key);
}

プラットフォーム

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

参照

関連項目
ChtmlTextWriter クラス
ChtmlTextWriter メンバ
System.Web.UI 名前空間
OnStyleAttributeRender