Class RefItem

Namespace

Mythosia.Documents.Elements

Assembly

Mythosia.Documents.Abstractions.dll

A JSON-pointer style reference to another item in the document. Follows the docling RefItem convention (e.g. "#/texts/0", "#/tables/1").

public class RefItem : IEquatable<RefItem>

Inheritance

object

RefItem

Implements

IEquatable<RefItem>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

RefItem()

public RefItem()

RefItem(string)

public RefItem(string @ref)

Parameters

ref string

Properties

Ref

The JSON pointer reference string (e.g. "#/texts/0").

public string Ref { get; set; }

Property Value

string

Methods

Equals(RefItem?)

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

public bool Equals(RefItem? other)

Parameters

other RefItem

An object to compare with this object.

Returns

bool

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

Equals(object?)

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()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

Resolve(DoclingDocument)

Resolves this reference against the given document, returning the referenced NodeItem.

public NodeItem? Resolve(DoclingDocument doc)

Parameters

doc DoclingDocument

Returns

NodeItem

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.