Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

CslProcessor

OfficeIMO.Bibliography

Namespace
OfficeIMO.Bibliography
Assembly
OfficeIMO.Bibliography
Source revision
5e5a2dda74b3 with working tree changes
Modifiers
sealed

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 required
style OfficeIMO.Bibliography.CslStyle required
options OfficeIMO.Bibliography.CslRenderOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Methods

public CslRenderResult Render(IEnumerable<CslCitation> citations, bool includeUncitedItems = false, CancellationToken cancellationToken = default) #

Renders a complete document citation sequence, recalculating numbers, positions, disambiguation, and bibliography order.

Parameters

citations System.Collections.Generic.IEnumerable<OfficeIMO.Bibliography.CslCitation> required
includeUncitedItems bool = false optional
cancellationToken System.Threading.CancellationToken = default optional
public IReadOnlyList<CslRenderedEntry> RenderBibliography(CancellationToken cancellationToken = default) #

Renders all records as a bibliography without requiring document citations.

Parameters

cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<CslRenderedEntry>

Properties

public BibliographyConversionReport DataConversionReport { get; } #

Fidelity evidence for projecting the source bibliography into the processor's CSL data snapshot.