Export (0) Print
Expand All

XhtmlTextWriter.OnStyleAttributeRender Method

Determines whether the specified XHTML style attribute and its value can be rendered to the current markup element.

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

protected override bool OnStyleAttributeRender (
	string name,
	string value,
	HtmlTextWriterStyle key
)
protected boolean OnStyleAttributeRender (
	String name, 
	String value, 
	HtmlTextWriterStyle key
)
protected override function OnStyleAttributeRender (
	name : String, 
	value : String, 
	key : HtmlTextWriterStyle
) : boolean
Not applicable.

Parameters

name

The XHTML style attribute to render.

value

The value assigned to the XHTML style attribute.

key

The HtmlTextWriterStyle enumeration value associated with the XHTML style attribute.

Return Value

true if the style attribute is rendered; otherwise, false.

The following code example demonstrates how to override the OnStyleAttributeRender method to check whether a Color attribute is being rendered for any of the elements that are rendered by this text writer. If a Color attribute is rendered, the code checks whether its value is purple. If the value is purple, the OnStyleAttributeRender method returns false and the attribute and its value are not rendered. If the Color attribute is set to any other value, the OnStyleAttributeRender method returns true and the attribute and its value are rendered. If the key parameter of the OnAttributeRender method does not match the Color attribute, the base functionality of the OnStyleAttributeRender method is called, as defined in the XhtmlTextWriter class.

This code example is part of a larger example provided for the XhtmlTextWriter class.

// Override the OnStyleAttributeRender
// method to prevent this text writer 
// from rendering purple text.
protected override bool OnStyleAttributeRender(string name, 
    string value, 
    HtmlTextWriterStyle key)
{
    if (key == HtmlTextWriterStyle.Color)
    {
        if (String.Compare(value, "purple") == 0)
        {
            return false;
        }
        else
        {
            return true;
        }
    }
    else
    {
        return base.OnStyleAttributeRender(name, value, key);
    }        
}  

// Override the OnStyleAttributeRender
// method to prevent this text writer 
// from rendering purple text.
protected boolean OnStyleAttributeRender(String name, String value, 
    HtmlTextWriterStyle key)
{
    if (key.Equals(HtmlTextWriterStyle.Color)) {
        if (String.Compare(value, "purple") == 0) {
            return false;
        }
        else {
            return true;
        }
    }
    else {
        return super.OnStyleAttributeRender(name, value, key);
    }
} //OnStyleAttributeRender

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft