HtmlTextWriter.GetStyleName Method (HtmlTextWriterStyle)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Obtains the markup style attribute name associated with the specified HtmlTextWriterStyle enumeration value.

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

protected string GetStyleName(
	HtmlTextWriterStyle styleKey


Type: System.Web.UI.HtmlTextWriterStyle

The HtmlTextWriterStyle to obtain the style attribute name for.

Return Value

Type: System.String

The style attribute name associated with the HtmlTextWriterStyle enumeration value specified in styleKey.

If styleKey is not a valid HtmlTextWriterStyle object, the GetStyleName method returns an empty string ("").

The following code example shows how to check whether a <label> element is being rendered. If so, it checks whether a Color style attribute has been defined on the element. If the attribute has not been defined, the AddStyleAttribute method is called and the GetStyleName method converts the Color enumeration member into its string representation to pass to the AddStyleAttribute method.

// If the markup element being rendered is a Label,
// render the opening tag of a Font element before it.
if (tagKey == HtmlTextWriterTag.Label)
    // Check whether a Color style attribute is 
    // included on the Label. If not, use the
    // AddStyleAttribute and GetStyleName methods to add one
    // and set its value to red.
    if (!IsStyleAttributeDefined(HtmlTextWriterStyle.Color))
        AddStyleAttribute(GetStyleName(HtmlTextWriterStyle.Color), "red");

.NET Framework
Available since 1.1
Return to top