API Reference
Class
BibliographyDocument
An editable, format-neutral, source-backed bibliography.
Inheritance
- Object
- BibliographyDocument
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property BibliographyReadResult.Document
Constructors
public BibliographyDocument(BibliographyFormat format) #Creates an empty bibliography for a destination format.
Parameters
- format OfficeIMO.Bibliography.BibliographyFormat
Methods
public Byte[] GetOriginalBytes() #Returns:
Byte[]Returns a copy of the original loaded bytes, or null when the document was parsed from text or created in memory.
Load 2 overloads
public static BibliographyReadResult Load(String path, Nullable<BibliographyFormat> format = null, BibliographyReadOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
BibliographyReadResultLoads bibliography data from a path, detecting format by extension and content when needed.
Parameters
- path System.String
- format System.Nullable{OfficeIMO.Bibliography.BibliographyFormat} = null
- options OfficeIMO.Bibliography.BibliographyReadOptions = null
- encoding System.Text.Encoding = null
- cancellationToken System.Threading.CancellationToken = default
public static BibliographyReadResult Load(Stream stream, BibliographyFormat format, BibliographyReadOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
BibliographyReadResultLoads 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
LoadAsync 2 overloads
public static async Task<BibliographyReadResult> LoadAsync(String path, Nullable<BibliographyFormat> format = null, BibliographyReadOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
Task<BibliographyReadResult>Loads bibliography data from a path asynchronously.
Parameters
- path System.String
- format System.Nullable{OfficeIMO.Bibliography.BibliographyFormat} = null
- options OfficeIMO.Bibliography.BibliographyReadOptions = null
- encoding System.Text.Encoding = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<BibliographyReadResult> LoadAsync(Stream stream, BibliographyFormat format, BibliographyReadOptions options = null, Encoding encoding = null, CancellationToken cancellationToken = default) #Returns:
Task<BibliographyReadResult>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
Parse 2 overloads
public static BibliographyReadResult Parse(String source, BibliographyFormat format, BibliographyReadOptions options = null, CancellationToken cancellationToken = default) #Returns:
BibliographyReadResultParses bibliography text using an explicit format.
Parameters
- source System.String
- format OfficeIMO.Bibliography.BibliographyFormat
- options OfficeIMO.Bibliography.BibliographyReadOptions = null
- cancellationToken System.Threading.CancellationToken = default
public static BibliographyReadResult Parse(String source, BibliographyReadOptions options = null, CancellationToken cancellationToken = default) #Returns:
BibliographyReadResultParses bibliography text after bounded content detection.
Parameters
- source System.String
- options OfficeIMO.Bibliography.BibliographyReadOptions = null
- cancellationToken System.Threading.CancellationToken = default
Save 2 overloads
public BibliographyWriteResult Save(String path, BibliographyWriteOptions options = null, CancellationToken cancellationToken = default) #Returns:
BibliographyWriteResultSaves or converts to a path.
Parameters
- path System.String
- options OfficeIMO.Bibliography.BibliographyWriteOptions = null
- cancellationToken System.Threading.CancellationToken = default
public BibliographyWriteResult Save(Stream stream, BibliographyWriteOptions options = null, CancellationToken cancellationToken = default) #Returns:
BibliographyWriteResultSaves or converts to a stream without closing it.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Bibliography.BibliographyWriteOptions = null
- cancellationToken System.Threading.CancellationToken = default
SaveAsync 2 overloads
public async Task<BibliographyWriteResult> SaveAsync(String path, BibliographyWriteOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<BibliographyWriteResult>Saves or converts to a path asynchronously.
Parameters
- path System.String
- options OfficeIMO.Bibliography.BibliographyWriteOptions = null
- cancellationToken System.Threading.CancellationToken = default
public async Task<BibliographyWriteResult> SaveAsync(Stream stream, BibliographyWriteOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<BibliographyWriteResult>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
public Byte[] ToBytes(BibliographyWriteOptions options = null, CancellationToken cancellationToken = default) #Returns:
Byte[]Writes or converts the document to bytes.
Parameters
- options OfficeIMO.Bibliography.BibliographyWriteOptions = null
- cancellationToken System.Threading.CancellationToken = default
public MemoryStream ToStream(BibliographyWriteOptions options = null, CancellationToken cancellationToken = default) #Returns:
MemoryStreamWrites or converts the document to a new memory stream positioned at the beginning.
Parameters
- options OfficeIMO.Bibliography.BibliographyWriteOptions = null
- cancellationToken System.Threading.CancellationToken = default
public override String ToString() #Returns:
StringWrites text in preserve mode using the source format.
public BibliographyWriteResult Write(BibliographyWriteOptions options = null, CancellationToken cancellationToken = default) #Returns:
BibliographyWriteResultWrites or converts the document.
Parameters
- options OfficeIMO.Bibliography.BibliographyWriteOptions = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
Properties
public BibliographyFormat SourceFormat { get; } #Source format, or intended format for a new document.
public IList<BibliographyItem> Items { get; set; } #Editable citation records in source order.
public IReadOnlyList<BibliographyDiagnostic> Diagnostics { get; set; } #Parser and recovery diagnostics.
public IList<BibliographyNativeEntry> NativeEntries { get; set; } #Document-level native directives retained in source order.
public Boolean IsModified { get; } #True when the semantic model differs from the parsed baseline.
public Boolean HasOriginalSource { get; } #True when exact original text is available.
public String OriginalSourceText { get; } #Original decoded source text, when the document was parsed or loaded.