Encoding.HeaderName Property

 

When overridden in a derived class, gets a name for the current encoding that can be used with mail agent header tags.

Namespace:   System.Text
Assembly:  mscorlib (in mscorlib.dll)

abstract HeaderName : string with get
override HeaderName : string with get

Property Value

Type: System.String

A name for the current Encoding to use with mail agent header tags.

-or-

An empty string (""), if the current Encoding cannot be used.

If you need an encoding for a header name, you should call the GetEncoding method with the HeaderName property. Often the method retrieves a different encoding from the test encoding furnished in the call. Generally only e-mail applications need to retrieve such an encoding.

In some cases, the value of the BodyName property corresponds to the international standard that defines that encoding. This doesn't mean that the implementation complies in full with that standard.

Note that WebName returns the name to use to describe an encoding. The HeaderName property defines a different encoding that might work better for an e-mail application, for example. However, use of the property to define the encoding is not recommended.

The following example retrieves the different names for each encoding and displays the encodings with one or more names that are different from EncodingInfo.Name. It displays EncodingName but does not compare against it.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show: