HtmlTextWriter.OnTagRender(String, HtmlTextWriterTag) メソッド

定義

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

指定したマークアップ要素を要求ページにレンダリングするかどうかを決定します。

protected:
 virtual bool OnTagRender(System::String ^ name, System::Web::UI::HtmlTextWriterTag key);
protected virtual bool OnTagRender(string name, System.Web.UI.HtmlTextWriterTag key);
abstract member OnTagRender : string * System.Web.UI.HtmlTextWriterTag -> bool
override this.OnTagRender : string * System.Web.UI.HtmlTextWriterTag -> bool
Protected Overridable Function OnTagRender (name As String, key As HtmlTextWriterTag) As Boolean

パラメーター

name
String

レンダリングする要素の名前を含む文字列。

key
HtmlTextWriterTag

要素に関連付けられている HtmlTextWriterTag 。

返品

Boolean

常に true です。

例

次のコード例は、 OnTagRender メソッドをオーバーライドする方法を示しています。 Font要素がレンダリングされている場合、OnTagRenderオーバーライドでは、IsAttributeDefined メソッドを使用して、Size属性がレンダリングされているかどうかを判断します。 そうでない場合は、 AddAttribute メソッドを使用して Size 属性を作成し、その値を 20pt に設定します。

// If a <font> element is to be rendered, check whether it contains
// a size attribute. If it does not, add one and set its value to
// 20 points, then return true.
protected override bool OnTagRender(string name, HtmlTextWriterTag key)
{

    if (key == HtmlTextWriterTag.Font)
    {
        if (!(IsAttributeDefined(HtmlTextWriterAttribute.Size)))
        {
            AddAttribute(HtmlTextWriterAttribute.Size, "20pt");
            return true;
        }
    }

    // If the element is not a <font> element, use
    // the base functionality of the OnTagRenderMethod.
    return base.OnTagRender(name, key);
}

' If a <font> element is to be rendered, check whether it contains
' a size attribute. If it does not, add one and set its value to
' 20 points, then return true.
Protected Overrides Function OnTagRender( _
    name As String, _
    key As HtmlTextWriterTag) _
As Boolean

    If (key = HtmlTextWriterTag.Font) Then
        If Not (IsAttributeDefined(HtmlTextWriterAttribute.Size)) Then
            AddAttribute(HtmlTextWriterAttribute.Size, "20pt")
            Return True
        End If
    End If

    ' If the element is not a <font> element, use
    ' the base functionality of the OnTagRenderMethod.
    Return MyBase.OnTagRender(name, key)
End Function

注釈

OnTagRender メソッドのHtmlTextWriter クラスの実装では、常にtrueが返されます。 OnTagRenderオーバーライドは、要素がページにレンダリングされるかどうかを判断できます。

注意 (継承者)

HtmlTextWriter クラスから継承する場合は、OnTagRender(String, HtmlTextWriterTag) メソッドをオーバーライドしてfalseを返し、マークアップ要素が特定のマークアップ言語に対してまったくレンダリングされないようにすることができます。 たとえば、HtmlTextWriterから派生したオブジェクトに<font>要素をレンダリングしたくない場合は、<font>要素を含むページが要求されたときに、OnTagRender(String, HtmlTextWriterTag) メソッドをオーバーライドしてfalseを返すことができます。

適用対象

こちらもご覧ください