Search Results for

    Show / Hide Table of Contents

    Class PdfPageModel

    Represents the document object model (DOM) for a single PDF page. Provides access to text, image, and path objects for content analysis and extraction.

    This class exposes the internal structure of a PDF page, allowing programmatic access to individual content elements. Use for content extraction, analysis, or understanding page composition.

    Example - Analyze page content:

    var pdf = PdfDocument.FromFile("document.pdf");
    var pageModel = pdf.Pages[0].GetPageModel();
    

    // Count content elements: Console.WriteLine($"Images: {pageModel.ImageObjects.Count}"); Console.WriteLine($"Text blocks: {pageModel.TextObjects.Count}"); Console.WriteLine($"Paths/shapes: {pageModel.PathObjects.Count}");

    // Get page dimensions: var bounds = pageModel.BoundingBox; Console.WriteLine($"Page size: {bounds.Width} x {bounds.Height} points");

    // Export to JSON: string json = pageModel.ToJson();

    Inheritance
    System.Object
    PdfClientAccessor
    PdfPageModel
    Implements
    IPdfPageObjectModel
    IronSoftware.Abstractions.Pdf.IDocumentPageObjectModel<TextObjectCollection, PathObjectCollection, ImageObjectCollection>
    IronSoftware.Abstractions.IBounded
    IronSoftware.Abstractions.IJsonSerializable
    Namespace: IronPdf.Pages
    Assembly: IronPdf.dll
    Syntax
    public class PdfPageModel : PdfClientAccessor, IPdfPageObjectModel

    PDF pages in IronPDF is handled through PdfPageModel. It represents the document object model (DOM) for a single PDF page.

    PdfPageModel matters when an application needs to configure or invoke PDF pages from C# code. The class encapsulates the related options and behavior in a single object that is set up once and reused across render or processing calls. Typical scenarios include batch generation pipelines, templated document workflows, and integration with existing C# document services.

    To use PdfPageModel, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include BoundingBox, ImageObjects, PageIndex, PathObjects. Assign options or invoke methods on the instance to configure or perform the operation. The extract text and images covers typical usage in C# end to end.

    using IronPdf;
    
    // Obtain PdfPageModel from the relevant entry point in the IronPDF API
    void Configure(PdfPageModel instance)
    {
        var current = instance.BoundingBox;
        instance.ToJson();
    }

    For the broader workflow, see the stamp text image guide in the IronPDF C# documentation. For broader context, the PDF pages portion of the IronPDF C# API contains related types that work with PdfPageModel directly. PdfPageModel instances inherit additional members from PdfClientAccessor that may be relevant in advanced scenarios. In application code, treat PdfPageModel as a configured object that is constructed once and reused across operations rather than instantiated per call. Configuration is generally idempotent: assigning the same property value twice has the same effect as assigning it once. For diagnostic purposes, inspect the relevant PdfPageModel property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of PdfPageModel. Application code typically obtains or instantiates a single PdfPageModel and shares it across multiple IronPDF operations rather than recreating it per call.

    Properties

    BoundingBox

    Declaration
    public RectangleF BoundingBox { get; set; }
    Property Value
    Type Description
    System.Drawing.RectangleF

    ImageObjects

    Gets the collection of embedded images on this page. Each image includes position, dimensions, and raw image data.

    Example - Extract all images:

    foreach (var img in pageModel.ImageObjects)
    {
        Console.WriteLine($"Image at ({img.BoundingBox.X}, {img.BoundingBox.Y})");
        Console.WriteLine($"Size: {img.BoundingBox.Width} x {img.BoundingBox.Height}");
    }

    Declaration
    public ImageObjectCollection ImageObjects { get; }
    Property Value
    Type Description
    ImageObjectCollection

    Collection of ImageObject instances on this page.

    See Also
    ExtractAllImages()

    PageIndex

    Declaration
    public uint PageIndex { get; }
    Property Value
    Type Description
    System.UInt32

    PathObjects

    Gets the collection of vector path objects (shapes, lines, curves) on this page. Includes rectangles, lines, bezier curves, and complex vector graphics.

    Example - Analyze shapes:

    foreach (var path in pageModel.PathObjects)
    {
        var box = path.BoundingBox;
        Console.WriteLine($"Shape at ({box.X}, {box.Y}), size: {box.Width} x {box.Height}");
    }

    Declaration
    public PathObjectCollection PathObjects { get; }
    Property Value
    Type Description
    PathObjectCollection

    Collection of PathObject instances representing vector graphics.

    Remarks

    Path objects include borders, lines, shapes, and decorative elements. They are defined using PDF path operators (moveto, lineto, curveto, etc.).

    TextObjects

    Gets the collection of text objects (characters, words, text runs) on this page. Provides granular access to text content with position, font, and style information.

    Example - Extract text with positions:

    foreach (var text in pageModel.TextObjects)
    {
        Console.WriteLine($"Text: '{text.Text}'");
        Console.WriteLine($"Position: ({text.BoundingBox.X}, {text.BoundingBox.Y})");
        Console.WriteLine($"Font: {text.FontName}, Size: {text.FontSize}");
    }

    Declaration
    public TextObjectCollection TextObjects { get; }
    Property Value
    Type Description
    TextObjectCollection

    Collection of TextObject instances with text content and metadata.

    Remarks

    For simpler text extraction without position data, use ExtractAllText(TextExtractionOrder) or ExtractTextFromPage(Int32).

    See Also
    ExtractAllText(TextExtractionOrder)

    Methods

    ToJson()

    Declaration
    public string ToJson()
    Returns
    Type Description
    System.String

    Implements

    IPdfPageObjectModel
    IronSoftware.Abstractions.Pdf.IDocumentPageObjectModel<, , >
    IronSoftware.Abstractions.IBounded
    IronSoftware.Abstractions.IJsonSerializable

    See Also

    PdfPage
    PdfPagesCollection
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget