Share via

ChtmlTextWriter.OnAttributeRender メソッド

  • リファレンス

定義

名前空間:
System.Web.UI
アセンブリ:
System.Web.dll

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

protected:
 override bool OnAttributeRender(System::String ^ name, System::String ^ value, System::Web::UI::HtmlTextWriterAttribute key);
protected override bool OnAttributeRender (string name, string value, System.Web.UI.HtmlTextWriterAttribute key);
override this.OnAttributeRender : string * string * System.Web.UI.HtmlTextWriterAttribute -> bool
Protected Overrides Function OnAttributeRender (name As String, value As String, key As HtmlTextWriterAttribute) As Boolean

パラメーター

name
String

表示する cHTML 属性。

value
String

name に代入する値。

key
HtmlTextWriterAttribute

HtmlTextWriterAttribute に関連付けられている name。

戻り値

Boolean

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

例

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

このコード例は、ChtmlTextWriter クラスのために提供されている大規模な例の一部です。

// 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);
}

' 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

注釈

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

適用対象

こちらもご覧ください