BibliographyDocument
OfficeIMO.Bibliography
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
- Property BibliographyReferenceResult.Document
Accepted by parameters 1
- Constructor CslProcessor.CslProcessor
Constructors
public BibliographyDocument(BibliographyFormat format) #Creates an empty bibliography for a destination format.
Parameters
- format OfficeIMO.Bibliography.BibliographyFormat
Methods
public byte[]? GetOriginalBytes() #Returns a copy of the original loaded bytes, or null when the document was parsed from text or created in memory.
Returns
byte[]?public static BibliographyReadResult Load(string path, BibliographyFormat? format = null, BibliographyReadOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Loads bibliography data from a path, detecting format by extension and content when needed.
Parameters
- path string
- format OfficeIMO.Bibliography.BibliographyFormat? = null
- options OfficeIMO.Bibliography.BibliographyReadOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
BibliographyReadResultpublic static BibliographyReadResult Load(Stream stream, BibliographyFormat format, BibliographyReadOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Loads bibliography data from a stream.
Parameters
- stream System.IO.Stream
- format OfficeIMO.Bibliography.BibliographyFormat
- options OfficeIMO.Bibliography.BibliographyReadOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
BibliographyReadResultpublic static async Task<BibliographyReadResult> LoadAsync(string path, BibliographyFormat? format = null, BibliographyReadOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Loads bibliography data from a path asynchronously.
Parameters
- path string
- format OfficeIMO.Bibliography.BibliographyFormat? = null
- options OfficeIMO.Bibliography.BibliographyReadOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<BibliographyReadResult>public static async Task<BibliographyReadResult> LoadAsync(Stream stream, BibliographyFormat format, BibliographyReadOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Loads bibliography data from a stream asynchronously.
Parameters
- stream System.IO.Stream
- format OfficeIMO.Bibliography.BibliographyFormat
- options OfficeIMO.Bibliography.BibliographyReadOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<BibliographyReadResult>public static BibliographyReadResult Parse(string source, BibliographyFormat format, BibliographyReadOptions? options = null, CancellationToken cancellationToken = default) #Parses bibliography text using an explicit format.
Parameters
- source string
- format OfficeIMO.Bibliography.BibliographyFormat
- options OfficeIMO.Bibliography.BibliographyReadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
BibliographyReadResultpublic static BibliographyReadResult Parse(string source, BibliographyReadOptions? options = null, CancellationToken cancellationToken = default) #Parses bibliography text after bounded content detection.
Parameters
- source string
- options OfficeIMO.Bibliography.BibliographyReadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
BibliographyReadResultpublic BibliographyReferenceResult ResolveReferences(BibliographyReferenceOptions? options = null, CancellationToken cancellationToken = default) #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
- cancellationToken System.Threading.CancellationToken = default
Returns
BibliographyReferenceResultpublic BibliographyWriteResult Save(string path, BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default) #Atomically saves or converts to a path, preserving an existing file when writing fails or is cancelled before commit.
Parameters
- path string
- options OfficeIMO.Bibliography.BibliographyWriteOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
BibliographyWriteResultpublic BibliographyWriteResult Save(Stream stream, BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default) #Saves or converts to a stream without closing it.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Bibliography.BibliographyWriteOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
BibliographyWriteResultpublic async Task<BibliographyWriteResult> SaveAsync(string path, BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default) #Atomically saves or converts to a path asynchronously, preserving an existing file when writing fails or is cancelled before commit.
Parameters
- path string
- options OfficeIMO.Bibliography.BibliographyWriteOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<BibliographyWriteResult>public async Task<BibliographyWriteResult> SaveAsync(Stream stream, BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default) #Saves or converts to a stream asynchronously without closing it.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Bibliography.BibliographyWriteOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<BibliographyWriteResult>public byte[] ToBytes(BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default) #Writes or converts the document to bytes.
Parameters
- options OfficeIMO.Bibliography.BibliographyWriteOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
byte[]public override string ToString() #Writes text in preserve mode using the source format.
Returns
stringpublic BibliographyWriteResult Write(BibliographyWriteOptions? options = null, CancellationToken cancellationToken = default) #Writes or converts the document.
Parameters
- options OfficeIMO.Bibliography.BibliographyWriteOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
BibliographyWriteResultInherited Methods
Properties
public BibliographyFormat SourceFormat { get; } #Source format, or intended format for a new document.
public IList<BibliographyItem> Items { get; private set; } #Editable citation records in source order.
public IReadOnlyList<BibliographyDiagnostic> Diagnostics { get; private set; } #Parser and recovery diagnostics.
public IList<BibliographyNativeEntry> NativeEntries { get; private set; } #Document-level native directives retained in source order.
public bool IsModified { get; } #True when the semantic model differs from the parsed baseline.
public bool HasOriginalSource { get; } #True when exact original text is available.
public string? OriginalSourceText { get; } #Original decoded source text, when the document was parsed or loaded.