HtmlTextWriter.OnStyleAttributeRender-Methode

Artikel
08/20/2007

Bestimmt, ob das angegebene Markupformatattribut 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 OnStyleAttributeRender ( _
    name As String, _
    value As String, _
    key As HtmlTextWriterStyle _
) As Boolean
'Usage
Dim name As String
Dim value As String
Dim key As HtmlTextWriterStyle
Dim returnValue As Boolean

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

protected virtual bool OnStyleAttributeRender (
    string name,
    string value,
    HtmlTextWriterStyle key
)

protected:
virtual bool OnStyleAttributeRender (
    String^ name, 
    String^ value, 
    HtmlTextWriterStyle key
)

protected boolean OnStyleAttributeRender (
    String name, 
    String value, 
    HtmlTextWriterStyle key
)

protected function OnStyleAttributeRender (
    name : String, 
    value : String, 
    key : HtmlTextWriterStyle
) : boolean

Parameter

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

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

key
Das dem Formatattribut zugeordnete HtmlTextWriterStyle.

Rückgabewert

Immer true.

Hinweise

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

Hinweise für Erben Wenn Sie die HtmlTextWriter-Klasse vererben, können Sie die OnStyleAttributeRender-Methode überschreiben, damit false zurückgegeben wird. Damit können Sie das Rendern eines Formatattributs vollständig verhindern oder verhindern, dass es in einem bestimmten Element oder für eine bestimmte Markupsprache gerendert wird. Damit z. B. das von HtmlTextWriter abgeleitete Objekt nicht das color-Formatattribut in einem <p>-Element rendert, können Sie OnStyleAttributeRender überschreiben, sodass false zurückgegeben wird, wenn name color übergibt und der TagName-Eigenschaftenwert p ist.

Beispiel

Im folgenden Codebeispiel wird das Überschreiben der OnStyleAttributeRender-Methode veranschaulicht. Wenn ein Color-Formatattribut gerendert wird, der Color-Wert aber nicht purple ist, legt die OnStyleAttributeRender-Überschreibung das Color-Attribut mithilfe der AddStyleAttribute-Methode auf purple fest.

' If a color style attribute is to be rendered,
' compare its value to purple. If it is not set to
' purple, add the style attribute and set the value
' to purple, then return false.
Protected Overrides Function OnStyleAttributeRender(name As String, _
    value As String, _
    key As HtmlTextWriterStyle) _
As Boolean

    If key = HtmlTextWriterStyle.Color Then
        If [String].Compare(value, "purple") <> 0 Then
            AddStyleAttribute("color", "purple")
            Return False
        End If
    End If

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

// If a color style attribute is to be rendered,
// compare its value to purple. If it is not set to
// purple, add the style attribute and set the value
// to purple, then return false.
protected override bool OnStyleAttributeRender(string name,
    string value,
    HtmlTextWriterStyle key)
{

    if (key == HtmlTextWriterStyle.Color)
    {
        if (string.Compare(value, "purple") != 0)
        {
            AddStyleAttribute("color", "purple");
            return false;
        }
    }

    // If the style attribute is not a color attribute,
    // use the base functionality of the
    // OnStyleAttributeRender method.
    return base.OnStyleAttributeRender(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
HtmlTextWriterStyle

Freigeben über