Class PathObjectCollection

Observable collection of path objects

Inheritance
System.Object
PathObjectCollection
Implements
IronSoftware.Abstractions.Pdf.IDocumentPathObjectCollection<PathObject>
System.Collections.Generic.IEnumerable<PathObject>
System.Collections.IEnumerable
System.Collections.Generic.IList<PathObject>
System.Collections.Generic.ICollection<PathObject>
IronSoftware.Abstractions.IJsonSerializable
Namespace: IronSoftware
Assembly: IronPdf.dll
Syntax
public class PathObjectCollection : ObservableCollection<PathObject>, IPdfPathObjectCollection

Use PathObjectCollection in IronPDF when a C# application works with Iron Software API. It represents observable collection of path objects.

PathObjectCollection 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 PathObjectCollection, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include IsReadOnly, Items. Assign options or invoke methods on the instance to configure or perform the operation.

using IronPdf;

// Obtain PathObjectCollection from the relevant entry point in the IronPDF API
void Configure(PathObjectCollection instance)
{
    var current = instance.IsReadOnly;
    instance.Add();
}

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 PathObjectCollection directly. PathObjectCollection instances inherit additional members from ObservableCollection<PathObject> that may be relevant in advanced scenarios. In application code, treat PathObjectCollection 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 PathObjectCollection property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of PathObjectCollection. Application code typically obtains or instantiates a single PathObjectCollection 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; PathObjectCollection instances are not assumed to be thread-safe unless documented.

Properties

IsReadOnly

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

Items

Declaration
public IList<PathObject> Items { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<PathObject>

Methods

Add(PathObject)

Declaration
public void Add(PathObject item)
Parameters
Type Name Description
PathObject item

Clear()

Declaration
public void Clear()

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Remove(PathObject)

Declaration
public bool Remove(PathObject item)
Parameters
Type Name Description
PathObject item
Returns
Type Description
System.Boolean

RemoveAt(Int32)

Declaration
public void RemoveAt(int index)
Parameters
Type Name Description
System.Int32 index

ToJson()

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

Implements

IronSoftware.Abstractions.Pdf.IDocumentPathObjectCollection<>
System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable
System.Collections.Generic.IList<>
System.Collections.Generic.ICollection<>
IronSoftware.Abstractions.IJsonSerializable