Class BmpDevice

BmpDevice class

Represents image device that helps to save pdf document pages into bmp.

public sealed class BmpDevice : ImageDevice

Constructors

NameDescription
BmpDevice()Initializes a new instance of the BmpDevice class with default resolution.
BmpDevice(PageSize)Initializes a new instance of the BmpDevice class with provided page size, default resolution (=150).
BmpDevice(Resolution)Initializes a new instance of the BmpDevice class. Resolution for the result image file, see Resolution class.
BmpDevice(int, int)Initializes a new instance of the BmpDevice class with provided image dimensions, default resolution (=150).
BmpDevice(PageSize, Resolution)Initializes a new instance of the BmpDevice class with provided page size and resolution.
BmpDevice(int, int, Resolution)Initializes a new instance of the BmpDevice class with provided image dimensions and resolution.

Properties

NameDescription
CoordinateType { get; set; }Gets or sets the page coordinate type (Media/Crop boxes). CropBox value is used by default.
FormPresentationMode { get; set; }Gets or sets form presentation mode.
Height { get; }Gets image output height.
RenderingOptions { get; set; }Gets or sets rendering options.
Resolution { get; }Gets image resolution.
Width { get; }Gets image output width.

Methods

NameDescription
override Process(Page, Stream)Converts the page into bmp and saves it in the output stream.
Process(Page, string)Perfoms some operation on the given page and saves results into the file.

Examples

The following example shows how to convert PDF file to BMP Images.

[C#]
	// The path to your PDF Directory
	string dataDir = @"YOUR_DATA_DIRECTORY";

	// The file name of the PDF
	string pdfFile = @"YOUR_PDF_FILE";

	// initialize instance of Document class
	using (Document pdfDocument = new Document(Path.Combine(dataDir, pdfFile)))
	{
		// Create Resolution object 	
		Resolution resolution = new Resolution(300);

		// initialize BmpDevice	
		BmpDevice bmpDevice = new BmpDevice(resolution);

		for (int pageCount = 1; pageCount <= pdfDocument.Pages.Count; pageCount++)
		{
			using (FileStream bmpStream =
			new FileStream($"{dataDir}image{pageCount}_out.bmp",
			FileMode.Create))
			{
				// Convert a particular page and save the image to stream
				bmpDevice.Process(pdfDocument.Pages[pageCount], bmpStream);

				// Close stream
				bmpStream.Close();
			}
		}
	}
[VB.NET]

    ' The path to your PDF Directory
    Dim dataDir As String = "YOUR_DATA_DIRECTORY"
    
	' The file name of the PDF
    Dim pdfFile As String = "YOUR_PDF_FILE"
 
    ' Initialize instance of Document class 
	Using pdfDocument As Document = New Document(Path.Combine(dataDir, pdfFile))
		' Create Resolution object  
		Dim resolution As Resolution = New Resolution(300)
		
		' Initialize BmpDevice  
		Dim bmpDevice As BmpDevice = New BmpDevice(resolution)
		
		For pageCount As Integer = 1 To pdfDocument.Pages.Count
			Using bmpStream As FileStream = New FileStream($"{dataDir}image{pageCount}_out.bmp", FileMode.Create)
				
				' Convert a particular page and save the image to stream
				bmpDevice.Process(pdfDocument.Pages(pageCount), bmpStream)

				' Close stream
				bmpStream.Close()
			End Using
		Next
	End Using

See Also