Provides functionality to render a PDF document. More...

Inheritance diagram for PdfiumViewer.PdfDocument:

Public Member Functions
void	Render (int page, Graphics graphics, float dpiX, float dpiY, Rectangle bounds, bool forPrinting)
	Renders a page of the PDF document to the provided graphics instance. More...

void	Render (int page, Graphics graphics, float dpiX, float dpiY, Rectangle bounds, PdfRenderFlags flags)
	Renders a page of the PDF document to the provided graphics instance. More...

Image	Render (int page, float dpiX, float dpiY, bool forPrinting)
	Renders a page of the PDF document to an image. More...

Image	Render (int page, float dpiX, float dpiY, PdfRenderFlags flags)
	Renders a page of the PDF document to an image. More...

Image	Render (int page, int width, int height, float dpiX, float dpiY, bool forPrinting)
	Renders a page of the PDF document to an image. More...

Image	Render (int page, int width, int height, float dpiX, float dpiY, PdfRenderFlags flags)
	Renders a page of the PDF document to an image. More...

Image	Render (int page, int width, int height, float dpiX, float dpiY, PdfRotation rotate, PdfRenderFlags flags)
	Renders a page of the PDF document to an image. More...

void	Save (string path)
	Save the PDF document to the specified location. More...

void	Save (Stream stream)
	Save the PDF document to the specified location. More...

PdfMatches	Search (string text, bool matchCase, bool wholeWord)
	Finds all occurences of text. More...

PdfMatches	Search (string text, bool matchCase, bool wholeWord, int page)
	Finds all occurences of text. More...

PdfMatches	Search (string text, bool matchCase, bool wholeWord, int startPage, int endPage)
	Finds all occurences of text. More...

string	GetPdfText (int page)
	Get all text on the page. More...

IEnumerable< PdfTextAndRect >	GetPdfTextAndRects (int page)
	Get all text and corresponding bounding box on the page. More...

string	GetBoundedText (int page, RectangleF rect)
	Get all text which touches hit box. More...

string	GetPdfText (PdfTextSpan textSpan)
	Get all text matching the text span. More...

IList< PdfRectangle >	GetTextBounds (PdfTextSpan textSpan)
	Get all bounding rectangles for the text span. More...

PointF	PointToPdf (int page, Point point)
	Convert a point from device coordinates to page coordinates. More...

Point	PointFromPdf (int page, PointF point)
	Convert a point from page coordinates to device coordinates. More...

RectangleF	RectangleToPdf (int page, Rectangle rect)
	Convert a rectangle from device coordinates to page coordinates. More...

Rectangle	RectangleFromPdf (int page, RectangleF rect)
	Convert a rectangle from page coordinates to device coordinates. More...

PrintDocument	CreatePrintDocument ()
	Creates a PrintDocument for the PDF document. More...

PrintDocument	CreatePrintDocument (PdfPrintMode printMode)
	Creates a PrintDocument for the PDF document. More...

PrintDocument	CreatePrintDocument (PdfPrintSettings settings)
	Creates a PrintDocument for the PDF document. More...

PdfPageLinks	GetPageLinks (int page, Size size)
	Returns all links on the PDF page. More...

void	DeletePage (int page)
	Delete the page from the PDF document. More...

void	RotatePage (int page, PdfRotation rotation)
	Set rotation of the page. More...

PdfRotation	GetPageRotation (int page)
	Get rotation of the page. More...

void	ImportPages (PdfDocument source, string pageRange, int startDestIndex)
	Import pages from source document. More...

void	CopyPages (string pageRange, int startDestIndex)
	Copy pages within this document. More...

PdfInformation	GetInformation ()
	Get metadata information from the PDF document. More...

void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

Static Public Member Functions
static PdfDocument	Load (string path)
	Initializes a new instance of the PdfDocument class with the provided path. More...

static PdfDocument	Load (string path, string password)
	Initializes a new instance of the PdfDocument class with the provided path. More...

static PdfDocument	Load (IWin32Window owner, string path)
	Initializes a new instance of the PdfDocument class with the provided path. More...

