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 16:06:09 +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="Application"
+             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:local="clr-namespace:CodeSampleVb"
+             StartupUri="MainWindow.xaml">
+    <Application.Resources>
+         
+    </Application.Resources>
+</Application>
@@ -0,0 +1,6 @@
+Class Application
+
+    ' Application-level events, such as Startup, Exit, and DispatcherUnhandledException
+    ' can be handled in this file.
+
+End Class
@@ -0,0 +1,11 @@
+Imports System.Windows
+
+'The ThemeInfo attribute describes where any theme specific and generic resource dictionaries can be found.
+'1st parameter: where theme specific resource dictionaries are located
+'(used if a resource is not found in the page,
+' or application resource dictionaries)
+
+'2nd parameter: where the generic resource dictionary is located
+'(used if a resource is not found in the page,
+'app, and any theme specific resource dictionaries)
+<Assembly: ThemeInfo(ResourceDictionaryLocation.None, ResourceDictionaryLocation.SourceAssembly)>
@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>WinExe</OutputType>
+    <TargetFramework>net5.0-windows</TargetFramework>
+    <RootNamespace>CodeSampleVb</RootNamespace>
+    <UseWPF>true</UseWPF>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Import Include="System.Windows" />
+    <Import Include="System.Windows.Controls" />
+    <Import Include="System.Windows.Data" />
+    <Import Include="System.Windows.Documents" />
+    <Import Include="System.Windows.Input" />
+    <Import Include="System.Windows.Media" />
+    <Import Include="System.Windows.Media.Imaging" />
+    <Import Include="System.Windows.Navigation" />
+    <Import Include="System.Windows.Shapes" />
+  </ItemGroup>
+
+</Project>
@@ -0,0 +1,14 @@
+<Window x:Class="CodeSampleVb.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="Enter the path to a folder that contains XPS files" HorizontalAlignment="Left" Margin="27,12,0,0" VerticalAlignment="Top" FontSize="11" Height="25" Width="339"/>
+        <TextBox HorizontalAlignment="Left" Margin="32,35,0,0" TextWrapping="Wrap" VerticalAlignment="Top" Width="447" FontSize="14" x:Name="txtFolderPath" Height="21"/>
+        <Button Content="Print" HorizontalAlignment="Left" Margin="32,71,0,0" FontSize="14" Width="51" x:Name="btnPrint" Height="28" VerticalAlignment="Top" Click="BtnPrint_Click"/>
+        <CheckBox x:Name="cbxValidateXps" Content="Validate XPS files" HorizontalAlignment="Left" Margin="137,78,0,0" VerticalAlignment="Top" IsChecked="True"/>
+    </Grid>
+</Window>
@@ -0,0 +1,133 @@
+Imports System.IO
+Imports System.Printing
+Imports System.Threading
+
+Namespace CodeSampleVb
+    Partial Public Class MainWindow
+        Inherits Window
+
+        ''' <summary>
+        ''' Interaction logic for MainWindow.xaml
+        ''' </summary>
+        Public Sub New()
+
+            InitializeComponent()
+
+        End Sub
+
+        Private Async Sub BtnPrint_Click(sender As Object, e As RoutedEventArgs)
+
+            '  Check that the folder exists.
+            If Not Directory.Exists(txtFolderPath.Text) Then
+                MessageBox.Show("First select a valid folder path.")
+                Return
+            End If
+
+            ' Check whether any XPS files exist in the folder.
+            Dim xpsFilePaths = Directory.GetFiles(path:=txtFolderPath.Text, searchPattern:="*.xps")
+            If xpsFilePaths.Length = 0 Then
+                MessageBox.Show("No XPS files found.")
+                Return
+            End If
+
+            ' Determine whether XPS validation is needed.
+            Dim fastCopy As Boolean = cbxValidateXps.IsChecked = False
+
+            ' Batch add a collection of XPS files to the print queue.
+            ' Run asynchronously to avoid blocking the UI thread.
+            Dim isAllPrinted As Boolean = Await BatchAddToPrintQueueAsync(xpsFilePaths, fastCopy)
+
+            ' Show result message.
+            MessageBox.Show($"{If(isAllPrinted, "Added", "Failed to add")} all documents to the print queue.")
+
+        End Sub
+
+        ' <SampleCode1>
+        ''' <summary>
+        ''' Asyncronously, add a batch of XPS documents to the print queue using a PrintQueue.AddJob method.
+        ''' Handle the thread apartment state required by the PrintQueue.AddJob method.
+        ''' </summary>
+        ''' <param name="xpsFilePaths">A collection of XPS documents.</param>
+        ''' <param name="fastCopy">Whether to validate the XPS documents.</param>
+        ''' <returns>Whether all documents were added to the print queue.</returns>
+        Public Shared Async Function BatchAddToPrintQueueAsync(xpsFilePaths As IEnumerable(Of String), Optional fastCopy As Boolean = False) As Task(Of Boolean)
+
+            Dim isAllPrinted As Boolean = True
+
+            ' Queue some work to run on the ThreadPool.
+            ' Wait for completion without blocking the calling thread.
+            Await Task.Run(
+                Sub()
+                    If fastCopy Then
+                        isAllPrinted = BatchAddToPrintQueue(xpsFilePaths, fastCopy)
+                    Else
+                        ' Create a thread to call the PrintQueue.AddJob method.
+                        Dim newThread As New Thread(
+                            Sub()
+                                isAllPrinted = BatchAddToPrintQueue(xpsFilePaths, fastCopy)
+                            End Sub
+                        )
+
+                        ' Set the thread to single-threaded apartment state.
+                        newThread.SetApartmentState(ApartmentState.STA)
+
+                        ' Start the thread.
+                        newThread.Start()
+
+                        ' Wait for thread completion. Blocks the calling thread,
+                        ' which is a ThreadPool thread.
+                        newThread.Join()
+                    End If
+                End Sub
+            )
+
+            Return isAllPrinted
+
+        End Function
+
+        ''' <summary>
+        ''' Add a batch of XPS documents to the print queue using a PrintQueue.AddJob method.
+        ''' </summary>
+        ''' <param name="xpsFilePaths">A collection of XPS documents.</param>
+        ''' <param name="fastCopy">Whether to validate the XPS documents.</param>
+        ''' <returns>Whether all documents were added to the print queue.</returns>
+        Public Shared Function BatchAddToPrintQueue(xpsFilePaths As IEnumerable(Of String), fastCopy As Boolean) As Boolean
+
+            Dim isAllPrinted As Boolean = True
+
+            ' To print without getting the "Save Output File As" dialog, ensure
+            ' that your default printer is not the Microsoft XPS Document Writer,
+            ' Microsoft Print to PDF, or other print-to-file option.
+
+            ' Get a reference to the default print queue.
+            Dim defaultPrintQueue As PrintQueue = LocalPrintServer.GetDefaultPrintQueue()
+
+            ' Iterate through the document collection.
+            For Each xpsFilePath As String In xpsFilePaths
+
+                ' Get document name.
+                Dim xpsFileName As String = Path.GetFileName(xpsFilePath)
+
+                Try
+                    ' The AddJob method adds a new print job for an XPS
+                    ' document into the print queue, and assigns a job name.
+                    ' Use fastCopy to skip XPS validation and progress notifications.
+                    ' If fastCopy is false, the thread that calls PrintQueue.AddJob
+                    ' must have a single-threaded apartment state.
+                    Dim xpsPrintJob As PrintSystemJobInfo = defaultPrintQueue.AddJob(jobName:=xpsFileName, documentPath:=xpsFilePath, fastCopy)
+
+                    ' If the queue is not paused and the printer is working, then jobs will automatically begin printing.
+                    Debug.WriteLine($"Added {xpsFileName} to the print queue.")
+                Catch e As PrintJobException
+                    isAllPrinted = False
+                    Debug.WriteLine($"Failed to add {xpsFileName} to the print queue: {e.Message}\r\n{e.InnerException}")
+                End Try
+            Next
+
+            Return isAllPrinted
+
+        End Function
+        ' </SampleCode1>
+    End Class
+
+End Namespace