Class PathObject

Document path object

Inheritance
System.Object
PathObject
Implements
IronSoftware.Abstractions.Pdf.IPdfDocumentObject
IronSoftware.Abstractions.IDocumentObject
IronSoftware.Abstractions.Pdf.IDocumentPathObject
IronSoftware.Abstractions.Pdf.IBoundedPdfDocumentObject
IronSoftware.Abstractions.IBounded
IronSoftware.ITransformable
IronSoftware.Abstractions.IColored
System.ICloneable
IronSoftware.Abstractions.Relative.IDocumentLayoutFriendly
IronSoftware.Abstractions.IJsonSerializable
Namespace: IronSoftware
Assembly: IronPdf.dll
Syntax
public class PathObject : Object, IPdfPathObject, IPdfDocumentObject

PathObject is what IronPDF C# code uses for Iron Software API. It represents document path object.

PathObject matters when an application needs to configure or invoke Iron Software API 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 PathObject, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include AnchorOrigin, AnchorStyle, BoundingBox, Client. Assign options or invoke methods on the instance to configure or perform the operation.

using IronPdf;

// Obtain PathObject from the relevant entry point in the IronPDF API
void Configure(PathObject instance)
{
    var current = instance.AnchorOrigin;
    instance.Clone();
}

For the broader workflow, see the IronPDF C# documentation for related how-to guides and examples. For broader context, the Iron Software API portion of the IronPDF C# API contains related types that work with PathObject directly. PathObject exposes additional members beyond those highlighted above; the reference tables on this page list the full set. In application code, treat PathObject 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 PathObject property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of PathObject. Application code typically obtains or instantiates a single PathObject and shares it across multiple IronPDF operations rather than recreating it per call. For multi-threaded scenarios, follow the threading guidance for the relevant IronPDF entry point; PathObject instances are not assumed to be thread-safe unless documented.

Fields

_FillColor

Declaration
protected Color _FillColor
Field Value
Type Description
System.Drawing.Color

_FillMode

Declaration
protected PathFillModes _FillMode
Field Value
Type Description
IronSoftware.Abstractions.PathFillModes

_IsStroked

Declaration
protected bool _IsStroked
Field Value
Type Description
System.Boolean

_Points

Declaration
protected IReadOnlyCollection<IPdfPathSegment> _Points
Field Value
Type Description
System.Collections.Generic.IReadOnlyCollection<IronSoftware.Abstractions.Pdf.IPdfPathSegment>

_Rotation

Declaration
protected double _Rotation
Field Value
Type Description
System.Double

_Scale

Declaration
protected PointF _Scale
Field Value
Type Description
System.Drawing.PointF

_StrokeColor

Declaration
protected Color _StrokeColor
Field Value
Type Description
System.Drawing.Color

_Translate

Declaration
protected PointF _Translate
Field Value
Type Description
System.Drawing.PointF

Properties

AnchorOrigin

Declaration
public LayoutAnchorOrigins AnchorOrigin { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.Relative.LayoutAnchorOrigins

AnchorStyle

Declaration
public LayoutAnchorStyles AnchorStyle { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.Relative.LayoutAnchorStyles

BoundingBox

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

Client

Pdf client

Declaration
public IPdfClient Client { get; set; }
Property Value
Type Description
IronSoftware.Pdfium.IPdfClient

DashPattern

PDF d operator dash array, alternating dash/gap lengths in user-space units. Empty list = solid line.

Declaration
public IReadOnlyList<float> DashPattern { get; set; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.Single>

DashPhase

Dash-array phase offset (PDF d operator second argument).

Declaration
public float DashPhase { get; set; }
Property Value
Type Description
System.Single

DocumentId

Declaration
public IDocumentId DocumentId { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.Pdf.IDocumentId

FillColor

Declaration
public Color FillColor { get; set; }
Property Value
Type Description
System.Drawing.Color

FillColorValue

Declaration
public int FillColorValue { get; set; }
Property Value
Type Description
System.Int32

FillMode

Declaration
public PathFillModes FillMode { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.PathFillModes

IsStroked

Declaration
public bool IsStroked { get; set; }
Property Value
Type Description
System.Boolean

LineCap

Line-cap style (PDF J operator). Default Butt.

Declaration
public LineCaps LineCap { get; set; }
Property Value
Type Description
LineCaps

LineJoin

Line-join style (PDF j operator). Default Miter.

Declaration
public LineJoins LineJoin { get; set; }
Property Value
Type Description
LineJoins

Matrix

Declaration
public MatrixStruct Matrix { get; }
Property Value
Type Description
IronSoftware.MatrixStruct

ObjNum

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

OcgId

Identifier of the Optional Content Group (PDF layer) that this path object belongs to. -1 means the object is not in any layer and will always render. Resolve to a PdfLayer via PdfClient.GetOcgs(DocumentId) or the convenience GetLayer() method below.

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

PageIndex

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

Points

Declaration
public IReadOnlyCollection<IPdfPathSegment> Points { get; set; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<IronSoftware.Abstractions.Pdf.IPdfPathSegment>

Rotation

Declaration
public double Rotation { get; set; }
Property Value
Type Description
System.Double

Scale

Declaration
public PointF Scale { get; set; }
Property Value
Type Description
System.Drawing.PointF

StrokeColor

Declaration
public Color StrokeColor { get; set; }
Property Value
Type Description
System.Drawing.Color

StrokeColorValue

Declaration
public int StrokeColorValue { get; set; }
Property Value
Type Description
System.Int32

StrokeWidth

Stroke width in user-space units (PDF w operator). Default 1.0. Used by CAD / engineering consumers to distinguish features when /OCProperties is absent.

Declaration
public float StrokeWidth { get; set; }
Property Value
Type Description
System.Single

Translate

Declaration
public PointF Translate { get; set; }
Property Value
Type Description
System.Drawing.PointF

ZOrder

Declaration
public RelativeZOrder ZOrder { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.RelativeZOrder

ZPosition

Declaration
public long ZPosition { get; set; }
Property Value
Type Description
System.Int64

Methods

Clone()

Declaration
public object Clone()
Returns
Type Description
System.Object

GetLayer()

Resolve OcgId against the owning document's layer list and return the matching PdfLayer. Returns null when the object is not in any layer (OcgId == -1) or when the document has no /OCProperties.

Declaration
public PdfLayer GetLayer()
Returns
Type Description
PdfLayer

ToJson()

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

Implements

IronSoftware.Abstractions.Pdf.IPdfDocumentObject
IronSoftware.Abstractions.IDocumentObject
IronSoftware.Abstractions.Pdf.IDocumentPathObject
IronSoftware.Abstractions.Pdf.IBoundedPdfDocumentObject
IronSoftware.Abstractions.IBounded
IronSoftware.ITransformable
IronSoftware.Abstractions.IColored
System.ICloneable
IronSoftware.Abstractions.Relative.IDocumentLayoutFriendly
IronSoftware.Abstractions.IJsonSerializable