# BibliographyDocument

An editable, format-neutral, source-backed bibliography.

Class 

`OfficeIMO.Bibliography`

**Namespace**

`OfficeIMO.Bibliography`

**Assembly**

`OfficeIMO.Bibliography`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[BibliographyDocument.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L36)

**Modifiers**

sealed

An editable, format-neutral, source-backed bibliography.

## Inheritance

- object
- BibliographyDocument

## Usage

Explore 3 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 2

- Property [BibliographyReadResult.Document](/api/bibliography/officeimo-bibliography-bibliographyreadresult/#property-document)
- Property [BibliographyReferenceResult.Document](/api/bibliography/officeimo-bibliography-bibliographyreferenceresult/#property-document)

### Accepted by parameters 1

- Constructor [CslProcessor.CslProcessor](/api/bibliography/officeimo-bibliography-cslprocessor/#constructor-ctor-officeimo-bibliography-bibliographydocument-officeimo-bibliography-cslstyle-officeimo-bibliography-cslrenderoptions-threading-cancellationtoken) parameter `document`

Filter members 

Show inherited

## Constructors

`public BibliographyDocument(BibliographyFormat format)` [#](#constructor-ctor-officeimo-bibliography-bibliographyformat)

[BibliographyDocument.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L36)

Creates an empty bibliography for a destination format.

Parameters

**format OfficeIMO.Bibliography.BibliographyFormat required**

## Methods

`public byte[]? GetOriginalBytes()` [#](#method-getoriginalbytes)

[BibliographyDocument.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L50)

Returns a copy of the original loaded bytes, or null when the document was parsed from text or created in memory.

Returns

`byte[]?`

Load 2 overloads

`public static BibliographyReadResult Load(string path, BibliographyFormat? format = null, BibliographyReadOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default)` [#](#method-load-string-nullable-officeimo-bibliography-bibliographyformat-officeimo-bibliography-bibliographyreadoptions-text-encoding-threading-cancellationtoken)

[BibliographyDocument.IO.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/IO/BibliographyDocument.IO.cs#L9)

Loads bibliography data from a path, detecting format by extension and content when needed.

Parameters

**path string required**

**format OfficeIMO.Bibliography.BibliographyFormat? = null optional**

**options OfficeIMO.Bibliography.BibliographyReadOptions? = null optional**

**encoding System.Text.Encoding? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`BibliographyReadResult`

`public static BibliographyReadResult Load(Stream stream, BibliographyFormat format, BibliographyReadOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default)` [#](#method-load-io-stream-officeimo-bibliography-bibliographyformat-officeimo-bibliography-bibliographyreadoptions-text-encoding-threading-cancellationtoken)

[BibliographyDocument.IO.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/IO/BibliographyDocument.IO.cs#L18)

Loads bibliography data from a stream.

Parameters

**stream System.IO.Stream required**

**format OfficeIMO.Bibliography.BibliographyFormat required**

**options OfficeIMO.Bibliography.BibliographyReadOptions? = null optional**

**encoding System.Text.Encoding? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`BibliographyReadResult`

LoadAsync 2 overloads

`public static async Task<BibliographyReadResult> LoadAsync(string path, BibliographyFormat? format = null, BibliographyReadOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default)` [#](#method-loadasync-string-nullable-officeimo-bibliography-bibliographyformat-officeimo-bibliography-bibliographyreadoptions-text-encoding-threading-cancellationtoken)

Loads bibliography data from a path asynchronously.

Parameters

**path string required**

**format OfficeIMO.Bibliography.BibliographyFormat? = null optional**

**options OfficeIMO.Bibliography.BibliographyReadOptions? = null optional**

**encoding System.Text.Encoding? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<BibliographyReadResult>`

`public static async Task<BibliographyReadResult> LoadAsync(Stream stream, BibliographyFormat format, BibliographyReadOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default)` [#](#method-loadasync-io-stream-officeimo-bibliography-bibliographyformat-officeimo-bibliography-bibliographyreadoptions-text-encoding-threading-cancellationtoken)

Loads bibliography data from a stream asynchronously.

Parameters

**stream System.IO.Stream required**

**format OfficeIMO.Bibliography.BibliographyFormat required**

**options OfficeIMO.Bibliography.BibliographyReadOptions? = null optional**

**encoding System.Text.Encoding? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<BibliographyReadResult>`

Parse 2 overloads

`public static BibliographyReadResult Parse(string source, BibliographyFormat format, BibliographyReadOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-parse-string-officeimo-bibliography-bibliographyformat-officeimo-bibliography-bibliographyreadoptions-threading-cancellationtoken)

[BibliographyDocument.cs:62](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L62)

Parses bibliography text using an explicit format.

Parameters

**source string required**

**format OfficeIMO.Bibliography.BibliographyFormat required**

**options OfficeIMO.Bibliography.BibliographyReadOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`BibliographyReadResult`

`public static BibliographyReadResult Parse(string source, BibliographyReadOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-parse-string-officeimo-bibliography-bibliographyreadoptions-threading-cancellationtoken)

[BibliographyDocument.cs:66](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L66)

Parses bibliography text after bounded content detection.

Parameters

**source string required**

**options OfficeIMO.Bibliography.BibliographyReadOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`BibliographyReadResult`

`public BibliographyReferenceResult ResolveReferences(BibliographyReferenceOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-resolvereferences-officeimo-bibliography-bibliographyreferenceoptions-threading-cancellationtoken)

[BibliographyDocument.References.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/References/BibliographyDocument.References.cs#L9)

Resolves local BibTeX/BibLaTeX crossref and whole-entry xdata references into an independent editable snapshot. Never changes this document, reads files, or fetches metadata. Ambiguous or missing keys are diagnosed rather than guessed.

Parameters

**options OfficeIMO.Bibliography.BibliographyReferenceOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`BibliographyReferenceResult`

Save 2 overloads

`public BibliographyWriteResult Save(string path, BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-save-string-officeimo-bibliography-bibliographywriteoptions-threading-cancellationtoken)

[BibliographyDocument.IO.cs:49](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/IO/BibliographyDocument.IO.cs#L49)

Atomically saves or converts to a path, preserving an existing file when writing fails or is cancelled before commit.

Parameters

**path string required**

**options OfficeIMO.Bibliography.BibliographyWriteOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`BibliographyWriteResult`

`public BibliographyWriteResult Save(Stream stream, BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-save-io-stream-officeimo-bibliography-bibliographywriteoptions-threading-cancellationtoken)

[BibliographyDocument.IO.cs:58](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/IO/BibliographyDocument.IO.cs#L58)

Saves or converts to a stream without closing it.

Parameters

**stream System.IO.Stream required**

**options OfficeIMO.Bibliography.BibliographyWriteOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`BibliographyWriteResult`

SaveAsync 2 overloads

`public async Task<BibliographyWriteResult> SaveAsync(string path, BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasync-string-officeimo-bibliography-bibliographywriteoptions-threading-cancellationtoken)

Atomically saves or converts to a path asynchronously, preserving an existing file when writing fails or is cancelled before commit.

Parameters

**path string required**

**options OfficeIMO.Bibliography.BibliographyWriteOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<BibliographyWriteResult>`

`public async Task<BibliographyWriteResult> SaveAsync(Stream stream, BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasync-io-stream-officeimo-bibliography-bibliographywriteoptions-threading-cancellationtoken)

Saves or converts to a stream asynchronously without closing it.

Parameters

**stream System.IO.Stream required**

**options OfficeIMO.Bibliography.BibliographyWriteOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<BibliographyWriteResult>`

`public byte[] ToBytes(BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tobytes-officeimo-bibliography-bibliographywriteoptions-threading-cancellationtoken)

[BibliographyDocument.cs:75](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L75)

Writes or converts the document to bytes.

Parameters

**options OfficeIMO.Bibliography.BibliographyWriteOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`byte[]`

`public override string ToString()` [#](#method-tostring)

[BibliographyDocument.cs:78](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L78)

Writes text in preserve mode using the source format.

Returns

`string`

`public BibliographyWriteResult Write(BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-write-officeimo-bibliography-bibliographywriteoptions-threading-cancellationtoken)

[BibliographyDocument.cs:72](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L72)

Writes or converts the document.

Parameters

**options OfficeIMO.Bibliography.BibliographyWriteOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`BibliographyWriteResult`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

## Properties

`public BibliographyFormat SourceFormat { get; }` [#](#property-sourceformat)

[BibliographyDocument.cs:34](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L34)

Source format, or intended format for a new document.

`public IList<BibliographyItem> Items { get; private set; }` [#](#property-items)

[BibliographyDocument.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L36)

Editable citation records in source order.

`public IReadOnlyList<BibliographyDiagnostic> Diagnostics { get; private set; }` [#](#property-diagnostics)

[BibliographyDocument.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L38)

Parser and recovery diagnostics.

`public IList<BibliographyNativeEntry> NativeEntries { get; private set; }` [#](#property-nativeentries)

[BibliographyDocument.cs:40](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L40)

Document-level native directives retained in source order.

`public bool IsModified { get; }` [#](#property-ismodified)

[BibliographyDocument.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L42)

True when the semantic model differs from the parsed baseline.

`public bool HasOriginalSource { get; }` [#](#property-hasoriginalsource)

[BibliographyDocument.cs:44](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L44)

True when exact original text is available.

`public string? OriginalSourceText { get; }` [#](#property-originalsourcetext)

[BibliographyDocument.cs:47](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Bibliography/Model/BibliographyDocument.cs#L47)

Original decoded source text, when the document was parsed or loaded.

<!-- PowerForge markdown artifact sha256:8DF1F4F820840438F83FDE7AC5D25E316EEFFB70CA2B2924603EAECDF6CAE7F3 -->