static PdfDocument	Load (IWin32Window owner, Stream stream)
	Initializes a new instance of the PdfDocument class with the provided path. More...

static PdfDocument	Load (Stream stream)
	Initializes a new instance of the PdfDocument class with the provided stream. More...

static PdfDocument	Load (Stream stream, string password)
	Initializes a new instance of the PdfDocument class with the provided stream. More...

static PdfDocument	Compose (PdfDocument source, string pageRange)
	Compose new document from existing document and page ranges. More...

Protected Member Functions
void	Dispose (bool disposing)
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

Properties
int	PageCount `[get]`
	Number of pages in the PDF document. More...

PdfBookmarkCollection	Bookmarks `[get]`
	Bookmarks stored in this PdfFile More...

IList< SizeF >	PageSizes `[get]`
	Size of each page in the PDF document. More...

Properties inherited from PdfiumViewer.IPdfDocument
int	PageCount `[get]`
	Number of pages in the PDF document. More...

PdfBookmarkCollection	Bookmarks `[get]`
	Bookmarks stored in this PdfFile More...

IList< SizeF >	PageSizes `[get]`
	Size of each page in the PDF document. More...

Detailed Description

Provides functionality to render a PDF document.

Member Function Documentation

◆ Compose()

static PdfDocument PdfiumViewer.PdfDocument.Compose	(	PdfDocument	source,
		string	pageRange
	)

static

Compose new document from existing document and page ranges.

Parameters

source	The source document
pageRange	`1,2-3` and so on, or null for entire

Returns: New document

◆ CopyPages()

void PdfiumViewer.PdfDocument.CopyPages	(	string	pageRange,
		int	startDestIndex
	)

Copy pages within this document.

Parameters

pageRange	`1,2-3` and so on, or null for entire
startDestIndex	The destination page index

◆ CreatePrintDocument() [1/3]

PrintDocument PdfiumViewer.PdfDocument.CreatePrintDocument ( )

Creates a PrintDocument for the PDF document.

Returns

Implements PdfiumViewer.IPdfDocument.

◆ CreatePrintDocument() [2/3]

PrintDocument PdfiumViewer.PdfDocument.CreatePrintDocument ( PdfPrintMode printMode )

Creates a PrintDocument for the PDF document.

Parameters

printMode Specifies the mode for printing. The default value for this parameter is CutMargin.

Returns

Implements PdfiumViewer.IPdfDocument.

◆ CreatePrintDocument() [3/3]

PrintDocument PdfiumViewer.PdfDocument.CreatePrintDocument ( PdfPrintSettings settings )

Creates a PrintDocument for the PDF document.

Parameters

settings The settings used to configure the print document.

Returns

Implements PdfiumViewer.IPdfDocument.

◆ DeletePage()

void PdfiumViewer.PdfDocument.DeletePage ( int page )

Delete the page from the PDF document.

Parameters

page	The page to delete.

Implements PdfiumViewer.IPdfDocument.

◆ Dispose() [1/2]

void PdfiumViewer.PdfDocument.Dispose ( )

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

◆ Dispose() [2/2]

void PdfiumViewer.PdfDocument.Dispose ( bool disposing )

protected

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Parameters

disposing Whether this method is called from Dispose.

◆ GetBoundedText()

string PdfiumViewer.PdfDocument.GetBoundedText	(	int	page,
		RectangleF	rect
	)

Get all text which touches hit box.

Parameters

page	The page to get the text for.
rect	The hit box

Returns: The text.

◆ GetInformation()

PdfInformation PdfiumViewer.PdfDocument.GetInformation ( )

Get metadata information from the PDF document.

Returns: The PDF metadata.

Implements PdfiumViewer.IPdfDocument.

◆ GetPageLinks()

PdfPageLinks PdfiumViewer.PdfDocument.GetPageLinks	(	int	page,
		Size	size
	)

Returns all links on the PDF page.

Parameters

page	The page to get the links for.
size	The size of the page.

Returns: A collection with the links on the page.

Implements PdfiumViewer.IPdfDocument.

◆ GetPageRotation()

PdfRotation PdfiumViewer.PdfDocument.GetPageRotation ( int page )

