Search Results for

    Show / Hide Table of Contents

    Interface IPdfTextObject

    Text object from a PDF document

    Inherited Members
    IPdfDocumentObject.Client
    Namespace: IronSoftware
    Assembly: IronPdf.dll
    Syntax
    public interface IPdfTextObject : IPdfDocumentObject

    Use IPdfTextObject in IronPDF when C# code works with Iron Software API across implementors. It represents text object from a PDF document, so code can work with Iron Software API uniformly across implementors rather than binding to a concrete type.

    Concrete implementors include LineTextObject, TextObject. Code that accepts IPdfTextObject works uniformly across these implementors, so applications can read or configure C# PDF features without binding to a specific concrete type.

    Most of the usable surface is inherited. The members that carry everyday use of this contract are Client, the IPdfTextObject contract members; consult these first when implementing or consuming IPdfTextObject. The draw text and bitmap walks through typical use in the IronPDF C# documentation.

    using IronPdf;
    
    // IPdfTextObject is consumed as the API surface for the family of implementors
    void Consume(IPdfTextObject target)
    {
        // Use members defined on the interface; concrete behavior follows the implementor
    }

    For collection-wide operations and end-to-end examples, see the IronPDF C# documentation for related guides. For collection-wide operations on IPdfTextObject instances, the IronPDF C# documentation lists the relevant container types and their methods. Concrete behavior depends on which implementor of IPdfTextObject is returned at runtime; consult the specific class reference for type-specific members. Polymorphic access through IPdfTextObject lets code work uniformly across the family of implementors, with a cast required only when type-specific behavior is needed. The reference tables below list the full set of members defined on IPdfTextObject along with any inherited members exposed through the contract. In a typical IronPDF C# workflow, IPdfTextObject appears as a parameter or return type at the boundary between the application and the IronPDF API. See the methods table below for the complete set of members defined directly on IPdfTextObject. Implementing IPdfTextObject directly in application code is uncommon; the typical pattern is to consume instances returned from the IronPDF API.

    Properties

    OcgId

    Identifier of the Optional Content Group (PDF layer) that owns this text object. -1 means the object is not inside any OCG (i.e. it always renders). Resolve to a PdfLayer by looking the id up against PdfClient.GetOcgs(DocumentId) or via the TextObject.GetLayer() convenience helper.

    Declaration
    int OcgId { get; }
    Property Value
    Type Description
    System.Int32

    Inherited members

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