We use cookies to give you the best experience on our website. If you continue to browse, then you agree to our privacy policy and cookie policy. Image for the cookie policy date
Unfortunately, activation email could not send to your email. Please try again.
Syncfusion Feedback

How to paginate an image in PDF using C# and VB.NET

Platform: WinForms |
Control: PDF

Syncfusion Essential PDF is a .NET PDF library used to create, read, and edit PDF documents. Using this library, you can allow a large image to paginate across multiple pages in the PDF document using C# and VB.NET.

Steps to draw paginated image on PDF programmatically:

  1. Create a new C# console application project. creation of console application project
  2. Install the Syncfusion.Pdf.WinForms NuGet packages as reference to your .NET Framework application from NuGet.org. NuGet package reference
  3. Include the following namespaces in the Program.cs file.

C#

using Syncfusion.Pdf;
using Syncfusion.Pdf.Graphics;

 

VB.NET

Imports Syncfusion.Pdf
Imports Syncfusion.Pdf.Graphics

 

  1. Use the following code snippet to create PDF and draw image on it.

C#

//Create a document
PdfDocument doc = new PdfDocument();
//Add new page
PdfPage page = doc.Pages.Add();
//Load a bitmap
PdfBitmap image = new PdfBitmap( "Autumn Leaves.jpg");
//Set layout property to break the element across the pages
PdfLayoutFormat format = new PdfLayoutFormat();
format.Break = PdfLayoutBreakType.FitPage;
format.Layout = PdfLayoutType.Paginate;
//Draw image
image.Draw(page, 20, 400, format);
//Save the PDF
doc.Save("ImagePagination.pdf");
doc.Close(true);
//This will open the PDF file so, the result will be seen in default PDF viewer
Process.Start("ImagePagination.pdf");

 

VB.NET

'Create a document
Dim doc As New PdfDocument()
'Add new page
Dim page As PdfPage = doc.Pages.Add()
'Load a bitmap
Dim image As New PdfBitmap("Autumn Leaves.jpg")
'Set layout property to break the element across the pages.
Dim format As New PdfLayoutFormat()
format.Break = PdfLayoutBreakType.FitPage
format.Layout = PdfLayoutType.Paginate
'Draw image
image.Draw(page, 20, 400, format)
'Save the PDF
doc.Save("ImagePagination.pdf")
doc.Close(True)
'This will open the PDF file so, the result will be seen in default PDF viewer
Process.Start("ImagePagination.pdf")

 

A complete working sample can be downloaded from ImagePaginationSample.zip

By executing the program, you will get the PDF document as follows. ImagePagination Sample

Take a moment to peruse the documentation for working with images, where you will find other options like inserting, replacing image in PDF document, and image masking.

Refer here to explore the rich set of Syncfusion Essential PDF features.

Note:

Starting with v16.2.0.x, if you reference Syncfusion assemblies from trial setup or from the NuGet feed, include a license key in your projects. Refer to link to learn about generating and registering Syncfusion license key in your application to use the components without trail message.

 

2X faster development

The ultimate WinForms UI toolkit to boost your development speed.
ADD COMMENT
You must log in to leave a comment
Comments
Bryan
May 25, 2021

Hello,

I'm trying to add image pagination to an image via XAML conversion to PDF in a UWP project. How can one do that using this process? It only renders the top half of the page, but not the rest. The grid I am trying to convert lies within a ScrollView. Is there a way to capture the entire ScrollView to convert to PDF?

Below is the code for the download button:

private async void DownloadPdfBtn_OnClicked(object sender, EventArgs e)
        {
            try
            {
                var filename = "SurveyReport_" + ((App)Application.Current).CurrentUser.UserName + "_" + DateTime.UtcNow.ToString("MMddyy") + ".pdf";
                // Init Memory Stream.
                var stream = new MemoryStream();

                //Create a new PDF document
                using (var document = new PdfDocument())
                {
                    // Captures the XAML page as image and returns the image in memory stream.
                    var byteData = await DependencyService.Get<IExportPdf>().CaptureAsync();
                    Stream imageStream = new MemoryStream(byteData);

                    // Load the image in PdfBitmap.
                    var pdfBitmapImage = new PdfBitmap(imageStream);

                    // Set layout to break across pages.
                    var pdfLayoutFormat = new PdfLayoutFormat
                    {
                        Break = PdfLayoutBreakType.FitPage,
                        Layout = PdfLayoutType.Paginate
                    };

                    // Set the page size.
                    document.PageSettings.Margins.All = 0;
                    document.PageSettings.Orientation = PdfPageOrientation.Portrait;
                    document.PageSettings.Size = new SizeF(pdfBitmapImage.Width, pdfBitmapImage.Height);

                    var page = document.Pages.Add();

                    // Draw the image to the page.
                    pdfBitmapImage.Draw(page, 0, 0, pdfLayoutFormat);                  

                    // Save the document into memory stream.
                    document.Save(stream);
                }

                stream.Position = 0;

                // Save the stream as a file in the device and invoke it for viewing.
                await Xamarin.Forms.DependencyService.Get<IExportPdf>().Save(filename, "application/pdf", stream);
            }
            catch (Exception ex)
            {
                DisplayErrorAlert("DownloadPdfBtn_OnClicked", ex.Message);
            }
        }

And here is the dependency service class for the export:

public class ExportPdf : IExportPdf
    {
        public async Task<byte[]> CaptureAsync()
        {
            var renderTargetBitmap = new RenderTargetBitmap();
            await renderTargetBitmap.RenderAsync(Window.Current.Content);

            var pixelBuffer = await renderTargetBitmap.GetPixelsAsync();
            var pixels = pixelBuffer.ToArray();

            var displayInformation = DisplayInformation.GetForCurrentView().LogicalDpi;

            var stream = new InMemoryRandomAccessStream();

            var encoder = await BitmapEncoder.CreateAsync(BitmapEncoder.JpegEncoderId, stream);
            encoder.SetPixelData(
                BitmapPixelFormat.Bgra8, 
                BitmapAlphaMode.Ignore, 
                (uint)renderTargetBitmap.PixelWidth, 
                (uint)renderTargetBitmap.PixelHeight, 
                displayInformation,
                displayInformation, 
                pixels);
            await encoder.FlushAsync();

            stream.Seek(0);
            var readStream = stream.AsStreamForRead();
            var bytes = new byte[readStream.Length];
            await readStream.ReadAsync(bytes, 0, bytes.Length);

            return bytes;
        }

        public async Task Save(string filename, string contentType, MemoryStream stream)
        {
            if (Device.Idiom != TargetIdiom.Desktop)
            {
                var local = ApplicationData.Current.LocalFolder;
                var outFile = await local.CreateFileAsync(filename, CreationCollisionOption.ReplaceExisting);
                using (var outStream = await outFile.OpenStreamForWriteAsync()) { await outStream.WriteAsync(stream.ToArray(), 0, (int)stream.Length); }

                if (contentType != "application/html") await Windows.System.Launcher.LaunchFileAsync(outFile);
            }
            else
            {
                StorageFile storageFile = null;
                var savePicker = new FileSavePicker
                {
                    SuggestedStartLocation = PickerLocationId.Desktop,
                    SuggestedFileName = filename
                };
                switch (contentType)
                {
                    case "application/vnd.openxmlformats-officedocument.presentationml.presentation":
                        savePicker.FileTypeChoices.Add("PowerPoint Presentation", new List<string> { ".pptx" });

                        break;

                    case "application/msexcel":
                        savePicker.FileTypeChoices.Add("Excel Files", new List<string> { ".xlsx" });

                        break;

                    case "application/msword":
                        savePicker.FileTypeChoices.Add("Word Document", new List<string> { ".docx" });

                        break;

                    case "application/pdf":
                        savePicker.FileTypeChoices.Add("Adobe PDF Document", new List<string> { ".pdf" });

                        break;
                    case "application/html":
                        savePicker.FileTypeChoices.Add("HTML Files", new List<string> { ".html" });

                        break;
                }

                storageFile = await savePicker.PickSaveFileAsync();

                using (var outStream = await storageFile.OpenStreamForWriteAsync())
                {
                    await outStream.WriteAsync(stream.ToArray(), 0, (int)stream.Length);
                    await outStream.FlushAsync();
                    outStream.Dispose();
                }

                stream.Flush();
                stream.Dispose();
                await Windows.System.Launcher.LaunchFileAsync(storageFile);
            }
        }
    }

And finally, here is the ScrollView itself:

<ScrollView x:Name="MainScrollLayout" VerticalOptions="Fill" HorizontalOptions="Fill" Grid.Row="0" Grid.Column="0" BackgroundColor="#FFFFFF">
                    <StackLayout x:Name="MainStackLayout" Style="{StaticResource MainBkg}">
                        <Button x:Name="DownloadPdfBtn"  Text="Export to PDF" Clicked="DownloadPdfBtn_OnClicked" TextColor="White" BackgroundColor="DodgerBlue" VerticalOptions="Start" HorizontalOptions="Start" />

                        <Image Source="~\..\Assets\Logos\CompanyImage.png" Margin="0,60,0,10" HorizontalOptions="Center" />
                        <Label x:Name="TitlePageTitleText" Style="{StaticResource ReportViewerTitleTextMain}" Text="{StaticResource CompanyAnalysisReport}" />
                        <Label x:Name="TitlePagePreparedFor" Style="{StaticResource ReportViewerTitleTextMiddle}" Text="{StaticResource PreparedForColon}" />
                        <Label x:Name="TitlePageOrganizationName" Style="{StaticResource ReportViewerTitleTextMiddle}" />
                        <Label x:Name="TitlePageOrganizationAddress1" Style="{StaticResource ReportViewerTitleTextMiddle}" />
                        <Label x:Name="TitlePageOrganizationAddress2" Style="{StaticResource ReportViewerTitleTextMiddle}" />
                        <Label x:Name="TitlePageOrganizationCityStateZip" Style="{StaticResource ReportViewerTitleTextLast}" />

                        <Grid x:Name="ReportGrid" Style="{StaticResource ReportGridBody}">
                            <Grid.ColumnDefinitions>
                                <ColumnDefinition Width="90"/>
                                <ColumnDefinition Width="1*"/>
                                <ColumnDefinition Width="125"/>
                                <ColumnDefinition Width="Auto"/>
                                <ColumnDefinition Width="Auto"/>
                                <ColumnDefinition Width="1*"/>
                            </Grid.ColumnDefinitions>
                            <Grid.RowDefinitions>
                                <RowDefinition Height="Auto"/>
                                <!--<RowDefinition Height="Auto"/>-->
                            </Grid.RowDefinitions>
                        </Grid>

                    </StackLayout>
                </ScrollView>
Reply
Prakash Viswanathan [Syncfusion]
May 28, 2021

Hi Bryan,

Thank you for contacting Syncfusion support.

We have tried to export the entire ScrollView to image in Xamarin UWP platform. But it capture only the visible area of the screen and it does not cover the entire ScrollView. Without capturing the entire screen, we could not proceed to generate a PDF document.

Regards,

Gowthamraj K

Please sign in to access our KB

This page will automatically be redirected to the sign-in page in 10 seconds.

Up arrow icon

Warning Icon You are using an outdated version of Internet Explorer that may not display all features of this and other websites. Upgrade to Internet Explorer 8 or newer for a better experience.Close Icon

Live Chat Icon For mobile