Get rotation of the page.

Parameters

page	The page index

Returns: The page rotation

◆ GetPdfText() [1/2]

string PdfiumViewer.PdfDocument.GetPdfText ( int page )

Get all text on the page.

Parameters

page	The page to get the text for.

Returns: The text on the page.

Implements PdfiumViewer.IPdfDocument.

◆ GetPdfText() [2/2]

string PdfiumViewer.PdfDocument.GetPdfText ( PdfTextSpan textSpan )

Get all text matching the text span.

Parameters

textSpan The span to get the text for.

Returns: The text matching the span.

Implements PdfiumViewer.IPdfDocument.

◆ GetPdfTextAndRects()

IEnumerable<PdfTextAndRect> PdfiumViewer.PdfDocument.GetPdfTextAndRects ( int page )

Get all text and corresponding bounding box on the page.

Parameters

page	The page to get the text for.

Returns: The text and rect on the page.

◆ GetTextBounds()

IList<PdfRectangle> PdfiumViewer.PdfDocument.GetTextBounds ( PdfTextSpan textSpan )

Get all bounding rectangles for the text span.

The algorithm used to get the bounding rectangles tries to join adjacent character bounds into larger rectangles.

Parameters

textSpan The span to get the bounding rectangles for.

Returns: The bounding rectangles.

Implements PdfiumViewer.IPdfDocument.

◆ ImportPages()

void PdfiumViewer.PdfDocument.ImportPages	(	PdfDocument	source,
		string	pageRange,
		int	startDestIndex
	)

Import pages from source document.

Parameters

source	The source document
pageRange	`1,2-3` and so on, or null for entire
startDestIndex	The destination page index

◆ Load() [1/6]

static PdfDocument PdfiumViewer.PdfDocument.Load	(	IWin32Window	owner,
		Stream	stream
	)

static

Initializes a new instance of the PdfDocument class with the provided path.

Parameters

owner	Window to show any UI for.
stream	Stream for the PDF document.

◆ Load() [2/6]

static PdfDocument PdfiumViewer.PdfDocument.Load	(	IWin32Window	owner,
		string	path
	)

static

Initializes a new instance of the PdfDocument class with the provided path.

Parameters

owner	Window to show any UI for.
path	Path to the PDF document.

◆ Load() [3/6]

static PdfDocument PdfiumViewer.PdfDocument.Load ( Stream stream )

static

Initializes a new instance of the PdfDocument class with the provided stream.

Parameters

stream Stream for the PDF document.

◆ Load() [4/6]

static PdfDocument PdfiumViewer.PdfDocument.Load	(	Stream	stream,
		string	password
	)

static

Initializes a new instance of the PdfDocument class with the provided stream.

Parameters

stream	Stream for the PDF document.
password	Password for the PDF document.

◆ Load() [5/6]

static PdfDocument PdfiumViewer.PdfDocument.Load ( string path )

static

Initializes a new instance of the PdfDocument class with the provided path.

Parameters

path	Path to the PDF document.

◆ Load() [6/6]

static PdfDocument PdfiumViewer.PdfDocument.Load	(	string	path,
		string	password
	)

static

Initializes a new instance of the PdfDocument class with the provided path.

Parameters

path	Path to the PDF document.
password	Password for the PDF document.

◆ PointFromPdf()

Point PdfiumViewer.PdfDocument.PointFromPdf	(	int	page,
		PointF	point
	)

Convert a point from page coordinates to device coordinates.

Parameters

page	The page number where the point is from.
point	The point to convert.

Returns: The converted point.

Implements PdfiumViewer.IPdfDocument.

◆ PointToPdf()

PointF PdfiumViewer.PdfDocument.PointToPdf	(	int	page,
		Point	point
	)

Convert a point from device coordinates to page coordinates.

Parameters

page	The page number where the point is from.
point	The point to convert.

Returns: The converted point.

Implements PdfiumViewer.IPdfDocument.

◆ RectangleFromPdf()

Rectangle PdfiumViewer.PdfDocument.RectangleFromPdf	(	int	page,
		RectangleF	rect
	)

