Class Page

Namespace

UglyToad.PdfPig.Content

Assembly

UglyToad.PdfPig.dll

Contains the content and provides access to methods of a single page in the PdfDocument.

public class Page

Inheritance

object

Page

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

CropBox

Defines the visible region of the page, content outside the CropBox is clipped/cropped.

public CropBox CropBox { get; }

Property Value

CropBox

Dictionary

The raw PDF dictionary token for this page in the document.

public DictionaryToken Dictionary { get; }

Property Value

DictionaryToken

ExperimentalAccess

Access to members whose future locations within the API will change without warning.

public Page.Experimental ExperimentalAccess { get; }

Property Value

Page.Experimental

Height

Gets the height of the page in points.

public double Height { get; }

Property Value

double

Letters

The set of Letters drawn by the PDF content.

public IReadOnlyList<Letter> Letters { get; }

Property Value

IReadOnlyList<Letter>

MediaBox

Defines the boundaries of the physical medium on which the page shall be displayed or printed.

public MediaBox MediaBox { get; }

Property Value

MediaBox

Number

The page number (starting at 1).

public int Number { get; }

Property Value

int

NumberOfImages

The number of images on this page. Use GetImages() to access the image contents.

public int NumberOfImages { get; }

Property Value

int

Operations

The parsed graphics state operations in the content stream for this page.

public IReadOnlyList<IGraphicsStateOperation> Operations { get; }

Property Value

IReadOnlyList<IGraphicsStateOperation>

Rotation

The rotation of the page in degrees (clockwise). Valid values are 0, 90, 180 and 270.

public PageRotationDegrees Rotation { get; }

Property Value

PageRotationDegrees

Size

The size of the page according to the standard page sizes or Custom if no matching standard size found.

public PageSize Size { get; }

Property Value

PageSize

Text

The full text of all characters on the page in the order they are presented in the PDF content.

public string Text { get; }

Property Value

string

Width

Gets the width of the page in points.

public double Width { get; }

Property Value

double

Methods

GetHyperlinks()

Get the hyperlinks which link to external resources on the page. These are based on the annotations on the page with a type of '/Link'.

public IReadOnlyList<Hyperlink> GetHyperlinks()

Returns

IReadOnlyList<Hyperlink>

GetImages()

Gets any images on the page.

public IEnumerable<IPdfImage> GetImages()

Returns

IEnumerable<IPdfImage>

GetMarkedContents()

Gets any marked content on the page.

public IReadOnlyList<MarkedContentElement> GetMarkedContents()

Returns

IReadOnlyList<MarkedContentElement>

GetWords()

Use the default IWordExtractor to get the words for this page.

public IEnumerable<Word> GetWords()

Returns

IEnumerable<Word>

The words on this page.

GetWords(IWordExtractor)

Use a custom IWordExtractor to get the words for this page.

public IEnumerable<Word> GetWords(IWordExtractor wordExtractor)

Parameters

wordExtractor IWordExtractor

The word extractor to use to generate words.

Returns

IEnumerable<Word>

The words on this page.