Interface IPdfPathObject
Path object from a PDF document
Inherited Members
Namespace: IronSoftware
Assembly: IronPdf.dll
Syntax
public interface IPdfPathObject : IPdfDocumentObject
Use IPdfPathObject in IronPDF when C# code works with Iron Software API across implementors. It represents path 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 PathObject, IronPDF concrete implementor. Code that accepts IPdfPathObject 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 IPdfPathObject contract members; consult these first when implementing or consuming IPdfPathObject.
using IronPdf;
// IPdfPathObject is consumed as the API surface for the family of implementors
void Consume(IPdfPathObject 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 IPdfPathObject instances, the IronPDF C# documentation lists the relevant container types and their methods. Concrete behavior depends on which implementor of IPdfPathObject is returned at runtime; consult the specific class reference for type-specific members. Polymorphic access through IPdfPathObject 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 IPdfPathObject along with any inherited members exposed through the contract. In a typical IronPDF C# workflow, IPdfPathObject 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 IPdfPathObject. Implementing IPdfPathObject directly in application code is uncommon; the typical pattern is to consume instances returned from the IronPDF API. When iterating over a collection of IPdfPathObject instances, prefer the inherited members for portable code; downcast only when type-specific behavior is required.
Properties
DashPattern
PDF d operator dash array, alternating dash/gap lengths in
user-space units. Empty list = solid line.
Declaration
IReadOnlyList<float> DashPattern { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IReadOnlyList<System.Single> |
DashPhase
Dash-array phase offset (PDF d operator second argument).
Declaration
float DashPhase { get; }
Property Value
| Type | Description |
|---|---|
| System.Single |
LineCap
Line-cap style (PDF J operator). Default Butt.
Declaration
LineCaps LineCap { get; }
Property Value
| Type | Description |
|---|---|
| LineCaps |
LineJoin
Line-join style (PDF j operator). Default Miter.
Declaration
LineJoins LineJoin { get; }
Property Value
| Type | Description |
|---|---|
| LineJoins |
OcgId
Identifier of the Optional Content Group (PDF layer) that owns
this path 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
PathObject.GetLayer() convenience helper.
Declaration
int OcgId { get; }
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
float StrokeWidth { get; }
Property Value
| Type | Description |
|---|---|
| System.Single |