Convert a rectangle from page coordinates to device coordinates.

Parameters

page	The page where the rectangle is from.
rect	The rectangle to convert.

Returns: The converted rectangle.

Implements PdfiumViewer.IPdfDocument.

◆ RectangleToPdf()

RectangleF PdfiumViewer.PdfDocument.RectangleToPdf	(	int	page,
		Rectangle	rect
	)

Convert a rectangle from device coordinates to page coordinates.

Parameters

page	The page where the rectangle is from.
rect	The rectangle to convert.

Returns: The converted rectangle.

Implements PdfiumViewer.IPdfDocument.

◆ Render() [1/7]

Image PdfiumViewer.PdfDocument.Render	(	int	page,
		float	dpiX,
		float	dpiY,
		bool	forPrinting
	)

Renders a page of the PDF document to an image.

Parameters

page	Number of the page to render.
dpiX	Horizontal DPI.
dpiY	Vertical DPI.
forPrinting	Render the page for printing.

Returns: The rendered image.

Implements PdfiumViewer.IPdfDocument.

◆ Render() [2/7]

Image PdfiumViewer.PdfDocument.Render	(	int	page,
		float	dpiX,
		float	dpiY,
		PdfRenderFlags	flags
	)

Renders a page of the PDF document to an image.

Parameters

page	Number of the page to render.
dpiX	Horizontal DPI.
dpiY	Vertical DPI.
flags	Flags used to influence the rendering.

Returns: The rendered image.

Implements PdfiumViewer.IPdfDocument.

◆ Render() [3/7]

void PdfiumViewer.PdfDocument.Render	(	int	page,
		Graphics	graphics,
		float	dpiX,
		float	dpiY,
		Rectangle	bounds,
		bool	forPrinting
	)

Renders a page of the PDF document to the provided graphics instance.

Parameters

page	Number of the page to render.
graphics	Graphics instance to render the page on.
dpiX	Horizontal DPI.
dpiY	Vertical DPI.
bounds	Bounds to render the page in.
forPrinting	Render the page for printing.

Implements PdfiumViewer.IPdfDocument.

◆ Render() [4/7]

void PdfiumViewer.PdfDocument.Render	(	int	page,
		Graphics	graphics,
		float	dpiX,
		float	dpiY,
		Rectangle	bounds,
		PdfRenderFlags	flags
	)

Renders a page of the PDF document to the provided graphics instance.

Parameters

page	Number of the page to render.
graphics	Graphics instance to render the page on.
dpiX	Horizontal DPI.
dpiY	Vertical DPI.
bounds	Bounds to render the page in.
flags	Flags used to influence the rendering.

Implements PdfiumViewer.IPdfDocument.

◆ Render() [5/7]

Image PdfiumViewer.PdfDocument.Render	(	int	page,
		int	width,
		int	height,
		float	dpiX,
		float	dpiY,
		bool	forPrinting
	)

Renders a page of the PDF document to an image.

Parameters

page	Number of the page to render.
width	Width of the rendered image.
height	Height of the rendered image.
dpiX	Horizontal DPI.
dpiY	Vertical DPI.
forPrinting	Render the page for printing.

Returns: The rendered image.

Implements PdfiumViewer.IPdfDocument.

◆ Render() [6/7]

Image PdfiumViewer.PdfDocument.Render	(	int	page,
		int	width,
		int	height,
		float	dpiX,
		float	dpiY,
		PdfRenderFlags	flags
	)

Renders a page of the PDF document to an image.

Parameters

page	Number of the page to render.
width	Width of the rendered image.
height	Height of the rendered image.
dpiX	Horizontal DPI.
dpiY	Vertical DPI.
flags	Flags used to influence the rendering.

Returns: The rendered image.

Implements PdfiumViewer.IPdfDocument.

◆ Render() [7/7]

Image PdfiumViewer.PdfDocument.Render	(	int	page,
		int	width,
		int	height,
		float	dpiX,
		float	dpiY,
		PdfRotation	rotate,
		PdfRenderFlags	flags
	)

Renders a page of the PDF document to an image.

Parameters

