Export (0) Print
Expand All

HtmlTextWriter.GetStyleName Method

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
)

Parameters

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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft