HtmlTextWriter.OnTagRender-Methode

Artikel
08/20/2007

Bestimmt, ob das angegebene Markupelement auf der anfordernden Seite gerendert wird.

Namespace: System.Web.UI
Assembly: System.Web (in system.web.dll)

Syntax

'Declaration
Protected Overridable Function OnTagRender ( _
    name As String, _
    key As HtmlTextWriterTag _
) As Boolean
'Usage
Dim name As String
Dim key As HtmlTextWriterTag
Dim returnValue As Boolean

returnValue = Me.OnTagRender(name, key)

protected virtual bool OnTagRender (
    string name,
    HtmlTextWriterTag key
)

protected:
virtual bool OnTagRender (
    String^ name, 
    HtmlTextWriterTag key
)

protected boolean OnTagRender (
    String name, 
    HtmlTextWriterTag key
)

protected function OnTagRender (
    name : String, 
    key : HtmlTextWriterTag
) : boolean

Parameter

name
Eine Zeichenfolge mit dem Namen des Elements, das gerendert werden soll.

key
Der dem Element zugeordnete HtmlTextWriterTag.

Rückgabewert

Immer true.

Hinweise

Die HtmlTextWriter-Klassenimplementierung der OnTagRender-Methode gibt immer true zurück. Die OnTagRender-Überschreibungen können bestimmen, ob ein Element auf der Seite gerendert wird.

Hinweise für Erben Wenn Sie die HtmlTextWriter-Klasse vererben, können Sie die OnTagRender-Methode überschreiben, damit false zurückgegeben wird. So können Sie verhindern, dass ein Markupelement überhaupt oder für eine bestimmte Markupsprache gerendert wird. Wenn z. B. das von HtmlTextWriter abgeleitete Objekt das <font>-Element nicht rendern soll, können Sie die OnTagRender-Methode überschreiben, sodass diese false zurückgibt, wenn eine Seite mit einem <font>-Element angefordert wird.

Beispiel

Im folgenden Codebeispiel wird das Überschreiben der OnTagRender-Methode veranschaulicht. Wenn ein Font-Element gerendert wird, bestimmt die OnTagRender-Überschreibung mithilfe der IsAttributeDefined-Methode, ob ein Size-Attribut gerendert wird. Wenn dies nicht der Fall ist, erstellt sie mithilfe der AddAttribute-Methode ein Size-Attribut und legt deren Wert auf 20pt fest.

' 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

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

Plattformen

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 unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

Siehe auch

Referenz

HtmlTextWriter-Klasse
HtmlTextWriter-Member
System.Web.UI-Namespace
TextWriter
HtmlTextWriterTag

Freigeben über