Printing in WPF port for .NET (#1156)

* Initial files * update toc * Content update - print-xps-files (user story 1861941) (#1151) * Add C# and VB sample code projects * Fix comments * Update C# and VB code * Add article * Further edits * Reviewer requested edits * Further edits * Use xref to link to API * Minor edits * Content update - invoke-print-dialog (user story 1861941) (#1141) * Content update including C# WPF project * Fix link * Remove test code * Further doc and C# sample edits * Add feature: printing with no print dialog * Separate out specific page range print functionality * Cleanup comments * UI tweaks * Add VB sample code project * Code file formatting * Update dotnet-desktop-guide/net/wpf/documents/how-to-display-print-dialog.md Co-authored-by: Andy (Steve) De George <[email protected]> * Add page range printing * Minor edits * Update dotnet-desktop-guide/net/wpf/documents/snippets/how-to-display-print-dialog/csharp/MainWindow.xaml.cs Co-authored-by: Andy (Steve) De George <[email protected]> * Update dotnet-desktop-guide/net/wpf/documents/how-to-display-print-dialog.md Co-authored-by: Andy (Steve) De George <[email protected]> * Promote example headings * Reorganize and add detail * Minor edits * Add detail * Further edits * Further edits * Add resource links * Add alternative API suggestions to a tip * Minor edit Co-authored-by: Andy (Steve) De George <[email protected]> * Content update - print-overview (user story 1861941) (#1153) * Add C# and VB sample code projects * Add article * Add redirects Co-authored-by: Tris Shores <[email protected]>
2026-09-09 07:56:08 +02:00 · 2021-09-24 16:16:55 -04:00
parent e96218f17e
commit bdd178c010
42 changed files with 2295 additions and 452 deletions
@@ -0,0 +1,9 @@
+<Application x:Class="CodeSampleCsharp.App"
+             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:local="clr-namespace:CodeSampleCsharp"
+             StartupUri="MainWindow.xaml">
+    <Application.Resources>
+         
+    </Application.Resources>
+</Application>
@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Configuration;
+using System.Data;
+using System.Linq;
+using System.Threading.Tasks;
+using System.Windows;
+
+namespace CodeSampleCsharp
+{
+    /// <summary>
+    /// Interaction logic for App.xaml
+    /// </summary>
+    public partial class App : Application
+    {
+    }
+}
@@ -0,0 +1,10 @@
+using System.Windows;
+
+[assembly: ThemeInfo(
+    ResourceDictionaryLocation.None, //where theme specific resource dictionaries are located
+                                     //(used if a resource is not found in the page,
+                                     // or application resource dictionaries)
+    ResourceDictionaryLocation.SourceAssembly //where the generic resource dictionary is located
+                                              //(used if a resource is not found in the page,
+                                              // app, or any theme specific resource dictionaries)
+)]
@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>WinExe</OutputType>
+    <TargetFramework>net5.0-windows</TargetFramework>
+    <UseWPF>true</UseWPF>
+  </PropertyGroup>
+
+</Project>
@@ -0,0 +1,16 @@
+<Window x:Class="CodeSampleCsharp.MainWindow"
+        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+        mc:Ignorable="d"
+        Title="Print an XPS file" Height="149" Width="509">
+    <Grid Margin="0,0,0,10">
+        <Label Content="Select XPS file" HorizontalAlignment="Left" Margin="27,12,0,0" VerticalAlignment="Top" FontSize="11" Height="25" Width="78"/>
+
+        <Button Content="Browse" HorizontalAlignment="Left" Margin="428,35,0,0" VerticalAlignment="Top" Width="48" x:Name="btnBrowse" Height="20"/>
+        <TextBox HorizontalAlignment="Left" Margin="32,35,0,0" TextWrapping="Wrap" VerticalAlignment="Top" Width="391" FontSize="14" x:Name="txtXpsFilePath" Height="21"/>
+        <Button Content="Print" HorizontalAlignment="Left" Margin="32,71,0,0" FontSize="14" Width="51" x:Name="btnPrint" Height="28" VerticalAlignment="Top"/>
+        <CheckBox x:Name="cbxHidePrintDialog" Content="Hide print dialog" HorizontalAlignment="Left" Margin="124,77,0,0" VerticalAlignment="Top" RenderTransformOrigin="0.376,-0.054"/>
+    </Grid>
+</Window>
@@ -0,0 +1,240 @@
+using System;
+using System.IO;
+using System.Reflection;
+using System.Windows;
+using System.Windows.Controls;
+using System.Windows.Documents;
+using System.Windows.Media;
+using System.Windows.Xps.Packaging;
+using Microsoft.Win32;
+
+namespace CodeSampleCsharp
+{
+    /// <summary>
+    /// Interaction logic for MainWindow.xaml.
+    /// </summary>
+    public partial class MainWindow : Window
+    {
+        public MainWindow()
+        {
+            InitializeComponent();
+
+            // Events.
+            btnBrowse.Click += BtnBrowse_Click;
+            btnPrint.Click += BtnPrint_Click;
+        }
+
+        private void BtnBrowse_Click(object sender, RoutedEventArgs e)
+        {
+            // Configure an open file dialog box.
+            OpenFileDialog openFileDialog = new()
+            {
+                FileName = "Document",
+                DefaultExt = ".xps",
+                Filter = "Text documents (.xps)|*.xps"
+            };
+
+            // Show open file dialog box.
+            bool? result = openFileDialog.ShowDialog();
+
+            // Process open file dialog box results.
+            if (result == true)
+            {
+                // Show selected XPS file path.
+                txtXpsFilePath.Text = openFileDialog.FileName;
+            }
+        }
+
+        private void BtnPrint_Click(object sender, RoutedEventArgs e)
+        {
+            // Check the file exists.
+            if (!File.Exists(txtXpsFilePath.Text))
+            {
+                MessageBox.Show("First select an XPS file.");
+                return;
+            }
+
+            // Get the print dialog visibility.
+            bool hidePrintDialog = cbxHidePrintDialog.IsChecked == true;
+
+            // Print whole document.
+            bool isPrinted = PrintWholeDocument(txtXpsFilePath.Text, hidePrintDialog);
+            MessageBox.Show($"PrintWholeDocument {(isPrinted ? "printed" : "failed to print")}.");
+
+            // Print a specific range of document pages as specified in the print dialog.
+            if (!hidePrintDialog)
+            {
+                isPrinted = PrintDocumentPageRange(txtXpsFilePath.Text);
+                MessageBox.Show($"PrintDocumentPageRange {(isPrinted ? "printed" : "failed to print")}.");
+            }
+        }
+
+        // <SampleCode1>
+        /// <summary>
+        /// Print all pages of an XPS document.
+        /// Optionally, hide the print dialog window.
+        /// </summary>
+        /// <param name="xpsFilePath">Path to source XPS file</param>
+        /// <param name="hidePrintDialog">Whether to hide the print dialog window (shown by default)</param>
+        /// <returns>Whether the document printed</returns>
+        public static bool PrintWholeDocument(string xpsFilePath, bool hidePrintDialog = false)
+        {
+            // Create the print dialog object and set options.
+            PrintDialog printDialog = new();
+
+            if (!hidePrintDialog)
+            {
+                // Display the dialog. This returns true if the user presses the Print button.
+                bool? isPrinted = printDialog.ShowDialog();
+                if (isPrinted != true)
+                    return false;
+            }
+
+            // Print the whole document.
+            try
+            {
+                // Open the selected document.
+                XpsDocument xpsDocument = new(xpsFilePath, FileAccess.Read);
+
+                // Get a fixed document sequence for the selected document.
+                FixedDocumentSequence fixedDocSeq = xpsDocument.GetFixedDocumentSequence();
+
+                // Create a paginator for all pages in the selected document.
+                DocumentPaginator docPaginator = fixedDocSeq.DocumentPaginator;
+
+                // Print to a new file.
+                printDialog.PrintDocument(docPaginator, $"Printing {Path.GetFileName(xpsFilePath)}");
+
+                return true;
+            }
+            catch (Exception e)
+            {
+                MessageBox.Show(e.Message);
+
+                return false;
+            }
+        }
+        // </SampleCode1>
+
+        // <SampleCode2>
+        /// <summary>
+        /// Print a specific range of pages within an XPS document.
+        /// </summary>
+        /// <param name="xpsFilePath">Path to source XPS file</param>
+        /// <returns>Whether the document printed</returns>
+        public static bool PrintDocumentPageRange(string xpsFilePath)
+        {
+            // Create the print dialog object and set options.
+            PrintDialog printDialog = new()
+            {
+                UserPageRangeEnabled = true
+            };
+
+            // Display the dialog. This returns true if the user presses the Print button.
+            bool? isPrinted = printDialog.ShowDialog();
+            if (isPrinted != true)
+                return false;
+
+            // Print a specific page range within the document.
+            try
+            {
+                // Open the selected document.
+                XpsDocument xpsDocument = new(xpsFilePath, FileAccess.Read);
+
+                // Get a fixed document sequence for the selected document.
+                FixedDocumentSequence fixedDocSeq = xpsDocument.GetFixedDocumentSequence();
+
+                // Create a paginator for all pages in the selected document.
+                DocumentPaginator docPaginator = fixedDocSeq.DocumentPaginator;
+
+                // Check whether a page range was specified in the print dialog.
+                if (printDialog.PageRangeSelection == PageRangeSelection.UserPages)
+                {
+                    // Create a document paginator for the specified range of pages.
+                    docPaginator = new DocPaginator(fixedDocSeq.DocumentPaginator, printDialog.PageRange);
+                }
+
+                // Print to a new file.
+                printDialog.PrintDocument(docPaginator, $"Printing {Path.GetFileName(xpsFilePath)}");
+
+                return true;
+            }
+            catch (Exception e)
+            {
+                MessageBox.Show(e.Message);
+
+                return false;
+            }
+        }
+
+        /// <summary>
+        /// Extend the abstract DocumentPaginator class to support page range printing. This class is based on the following online resources:
+        ///
+        /// https://www.thomasclaudiushuber.com/2009/11/24/wpf-printing-how-to-print-a-pagerange-with-wpfs-printdialog-that-means-the-user-can-select-specific-pages-and-only-these-pages-are-printed/
+        ///
+        /// https://social.msdn.microsoft.com/Forums/vstudio/en-US/9180e260-0791-4f2d-962d-abcb22ba8d09/how-to-print-multiple-page-ranges-with-wpf-printdialog
+        ///
+        /// https://social.msdn.microsoft.com/Forums/en-US/841e804b-9130-4476-8709-0d2854c11582/exception-quotfixedpage-cannot-contain-another-fixedpagequot-when-printing-to-the-xps-document?forum=wpf
+        /// </summary>
+        public class DocPaginator : DocumentPaginator
+        {
+            private readonly DocumentPaginator _documentPaginator;
+            private readonly int _startPageIndex;
+            private readonly int _endPageIndex;
+            private readonly int _pageCount;
+
+            public DocPaginator(DocumentPaginator documentPaginator, PageRange pageRange)
+            {
+                // Set document paginator.
+                _documentPaginator = documentPaginator;
+
+                // Set page indices.
+                _startPageIndex = pageRange.PageFrom - 1;
+                _endPageIndex = pageRange.PageTo - 1;
+
+                // Validate and set page count.
+                if (_startPageIndex >= 0 &&
+                    _endPageIndex >= 0 &&
+                    _startPageIndex <= _documentPaginator.PageCount - 1 &&
+                    _endPageIndex <= _documentPaginator.PageCount - 1 &&
+                    _startPageIndex <= _endPageIndex)
+                    _pageCount = _endPageIndex - _startPageIndex + 1;
+            }
+
+            public override bool IsPageCountValid => true;
+
+            public override int PageCount => _pageCount;
+
+            public override IDocumentPaginatorSource Source => _documentPaginator.Source;
+
+            public override Size PageSize { get => _documentPaginator.PageSize; set => _documentPaginator.PageSize = value; }
+
+            public override DocumentPage GetPage(int pageNumber)
+            {
+                DocumentPage documentPage = _documentPaginator.GetPage(_startPageIndex + pageNumber);
+
+                // Workaround for "FixedPageInPage" exception.
+                if (documentPage.Visual is FixedPage fixedPage)
+                {
+                    var containerVisual = new ContainerVisual();
+                    foreach (object child in fixedPage.Children)
+                    {
+                        var childClone = (UIElement)child.GetType().GetMethod("MemberwiseClone", BindingFlags.Instance | BindingFlags.NonPublic).Invoke(child, null);
+
+                        FieldInfo parentField = childClone.GetType().GetField("_parent", BindingFlags.Instance | BindingFlags.NonPublic);
+                        if (parentField != null)
+                        {
+                            parentField.SetValue(childClone, null);
+                            containerVisual.Children.Add(childClone);
+                        }
+                    }
+
+                    return new DocumentPage(containerVisual, documentPage.Size, documentPage.BleedBox, documentPage.ContentBox);
+                }
+
+                return documentPage;
+            }
+        }
+        // </SampleCode2>
+    }
+}