HtmlTextWriter.OnAttributeRender-Methode

Artikel
08/20/2007

Bestimmt, ob das angegebene Markupattribut und sein Wert im aktuellen Markupelement gerendert werden können.

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

Syntax

'Declaration
Protected Overridable Function OnAttributeRender ( _
    name As String, _
    value As String, _
    key As HtmlTextWriterAttribute _
) As Boolean
'Usage
Dim name As String
Dim value As String
Dim key As HtmlTextWriterAttribute
Dim returnValue As Boolean

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

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

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

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

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

Parameter

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

value
Eine Zeichenfolge mit dem Wert, der dem Attribut zugewiesen wird.

key
Das dem Markupattribut zugeordnete HtmlTextWriterAttribute.

Rückgabewert

Immer true.

Hinweise

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

Hinweise für Erben Wenn Sie die HtmlTextWriter-Klasse vererben, können Sie die OnAttributeRender-Methode überschreiben, damit false zurückgegeben wird. Damit können Sie das Rendern eines Attributs vollständig verhindern oder verhindern, dass es in einem bestimmten Element oder für ein bestimmtes Markup gerendert wird. Damit z. B. das von HtmlTextWriter abgeleitete Objekt nicht das bgcolor-Attribut in <table>-Elementen rendert, können Sie OnAttributeRender überschreiben, sodass false zurückgegeben wird, wenn name bgcolor übergibt und der TagName-Eigenschaftenwert table ist.

Beispiel

Im folgenden Codebeispiel wird das Überschreiben der OnAttributeRender-Methode veranschaulicht. Wenn ein Size-Attribut gerendert wird, der Size-Wert aber nicht 30pt ist, ruft die OnAttributeRender-Überschreibung die AddAttribute-Methode auf, um ein Size-Attribut hinzuzufügen und seinen Wert auf 30pt festzulegen.

' If a size attribute is to be rendered, compare its value to 30 point.
' If it is not set to 30 point, add the attribute and set the value to 30
' then return false.
Protected Overrides Function OnAttributeRender(name As String, _
    value As String, _
    key As HtmlTextWriterAttribute) _
As Boolean

    If key = HtmlTextWriterAttribute.Size Then
        If [String].Compare(value, "30pt") <> 0 Then
            AddAttribute("size", "30pt")
            Return False
        End If
    End If

    ' If the attribute is not a size attribute, use
    ' the base functionality of the OnAttributeRender method.
    Return MyBase.OnAttributeRender(name, value, key)
End Function 'OnAttributeRender

// If a size attribute is to be rendered, compare its value to 30 point.
// If it is not set to 30 point, add the attribute and set the value to 30,
// then return false.
protected override bool OnAttributeRender(string name,
    string value,
    HtmlTextWriterAttribute key)
{

    if (key == HtmlTextWriterAttribute.Size)
    {
        if (string.Compare(value, "30pt") != 0)
        {
            AddAttribute("size", "30pt");
            return false;
        }
    }

    // If the attribute is not a size attribute, use
    // the base functionality of the OnAttributeRender method.
    return base.OnAttributeRender(name, value, 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
HtmlTextWriterAttribute

Freigeben über