This documentation is archived and is not being maintained.

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" );
   }

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: