# CslProcessor

A managed CSL processor over an immutable citation-data snapshot. Rendering has no filesystem, network, or executable dependency.

Class 

`OfficeIMO.Bibliography`

**Namespace**

`OfficeIMO.Bibliography`

**Assembly**

`OfficeIMO.Bibliography`

**Source revision**

`5e5a2dda74b3` with working tree changes

**Source**

[CslProcessor.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/5e5a2dda74b33242f1f075718ee568bb355c03ba/OfficeIMO.Bibliography/Citations/CslProcessor.cs#L17)

**Modifiers**

sealed

A managed CSL processor over an immutable citation-data snapshot. Rendering has no filesystem, network, or executable dependency.

## Inheritance

- object
- CslProcessor

Filter members 

Show inherited

## Constructors

`public CslProcessor(BibliographyDocument document, CslStyle style, CslRenderOptions? options = null, CancellationToken cancellationToken = default)` [#](#constructor-ctor-officeimo-bibliography-bibliographydocument-officeimo-bibliography-cslstyle-officeimo-bibliography-cslrenderoptions-threading-cancellationtoken)

[CslProcessor.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/5e5a2dda74b33242f1f075718ee568bb355c03ba/OfficeIMO.Bibliography/Citations/CslProcessor.cs#L17)

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)` [#](#method-render-collections-generic-ienumerable-officeimo-bibliography-cslcitation-boolean-threading-cancellationtoken)

[CslProcessor.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/5e5a2dda74b33242f1f075718ee568bb355c03ba/OfficeIMO.Bibliography/Citations/CslProcessor.cs#L38)

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**

Returns

`CslRenderResult`

`public IReadOnlyList<CslRenderedEntry> RenderBibliography(CancellationToken cancellationToken = default)` [#](#method-renderbibliography-threading-cancellationtoken)

[CslProcessor.cs:113](https://github.com/EvotecIT/OfficeIMO/blob/5e5a2dda74b33242f1f075718ee568bb355c03ba/OfficeIMO.Bibliography/Citations/CslProcessor.cs#L113)

Renders all records as a bibliography without requiring document citations.

Parameters

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

Returns

`IReadOnlyList<CslRenderedEntry>`

## 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`

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

Inherited from object

Returns

`string?`

## Properties

`public BibliographyConversionReport DataConversionReport { get; }` [#](#property-dataconversionreport)

[CslProcessor.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/5e5a2dda74b33242f1f075718ee568bb355c03ba/OfficeIMO.Bibliography/Citations/CslProcessor.cs#L14)

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

<!-- PowerForge markdown artifact sha256:28EA8113FF7E30FD1AD83F8296D15D9909EF1D637C5979DF060EA451FC6FA4FF -->
