Export (0) Print
Expand All

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 your application needs an encoding for a header name, it should call GetEncoding 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

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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