page	Number of the page to render.
width	Width of the rendered image.
height	Height of the rendered image.
dpiX	Horizontal DPI.
dpiY	Vertical DPI.
rotate	Rotation.
flags	Flags used to influence the rendering.

Returns: The rendered image.

Implements PdfiumViewer.IPdfDocument.

◆ RotatePage()

void PdfiumViewer.PdfDocument.RotatePage	(	int	page,
		PdfRotation	rotation
	)

Set rotation of the page.

Parameters

page	The page to rotate.
rotation	The page rotation.

Implements PdfiumViewer.IPdfDocument.

◆ Save() [1/2]

void PdfiumViewer.PdfDocument.Save ( Stream stream )

Save the PDF document to the specified location.

Parameters

stream Stream to save the PDF document to.

Implements PdfiumViewer.IPdfDocument.

◆ Save() [2/2]

void PdfiumViewer.PdfDocument.Save ( string path )

Save the PDF document to the specified location.

Parameters

path	Path to save the PDF document to.

Implements PdfiumViewer.IPdfDocument.

◆ Search() [1/3]

PdfMatches PdfiumViewer.PdfDocument.Search	(	string	text,
		bool	matchCase,
		bool	wholeWord
	)

Finds all occurences of text.

Parameters

text	The text to search for.
matchCase	Whether to match case.
wholeWord	Whether to match whole words only.

Returns: All matches.

Implements PdfiumViewer.IPdfDocument.

◆ Search() [2/3]

PdfMatches PdfiumViewer.PdfDocument.Search	(	string	text,
		bool	matchCase,
		bool	wholeWord,
		int	page
	)

Finds all occurences of text.

Parameters

text	The text to search for.
matchCase	Whether to match case.
wholeWord	Whether to match whole words only.
page	The page to search on.

Returns: All matches.

Implements PdfiumViewer.IPdfDocument.

◆ Search() [3/3]

PdfMatches PdfiumViewer.PdfDocument.Search	(	string	text,
		bool	matchCase,
		bool	wholeWord,
		int	startPage,
		int	endPage
	)

Finds all occurences of text.

Parameters

text	The text to search for.
matchCase	Whether to match case.
wholeWord	Whether to match whole words only.
startPage	The page to start searching.
endPage	The page to end searching.

Returns: All matches.

Implements PdfiumViewer.IPdfDocument.

Property Documentation

◆ Bookmarks

PdfBookmarkCollection PdfiumViewer.PdfDocument.Bookmarks

get

Bookmarks stored in this PdfFile

◆ PageCount

int PdfiumViewer.PdfDocument.PageCount

get

Number of pages in the PDF document.

◆ PageSizes

IList<SizeF> PdfiumViewer.PdfDocument.PageSizes

get

Size of each page in the PDF document.

The documentation for this class was generated from the following file:

PdfiumViewer/PdfDocument.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Compose()

◆ CopyPages()

◆ CreatePrintDocument() [1/3]

◆ CreatePrintDocument() [2/3]

◆ CreatePrintDocument() [3/3]

◆ DeletePage()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ GetBoundedText()

◆ GetInformation()

◆ GetPageLinks()

◆ GetPageRotation()

◆ GetPdfText() [1/2]

◆ GetPdfText() [2/2]

◆ GetPdfTextAndRects()

◆ GetTextBounds()

◆ ImportPages()

◆ Load() [1/6]

◆ Load() [2/6]

◆ Load() [3/6]

◆ Load() [4/6]

◆ Load() [5/6]

◆ Load() [6/6]

◆ PointFromPdf()

◆ PointToPdf()

◆ RectangleFromPdf()

◆ RectangleToPdf()

◆ Render() [1/7]

◆ Render() [2/7]

◆ Render() [3/7]

◆ Render() [4/7]

◆ Render() [5/7]

◆ Render() [6/7]

◆ Render() [7/7]

◆ RotatePage()

◆ Save() [1/2]

◆ Save() [2/2]

◆ Search() [1/3]

◆ Search() [2/3]

◆ Search() [3/3]

Property Documentation

◆ Bookmarks

◆ PageCount

◆ PageSizes