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

こちらもご覧ください

• TextWriter
• HtmlTextWriterTag