PrintDialogX 2.1.4

PrintDialogX v2.1.4

A custom PrintDialog for WPF with preview in real-time. Full options with print settings, including copies, custom pages, orientation, color, quality, scale, pages-per-sheet, double-siding, paper size, paper type, paper source, etc. Support updatable documents according to the changes in settings. Equipped with a fast and elegant user interface.

Preview

Features

PrintDialogX is a powerful and beautiful customized print dialog. It basically supports all functions with the default Windows print dialog, but also provides extra functions and real-time previews. The printer settings only use the given printer's allowed options. The document being printed is also flexible and available for changes in content according to the adjusted settings by the user. The show-while-generate-document feature also allows a fast and user-friendly experience, where the document is generated dynamically while the print dialog is preparing itself.

• Printer list
  • Printer icons & status
  • "Add New Printer" button
  • Tooltips for detailed printer information
• Print settings
  • Copies and collate
  • Pages (all, current, or custom)
  • Orientation
  • Color and quality
  • Pages per sheet and order
  • Scale and margin
  • Doubled-sided and flipping
  • Paper size, type, and source
• Interactable real-time preview
  • Zooming and text selection
  • Page position and navigation
• Updatable documents
  • Document reloading callback for specfic print settings
  • Real-time updates on the content
• Result callbacks
  • Whether the "Print" or the "Cancel" button is clicked
  • The number of papers used
• Beautiful user interface
  • Uses Wpf.Ui
  • Customizable disabling of certain settings

Dependencies

• .Net Framework ≥ 4.7.2
• Wpf.Ui = 3.0.0

How to Use

An example project is included in the PrintDialogX.Test subfolder on Github, with step-by-step configurations of PrintDialog and both examples of generating the document before or during the opening of PrintDialog.

Initialize a PrintDialog instance.

//Initialize a PrintDialog instance and set its properties
PrintDialogX.PrintDialog.PrintDialog printDialog = new PrintDialogX.PrintDialog.PrintDialog()
{
    Owner = this, //Set the owner of the dialog
    Title = "Print", //Set the title of the dialog
};

Synchronized Document Generation

The document may be generated while the PrintDialog is loading, which is beneficial for larger documents.

//Show PrintDialog with a custom document generation function
//The function will be used to generate the document synchronously while the dialog is opening
if (printDialog.ShowDialog(() => printDialog.Document = GenerateDocument()) == true)
{
    //When the "Print" button was clicked, the print job was submitted, and the window was closed
    MessageBox.Show($"Document printed.\nIt uses {printDialog.TotalPapers} sheet(s) of paper.", "PrintDialog", MessageBoxButton.OK, MessageBoxImage.Information, MessageBoxResult.OK);
}
else
{
    //When the "Cancel" button was clicked and the window was closed
    MessageBox.Show("Print job canceled.", "PrintDialog", MessageBoxButton.OK, MessageBoxImage.Information, MessageBoxResult.OK);
}

private PrintDialogX.PrintDocument GenerateDocument()
{
    //Create a new document
    //PrintDialogX requires a PrintDocument instance as the document
    PrintDialogX.PrintDocument document = new PrintDialogX.PrintDocument().SetSizeByInch(8.5, 11); //Letter size, 8.5 x 11 in
    document.DocumentMargin = 60; //Default margin, 60 pixels

    //Loop 5 times to add 5 pages
    for (int i = 0; i < 5; i++)
    {
        //Create a new page and add its content
        PrintDialogX.PrintPage page = new PrintDialogX.PrintPage();
        page.Content = GeneratePageContent(i + 1, document.DocumentSize.Width, document.DocumentSize.Height, document.DocumentMargin);

        //Add the page into the document
        document.Pages.Add(page);
    }

    return document;
}

Pre-Generated Documents

If the document is already created, PrintDialog.Document can be directly set before calling PrintDialog.ShowDialog().

printDialog.Document = document;

//Show PrintDialog with the document already generated
if (printDialog.ShowDialog() == true)
{
    //...
}

PrintDialog Configurations

The defulat print settings that PrintDialog uses can be configured.

printDialog.DefaultSettings = new PrintDialogX.PrintDialog.PrintDialogSettings()
{
    Layout = PrintDialogX.PrintSettings.PageOrientation.Portrait,
    Color = PrintDialogX.PrintSettings.PageColor.Color,
    Quality = PrintDialogX.PrintSettings.PageQuality.Normal,
    PagesPerSheet = PrintDialogX.PrintSettings.PagesPerSheet.One,
    PageOrder = PrintDialogX.PrintSettings.PageOrder.Horizontal,
    DoubleSided = PrintDialogX.PrintSettings.DoubleSided.DoubleSidedLongEdge,
    PageSize = PrintDialogX.PrintSettings.PageSize.NorthAmericaLetter,
    PageType = PrintDialogX.PrintSettings.PageType.Plain
};
//PrinterDefaultSettings() can also be used to use the default settings of printers
//printDialog.DefaultSettings = PrintDialogX.PrintDialog.PrintDialogSettings.PrinterDefaultSettings();

The interface of PrintDialog can be customized to disable certain settings.

printDialog.AllowPagesOption = true; //Allow the "Pages" option (contains "All Pages", "Current Page", and "Custom Pages")
printDialog.AllowPagesPerSheetOption = true; //Allow the "Pages Per Sheet" option
printDialog.AllowPageOrderOption = true; //Allow the "Page Order" option
printDialog.AllowScaleOption = true; //Allow the "Scale" option
printDialog.AllowDoubleSidedOption = true; //Allow the "Double-Sided" option
printDialog.AllowAddNewPrinterButton = true; //Allow the "Add New Printer" button in the printer list
printDialog.AllowPrinterPreferencesButton = true; //Allow the "Printer Preferences" button

Dynamic Updatable Documents

PrintDialog.ReloadDocumentCallback can be set for updatable documents, where the content of the document can be updated based on the print settings. The callback function receives an instance of PrintDialog.DocumentInfo and must return a collection of updated PrintPage in the original length and order.

//Set the function that will be used to regenerate the document when the print settings are changed
printDialog.ReloadDocumentCallback = ReloadDocumentCallback;

private ICollection<PrintDialogX.PrintPage> ReloadDocumentCallback(PrintDialogX.PrintDialog.DocumentInfo documentInfo)
{
    //Optional callback function to recreate the content of the document with specific settings
    //An instance of PrintDialog.DocumentInfo is received as a parameter, which can be used to retrieve the current print settings set by the user
    //This function will only be called when the print settings are changed, and it must return a collection of PrintPage in the original length and order
    //The function has no need to alter the content to resolve basic changes in print settings, such as to resize the pages based on the new size in the print setting, as PrintDialog will take care of them
    //The function is intended to offer the ability to dynamically update the document for more complicated scenarios, such as styling asjuments or alternative formats for different media
    List<PrintDialogX.PrintPage> pages = new List<PrintDialogX.PrintPage>();

    //All pages must be recreated and add to the collection in the original manner
    //PrintDialog takes care of the "Pages" option regarding which pages are to be printed
    for (int i = 0; i < 5; i++)
    {
        //Create the new page and recreate the content with updated texts
        PrintPage page = new PrintPage();
        page.Content = GeneratePageContent(i + 1, documentInfo.Size.Width, documentInfo.Size.Height, documentInfo.Margin);
        pages.Add(page);
    }

    //Pass the collection of recreated pages back to PrintDialog
    return pages;
}

License

This project is under the MIT License.