Export (0) Print
Expand All

HtmlTextWriter.GetAttributeKey Method

Obtains the corresponding HtmlTextWriterAttribute enumeration value for the specified attribute.

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

protected HtmlTextWriterAttribute GetAttributeKey (
	string attrName
)
protected HtmlTextWriterAttribute GetAttributeKey (
	String attrName
)
protected function GetAttributeKey (
	attrName : String
) : HtmlTextWriterAttribute
Not applicable.

Parameters

attrName

A string that contains the attribute for which to obtain the HtmlTextWriterAttribute.

Return Value

The HtmlTextWriterAttribute enumeration value for the specified attribute; otherwise, an invalid HtmlTextWriterAttribute value if the attribute is not a member of the enumeration.

If attrName is a null reference (Nothing in Visual Basic) or an empty string (""), or cannot be found in the table of attribute names, the value -1, typed to an HtmlTextWriterAttribute object, is returned.

The following code example demonstrates how to use a class, derived from the HtmlTextWriter class, that overrides the RenderBeginTag method. The override checks whether tagKey is equal to the Font field, which indicates that a <font> markup element will be rendered. If so, the override calls the IsAttributeDefined method to find out whether the <font> element contains a Size attribute. If the IsAttributeDefined returns false, the AddAttribute method calls the GetAttributeKey method, which defines the Size and sets its value to 30pt.

// If the tagKey parameter is set to a <font> element
// but a size attribute is not defined on the element,
// the AddStyleAttribute method adds a size attribute
// and sets it to 30 point. 
if (tagKey == HtmlTextWriterTag.Font)
{
    if (!IsAttributeDefined(HtmlTextWriterAttribute.Size))
    {
        AddAttribute(GetAttributeKey("size"), "30pt");
    }
}

// If the tagKey parameter is set to a <font> element
// but a size attribute is not defined on the element,
// the AddStyleAttribute method call adds a size attribute
// and sets it to 30 point. 
if (tagKey.Equals(HtmlTextWriterTag.Font)) {
    if (!(IsAttributeDefined(HtmlTextWriterAttribute.Size))) {
        AddAttribute(GetAttributeKey("size"), "30pt");
    }
}

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, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft