API Reference
Class
CslProcessor
A managed CSL processor over an immutable citation-data snapshot. Rendering has no filesystem, network, or executable dependency.
Inheritance
- Object
- CslProcessor
Constructors
public CslProcessor(BibliographyDocument document, CslStyle style, CslRenderOptions options = null, CancellationToken cancellationToken = default) #Creates a processor by copying the bibliography data and rendering options. Keys must be nonempty and unique.
Parameters
- document OfficeIMO.Bibliography.BibliographyDocument
- style OfficeIMO.Bibliography.CslStyle
- options OfficeIMO.Bibliography.CslRenderOptions = null
- cancellationToken System.Threading.CancellationToken = default
Methods
public CslRenderResult Render(IEnumerable<CslCitation> citations, Boolean includeUncitedItems = false, CancellationToken cancellationToken = default) #Returns:
CslRenderResultRenders a complete document citation sequence, recalculating numbers, positions, disambiguation, and bibliography order.
Parameters
- citations System.Collections.Generic.IEnumerable{OfficeIMO.Bibliography.CslCitation}
- includeUncitedItems System.Boolean = false
- cancellationToken System.Threading.CancellationToken = default
public IReadOnlyList<CslRenderedEntry> RenderBibliography(CancellationToken cancellationToken = default) #Returns:
IReadOnlyList<CslRenderedEntry>Renders all records as a bibliography without requiring document citations.
Parameters
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public BibliographyConversionReport DataConversionReport { get; } #Fidelity evidence for projecting the source bibliography into the processor's CSL data snapshot.