MailAddress::DisplayName Property


Gets the display name composed from the display name and address information specified when this instance was created.

Namespace:   System.Net.Mail
Assembly:  System (in System.dll)

property String^ DisplayName {
	String^ get();

Property Value

Type: System::String^

A String that contains the display name; otherwise, String::Empty ("") if no display name information was specified when this instance was created.

Display names that contain non-ASCII characters are returned in human-readable form. Use the ToString method to get the encoded form of the DisplayName.

Some software programs that are used to read e-mail display the DisplayName property value instead of, or in addition to, the e-mail address.

The following code example displays the DisplayName for the recipient of an e-mail message.

static void CreateBccTestMessage( String^ server )
   MailAddress^ from = gcnew MailAddress( L"",L"Ben Miller" );
   MailAddress^ to = gcnew MailAddress( L"",L"Jane Clayton" );
   MailMessage^ message = gcnew MailMessage( from,to );
   message->Subject = L"Using the SmtpClient class.";
   message->Body = L"Using this feature, you can send an e-mail message from an application very easily.";
   MailAddress^ bcc = gcnew MailAddress( L"" );
   message->Bcc->Add( bcc );
   SmtpClient^ client = gcnew SmtpClient( server );
   client->Credentials = CredentialCache::DefaultNetworkCredentials;
   Console::WriteLine( L"Sending an e-mail message to {0} and {1}.", to->DisplayName, message->Bcc );
       client->Send( message );
   catch ( Exception^ ex )
       Console::WriteLine(L"Exception caught in CreateBccTestMessage(): {0}", 
                     ex->ToString() );

.NET Framework
Available since 2.0
Return to top