How to: Print a Document using the PrintableComponentLink
- 3 minutes to read
This example demonstrates how to use a PrintableComponentLink to print from the RichEditDocumentServer. An instance of the RichEditDocumentServer loads a document, inserts a datetime stamp in its header and prints it. Various print options, such as page size, orientation and margins are set in code at run time using the Section interface. The application searches a list of installed printers for a printer containing a certain text (“Canon”) in its name and prints to that printer. If a printer with the specified name is not found, the default printer is used.
Note
The following code sample uses the PrintingSystem class. Make sure that the DevExpress.XtraPrinting.v19.1.dll assembly is added to your project.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/how-to-print-from-the-richeditdocumentserver-using-the-printablecomponentlink-e4846
using System;
using System.Windows.Forms;
using System.Drawing.Printing;
using DevExpress.XtraPrinting;
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
namespace RichEdit_PrintingSystem
{
public partial class Form1 : Form
{
public Form1()
{
InitializeComponent();
}
#region #printfromserver
private void btn_PrintFromServer_Click(object sender, EventArgs e)
{
RichEditDocumentServer srv = new RichEditDocumentServer();
srv.LoadDocument("Grimm.docx", DocumentFormat.OpenXml);
// Insert a field displaying the current date/time into the document header.
srv.BeginUpdate();
SubDocument _header = srv.Document.Sections[0].BeginUpdateHeader();
_header.Fields.Create(_header.Range.Start,"DATE \\@ \"dddd, MMMM dd, yyyy HH:mm:ss\" \\MERGEFORMAT");
_header.Paragraphs[0].Alignment = ParagraphAlignment.Right;
srv.Document.Sections[0].EndUpdateHeader(_header);
// Specify page margins, orientation, etc.
SetPrintOptions(srv);
srv.EndUpdate();
// Display field values instead of code.
srv.Options.MailMerge.ViewMergedData = true;
// Create a printable link to print a document.
PrintViaLink(srv);
}
#endregion #printfromserver
#region #setprintoptions
private static void SetPrintOptions(IRichEditDocumentServer richedit)
{
foreach (Section _section in richedit.Document.Sections) {
_section.Page.PaperKind = System.Drawing.Printing.PaperKind.A4;
_section.Page.Landscape = false;
_section.Margins.Left = 150f;
_section.Margins.Right = 150f;
_section.Margins.Top = 50f;
_section.Margins.Bottom = 50f;
_section.PageNumbering.NumberingFormat = NumberingFormat.CardinalText;
_section.PageNumbering.FirstPageNumber = 0;
}
}
#endregion #setprintoptions
#region #printvialink
private static void PrintViaLink(RichEditDocumentServer srv)
{
if (!srv.IsPrintingAvailable) return;
PrintableComponentLink link = new PrintableComponentLink(new PrintingSystem());
link.Component = srv;
// Disable warnings.
link.PrintingSystem.ShowMarginsWarning = false;
link.PrintingSystem.ShowPrintStatusDialog = false;
// Find a printer containing 'Canon' in its name.
string printerName = String.Empty;
for (int i = 0; i < PrinterSettings.InstalledPrinters.Count; i++) {
string pName = PrinterSettings.InstalledPrinters[i];
if (pName.Contains("Canon")) {
printerName = pName;
break;
}
}
// Print to the specified printer.
link.Print(printerName);
}
#endregion #printvialink
}
}