Visare

Viewer (namespace Doconut) är den offentliga ingångspunkten för att öppna dokument från Razor‑sidor, MVC‑kontrollers, Blazor‑komponenter eller minimala API:er. Den är sealed, registrerad som en transient‑tjänst av AddDoconut(), och löses upp via konstruktörsinjektion — skapa den aldrig direkt.

Det tidigare .NET Standard‑biblioteket exponerade en offentlig konstruktor som tog minnescachen, HTTP‑kontextåtkomstern och en eller flera licensvägar. Den konstruktorn är borta; tjänstegrafen tillhandahåller dessa beroenden.

Viewer har ingen per‑begäran‑status och implementerar avsiktligt inte IDisposable: dokumentsessioner lever oberoende i sessionscachen, så att avyttra tjänsten skulle aldrig kunna stänga ett öppet dokument (se Kärnkoncepter → Hur Visaren fungerar).

OpenDocumentAsync

Öppnar ett dokument och returnerar sessionstoken som klientwidgeten använder för alla efterföljande begäranden. Varje öppning är asynkron — det finns ingen synkron OpenDocument.

// Simple open
string token = await viewer.OpenDocumentAsync(path);

// With per-format config and options
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// From an upload
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));

Undantag att hantera:

• LicenseException — en hittad licens avvisas (meddelandet innehåller avvisningsorsaken), eller så kräver formatet en plugin‑funktion som inte längre beviljas. Kalenderutgång utan avvisningsmeddelande degraderas till vattenmärkt rendering istället för att kasta ett undantag.
• FormatNotSupportedException — Dokumentformat '<extension>' stöds inte.
• InvalidDataException — filinnehållet är korrupt eller matchar inte dess filändelse.

CloseDocument

void CloseDocument(string token)

Tar bort sessionen från cachen (avyttrar dokumentmotorn omedelbart), raderar säkerhetsmarkören och återkallar åtkomstbehörigheten. Valfritt — glidande utgång utför samma städning — men rekommenderas för stora dokument.

GetPageCount

int GetPageCount(string token)

Totalt antal sidor i den öppna sessionen. Kastar ett undantag om token är okänt eller har gått ut.

Capability flags

Använd dessa i en Razor‑vy för att rendera ett licensierat Ribbon endast när servern faktiskt kommer att leverera det — se Snabbstart.

DocOptions

Per‑öppning, formatoberoende alternativ (namespace Doconut):

Klassen exponerar också specialiserade egenskaper som avsiktligt ligger utanför det normala enkelvärd‑visningsflödet:

Anpassad vattenstämpel

DocOptions.Watermark använder sex tilde‑avgränsade fält. En valfri inledande ^ begär layout i alla hörn:

^Text~Color~FontSize~FontName~Opacity~Angle

string token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig(),
    new DocOptions
    {
        Watermark = "^Confidential~Red~24~Verdana~80~-45",
        TimeOut = 30
    });

Parsern förväntar sig exakt sex fält efter den valfria ^. En ogiltig definition ersätts av SDK:ns synliga Invalid Watermark‑fallback istället för att tyst försvinna.

Licensbeslut

Samma beslut tillämpas på levererade sidbilder och annotationsexporter. Animerad GIF‑utdata stämplas bildruta för bildruta. En anpassad vattenstämpel är därför en licensierad applikationsfunktion, inte ett sätt att ersätta eller undertrycka utvärderingsvattenstämpeln.

Annotations‑API

Serverbaserad laddning och export av annotationer. Den fullständiga genomgången finns i Guider → Annotationer; ytan är:

Var och en av dessa tar sessions‑token. Det tidigare bibliotekets sessionsfria GetAnnotationManager(pageWidth, pageHeight)‑format överlever för att bygga annotationer utanför en session, men laddning av dem kräver fortfarande en token.

DICOM‑metadata

Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)

Metoden finns för API‑justering, men detta paket kan inte tillhandahålla tekniska DICOM‑taggar: metadata‑läsaren levereras endast med en .NET 8‑build. Den returnerar null för DICOM‑ och icke‑DICOM‑sessioner; i en DICOM‑session skriver den också en engångsvarning som förklarar plattformsbegränsningen. Rendering av sidor, ramar och animationer fortsätter att stödjas.

Resurs‑hjälpare — ReferenceCss / ReferenceScripts

Generera <link>/<script>‑taggarna för de inbäddade resurserna som levereras av UseDoconutResources(), i korrekt beroendeordning. Paket för licensstyrda funktioner såsom sökning och annotering genereras endast när licensen aktiverar dem, vilket håller klient‑UI‑en konsekvent med serverbeteendet.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)

CssConfig‑flaggor: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (search‑gated), IncludeAnnotationCss (annotation‑gated).

ScriptConfig‑flaggor: IncludeJQuery (required by all others), IncludeBootstrap, IncludeViewerScripts (core: docViewer.js + splitter + links), IncludeSearchScripts and IncludeSearchBar (search‑gated), IncludeAnnotationScripts and IncludeAnnotationBar (annotation‑gated).

@inject Doconut.Viewer Viewer

@Html.Raw(Viewer.ReferenceCss(new CssConfig { IncludeBootstrapCss = true, IncludeViewerCss = true }))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig { IncludeJQuery = true, IncludeViewerScripts = true }))

Dessa hjälpfunktioner är det stödjade sättet att leverera webbläsarresurserna. Applikationer som kopierade docViewer.js, documentLinks.js och docViewer.UI.js till wwwroot bör ta bort dessa kopior när sidan renderas från de genererade taggarna.