PdfDocumentProcessor.GetImages(PdfDocumentArea) Method

Retrieves the images found within the specified document area.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public IList<Bitmap> GetImages(
    PdfDocumentArea area
)

VB.NET

Public Function GetImages(
    area As PdfDocumentArea
) As IList(Of Bitmap)

Parameters

Name	Type	Description
area	PdfDocumentArea	A PdfDocumentArea object.

Returns

Type	Description
IList<Bitmap>	A collection of Bitmap objects.

Remarks

The overloaded GetImages method uses the page coordinate system. See the following topic for more information: Coordinate Systems.

The GetImages method requires that your application runs under Full Trust.

Warning

The GetImages method uses GDI/GDI+ rendering and works only on Windows OS. The PlatformNotSupportedException is thrown on other operating systems. Use the GetDXImages method in non-Windows environments.

Example

This example illustrates the use of the PdfDocumentProcessor.GetImages method to obtain images from a PDF file.

View Example

Program.cs

using System;
using System.Collections.Generic;
using System.Drawing;
using DevExpress.Pdf;
// ...
static void Main(string[] args) {
    PdfDocumentProcessor processor = new PdfDocumentProcessor();
    processor.LoadDocument(@"..\\..\\Demo.pdf");

    int xCount = 8; 
    int yCount = 2;
    double cardWidth = 150.5; // Measured in points (equals 2.09 inches).
    double cardHeight = 442; // Measured in points (equals 6.138 inches).
    double xMargin = 122; // Measured in points (equals 1.694 inches).
    double yMargin = 77; // Measured in points (equals 1.069 inches).
    double yCoord = yMargin;

    for (int y = 0; y < yCount; y++, yCoord += cardHeight) {
        double xCoord = xMargin;
        for (int x = 0; x < xCount; x++, xCoord += cardWidth) {
            PdfDocumentArea area = new PdfDocumentArea(1,
                new PdfRectangle(xCoord, yCoord, xCoord + cardWidth, yCoord + cardHeight));
            IList<Bitmap> bitmaps = processor.GetImages(area);
            if (bitmaps.Count != 0) {
                bitmaps[0].Save(String.Format(@"{0}_{1}.bmp", x, y));
                bitmaps[0].Dispose();
            }
            Console.WriteLine(bitmaps.Count.ToString());
        }
    }
}

Program.vb

Imports System
Imports System.Collections.Generic
Imports System.Drawing
Imports DevExpress.Pdf
' ...
Shared Sub Main(ByVal args() As String)
    Dim processor As New PdfDocumentProcessor()
    processor.LoadDocument("..\\..\\Demo.pdf")

    Dim xCount As Integer = 8
    Dim yCount As Integer = 2
    Dim cardWidth As Double = 150.5 ' Measured in points (equals 2.09 inches).
    Dim cardHeight As Double = 442 ' Measured in points (equals 6.138 inches).
    Dim xMargin As Double = 122 ' Measured in points (equals 1.694 inches).
    Dim yMargin As Double = 77 ' Measured in points (equals 1.069 inches).
    Dim yCoord As Double = yMargin

    Dim y As Integer = 0
    Do While y < yCount
        Dim xCoord As Double = xMargin
        Dim x As Integer = 0
        Do While x < xCount
            Dim area As New PdfDocumentArea(1, New PdfRectangle(xCoord, yCoord, xCoord + cardWidth, yCoord + cardHeight))
            Dim bitmaps As IList(Of Bitmap) = processor.GetImages(area)
            If bitmaps.Count <> 0 Then
                bitmaps(0).Save(String.Format("{0}_{1}.bmp", x, y))
                bitmaps(0).Dispose()
            End If
            Console.WriteLine(bitmaps.Count.ToString())
            x += 1
            xCoord += cardWidth
        Loop
        y += 1
        yCoord += cardHeight
    Loop
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetImages(PdfDocumentArea) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

pdf-document-api-extract-images-from-document/CS/PdfProcessorGetImages/Program.cs#L29

    new PdfRectangle(xCoord, yCoord, xCoord + cardWidth, yCoord + cardHeight));
IList<Bitmap> bitmaps = processor.GetImages(area);
if (bitmaps.Count != 0) {

VB.NET

pdf-document-api-extract-images-from-document/VB/PdfProcessorGetImages/Program.vb#L30

Dim area As PdfDocumentArea = New PdfDocumentArea(1, New PdfRectangle(xCoord, yCoord, xCoord + cardWidth, yCoord + cardHeight))
Dim bitmaps As IList(Of Bitmap) = processor.GetImages(area)
If bitmaps.Count <> 0 Then