EmailOptions.RecipientName Property

Gets or sets the text which is used as an e-mail’s recipient name, when a document is exported and sent via e-mail from its Print Preview.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v24.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

[XtraSerializableProperty]
public string RecipientName { get; set; }

VB.NET

<XtraSerializableProperty>
Public Property RecipientName As String

Property Value

Type	Description
String	A String which represents the e-mail recipient name.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to RecipientName
Cross-Platform Class Library	ExportOptions	.Email .RecipientName
WPF Controls	SendOptionsViewModel	.EmailOptions .RecipientName

Example

This example illustrates how to specify the primary export options of a report by using the XtraReport.ExportOptions property. These options are taken into account when a document is being exported from a print preview.

This example presumes that a report is exported silently, without prompting an end-user to customize the export options.

All available export options are listed in the ExportOptionKind enumeration.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/reporting-winforms-export-options-actions

Form1.cs

using System;
using System.Drawing.Imaging;
using System.Globalization;
using System.Text;
using System.Windows.Forms;
using DevExpress.XtraPrinting;
// ...

namespace WindowsFormsApplication1 {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private XtraReport1 report;

        private void Form1_Load(object sender, EventArgs e) {
            report = new XtraReport1();
            documentViewer1.DocumentSource = report;
            report.CreateDocument();

            PrintingSystemBase printingSystem1 = report.PrintingSystem;

            // Obtain the current export options.
            ExportOptions options = printingSystem1.ExportOptions;

            // Set Print Preview options.
            options.PrintPreview.ActionAfterExport = ActionAfterExport.AskUser;
            options.PrintPreview.DefaultDirectory = "C:\\Temp";
            options.PrintPreview.DefaultFileName = "Report";
            options.PrintPreview.SaveMode = SaveMode.UsingDefaultPath;
            options.PrintPreview.ShowOptionsBeforeExport = false;

            // Set E-mail options.
            options.Email.RecipientAddress = "[e-mail]";
            options.Email.RecipientName = "Someone";
            options.Email.Subject = "Test";
            options.Email.Body = "Test";

            // Set CSV-specific export options.
            options.Csv.Encoding = Encoding.Unicode;
            options.Csv.Separator =
                CultureInfo.CurrentCulture.TextInfo.ListSeparator.ToString();

            // Set HTML-specific export options.
            options.Html.CharacterSet = "UTF-8";
            options.Html.RemoveSecondarySymbols = false;
            options.Html.Title = "Test Title";

            // Set Image-specific export options.
            options.Image.Format = DXImageFormat.Jpeg;

            // Set MHT-specific export options.
            options.Mht.CharacterSet = "UTF-8";
            options.Mht.RemoveSecondarySymbols = false;
            options.Mht.Title = "Test Title";

            // Set PDF-specific export options.
            options.Pdf.Compressed = true;
            options.Pdf.ImageQuality = PdfJpegImageQuality.Low;
            options.Pdf.NeverEmbeddedFonts = "Tahoma;Courier New";
            options.Pdf.DocumentOptions.Application = "Test Application";
            options.Pdf.DocumentOptions.Author = "Test Team";
            options.Pdf.DocumentOptions.Keywords = "Test1, Test2";
            options.Pdf.DocumentOptions.Subject = "Test Subject";
            options.Pdf.DocumentOptions.Title = "Test Title";

            // Set Text-specific export options.
            options.Text.Encoding = Encoding.Unicode;
            options.Text.Separator =
                CultureInfo.CurrentCulture.TextInfo.ListSeparator.ToString();

            // Set XLS-specific export options.
            options.Xls.ShowGridLines = true;
            options.Xls.SheetName = "Page 1";
            options.Xls.TextExportMode = TextExportMode.Value;

            // Set XLSX-specific export options.
            options.Xlsx.ShowGridLines = true;
            options.Xlsx.SheetName = "Page 1";
            options.Xlsx.TextExportMode = TextExportMode.Value;
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Drawing.Imaging
Imports System.Globalization
Imports System.Text
Imports System.Windows.Forms
Imports DevExpress.XtraPrinting
' ...

Namespace WindowsFormsApplication1
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub

        Private report As XtraReport1

        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            report = New XtraReport1()
            documentViewer1.DocumentSource = report
            report.CreateDocument()

            Dim printingSystem1 As PrintingSystemBase = report.PrintingSystem

            ' Obtain the current export options.
            Dim options As ExportOptions = printingSystem1.ExportOptions

            ' Set Print Preview options.
            options.PrintPreview.ActionAfterExport = ActionAfterExport.AskUser
            options.PrintPreview.DefaultDirectory = "C:\Temp"
            options.PrintPreview.DefaultFileName = "Report"
            options.PrintPreview.SaveMode = SaveMode.UsingDefaultPath
            options.PrintPreview.ShowOptionsBeforeExport = False

            ' Set E-mail options.
            options.Email.RecipientAddress = "[e-mail]"
            options.Email.RecipientName = "Someone"
            options.Email.Subject = "Test"
            options.Email.Body = "Test"

            ' Set CSV-specific export options.
            options.Csv.Encoding = Encoding.Unicode
            options.Csv.Separator = CultureInfo.CurrentCulture.TextInfo.ListSeparator.ToString()

            ' Set HTML-specific export options.
            options.Html.CharacterSet = "UTF-8"
            options.Html.RemoveSecondarySymbols = False
            options.Html.Title = "Test Title"

            ' Set Image-specific export options.
            options.Image.Format = DXImageFormat.Jpeg

            ' Set MHT-specific export options.
            options.Mht.CharacterSet = "UTF-8"
            options.Mht.RemoveSecondarySymbols = False
            options.Mht.Title = "Test Title"

            ' Set PDF-specific export options.
            options.Pdf.Compressed = True
            options.Pdf.ImageQuality = PdfJpegImageQuality.Low
            options.Pdf.NeverEmbeddedFonts = "Tahoma;Courier New"
            options.Pdf.DocumentOptions.Application = "Test Application"
            options.Pdf.DocumentOptions.Author = "Test Team"
            options.Pdf.DocumentOptions.Keywords = "Test1, Test2"
            options.Pdf.DocumentOptions.Subject = "Test Subject"
            options.Pdf.DocumentOptions.Title = "Test Title"

            ' Set Text-specific export options.
            options.Text.Encoding = Encoding.Unicode
            options.Text.Separator = CultureInfo.CurrentCulture.TextInfo.ListSeparator.ToString()

            ' Set XLS-specific export options.
            options.Xls.ShowGridLines = True
            options.Xls.SheetName = "Page 1"
            options.Xls.TextExportMode = TextExportMode.Value

            ' Set XLSX-specific export options.
            options.Xlsx.ShowGridLines = True
            options.Xlsx.SheetName = "Page 1"
            options.Xlsx.TextExportMode = TextExportMode.Value
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RecipientName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

reporting-winforms-mailkit-email-report-pdf/CS/Form1.cs#L33

message.From.Add(new MailboxAddress("Someone", "[e-mail]"));
message.To.Add(new MailboxAddress(report.ExportOptions.Email.RecipientName,
    report.ExportOptions.Email.RecipientAddress));

VB.NET

reporting-winforms-mailkit-email-report-pdf/VB/Form1.vb#L32

message.From.Add(New MailboxAddress("Someone", "[e-mail]"))
message.To.Add(New MailboxAddress(report.ExportOptions.Email.RecipientName, report.ExportOptions.Email.RecipientAddress))
message.Subject = report.ExportOptions.Email.Subject