PdfReference Class

Namespace: Meziantou.Framework.Pdf.Objects
Assembly: Meziantou.Framework.Pdf.dll
Package: Meziantou.Framework.Pdf 1.0.7
Source: PdfReference.cs
Available in package assets: net10.0net11.0

A reference to an indirect object of a document (ISO 32000-2, 7.3.10), such as 12 0 R.

public sealed class PdfReference : PdfObject, IEquatable<PdfReference>

Remarks

References are created by PdfIndirectObjectCollection: a reference belongs to the indirect objects of one document.

Inheritance

PdfObject PdfReference

Implements

IEquatable<PdfReference>

Properties

Name	Description
Generation	Gets the generation number.
Kind	Gets the kind of the object.
ObjectNumber	Gets the object number.

Generation

PdfReference.cs

Gets the generation number.

public int Generation { get; }

Property value

int

Kind

PdfReference.cs

Gets the kind of the object.

public override PdfObjectKind Kind { get; }

Property value

PdfObjectKind

ObjectNumber

PdfReference.cs

Gets the object number.

public int ObjectNumber { get; }

Property value

int

Methods

Name	Description
Equals(PdfReference?)	Indicates whether the current object is equal to another object of the same type.
Equals(object?)	Determines whether the specified object is equal to the current object.
GetHashCode()	Serves as the default hash function.
Resolve()	Gets the object the reference points to, loading it from the file when needed.

Equals overloads

Equals(PdfReference?)

PdfReference.cs

Indicates whether the current object is equal to another object of the same type.

public bool Equals(PdfReference? other)

Parameters

other PdfReference?: An object to compare with this object.

Returns

bool true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

PdfReference.cs

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object?: The object to compare with the current object.

Returns

bool true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

PdfReference.cs

Serves as the default hash function.

public override int GetHashCode()

Returns

int A hash code for the current object.

Resolve()

PdfReference.cs

Gets the object the reference points to, loading it from the file when needed.

public PdfObject Resolve()

Returns

PdfObject The object, or PdfNull.Instance when it does not exist (ISO 32000-2, 7.3.10).